1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="servicenetworking_v1.html">Service Networking API</a> . <a href="servicenetworking_v1.services.html">services</a> . <a href="servicenetworking_v1.services.projects.html">projects</a> . <a href="servicenetworking_v1.services.projects.global_.html">global_</a> . <a href="servicenetworking_v1.services.projects.global_.networks.html">networks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="servicenetworking_v1.services.projects.global_.networks.dnsZones.html">dnsZones()</a></code>
</p>
<p class="firstline">Returns the dnsZones Resource.</p>
<p class="toc_element">
<code><a href="servicenetworking_v1.services.projects.global_.networks.peeredDnsDomains.html">peeredDnsDomains()</a></code>
</p>
<p class="firstline">Returns the peeredDnsDomains Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, includeUsedIpRanges=None, x__xgafv=None)</a></code></p>
<p class="firstline">Service producers use this method to get the configuration of their connection including the import/export of custom routes and subnetwork routes with public IP.</p>
<p class="toc_element">
<code><a href="#getVpcServiceControls">getVpcServiceControls(name, x__xgafv=None)</a></code></p>
<p class="firstline">Consumers use this method to find out the state of VPC Service Controls. The controls could be enabled or disabled for a connection.</p>
<p class="toc_element">
<code><a href="#updateConsumerConfig">updateConsumerConfig(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Service producers use this method to update the configuration of their connection including the import/export of custom routes and subnetwork routes with public IP.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, includeUsedIpRanges=None, x__xgafv=None)</code>
<pre>Service producers use this method to get the configuration of their connection including the import/export of custom routes and subnetwork routes with public IP.
Args:
name: string, Required. Name of the consumer config to retrieve in the format: `services/{service}/projects/{project}/global/networks/{network}`. {service} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is `servicenetworking.googleapis.com`. {project} is a project number e.g. `12345` that contains the service consumer's VPC network. {network} is the name of the service consumer's VPC network. (required)
includeUsedIpRanges: boolean, Optional. When true, include the used IP ranges as part of the GetConsumerConfig output. This includes routes created inside the service networking network, consumer network, peers of the consumer network, and reserved ranges inside the service networking network. By default, this is false
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Configuration information for a private service access connection.
"cloudsqlConfigs": [ # Represents one or multiple Cloud SQL configurations.
{ # Cloud SQL configuration.
"service": "A String", # Required. Peering service used for peering with the Cloud SQL project.
"umbrellaNetwork": "A String", # Required. The name of the umbrella network in the Cloud SQL umbrella project.
"umbrellaProject": "A String", # Required. The project number of the Cloud SQL umbrella project.
},
],
"consumerExportCustomRoutes": True or False, # Export custom routes flag value for peering from consumer to producer.
"consumerExportSubnetRoutesWithPublicIp": True or False, # Export subnet routes with public ip flag value for peering from consumer to producer.
"consumerImportCustomRoutes": True or False, # Import custom routes flag value for peering from consumer to producer.
"consumerImportSubnetRoutesWithPublicIp": True or False, # Import subnet routes with public ip flag value for peering from consumer to producer.
"producerExportCustomRoutes": True or False, # Export custom routes flag value for peering from producer to consumer.
"producerExportSubnetRoutesWithPublicIp": True or False, # Export subnet routes with public ip flag value for peering from producer to consumer.
"producerImportCustomRoutes": True or False, # Import custom routes flag value for peering from producer to consumer.
"producerImportSubnetRoutesWithPublicIp": True or False, # Import subnet routes with public ip flag value for peering from producer to consumer.
"producerNetwork": "A String", # Output only. The VPC host network that is used to host managed service instances. In the format, projects/{project}/global/networks/{network} where {project} is the project number e.g. '12345' and {network} is the network name.
"reservedRanges": [ # Output only. The reserved ranges associated with this private service access connection.
{ # Allocated IP address ranges for this private service access connection.
"address": "A String", # The starting address of the reserved range. The address must be a valid IPv4 address in the x.x.x.x format. This value combined with the IP prefix length is the CIDR range for the reserved range.
"ipPrefixLength": 42, # The prefix length of the reserved range.
"name": "A String", # The name of the reserved range.
},
],
"usedIpRanges": [ # Output only. The IP ranges already in use by consumer or producer
"A String",
],
"vpcScReferenceArchitectureEnabled": True or False, # Output only. Indicates whether the VPC Service Controls reference architecture is configured for the producer VPC host network.
}</pre>
</div>
<div class="method">
<code class="details" id="getVpcServiceControls">getVpcServiceControls(name, x__xgafv=None)</code>
<pre>Consumers use this method to find out the state of VPC Service Controls. The controls could be enabled or disabled for a connection.
Args:
name: string, Required. Name of the VPC Service Controls config to retrieve in the format: `services/{service}/projects/{project}/global/networks/{network}`. {service} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is `servicenetworking.googleapis.com`. {project} is a project number e.g. `12345` that contains the service consumer's VPC network. {network} is the name of the service consumer's VPC network. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for the get VPC Service Controls request.
"enabled": True or False, # Output only. Indicates whether the VPC Service Controls are enabled or disabled for the connection. If the consumer called the EnableVpcServiceControls method, then this is true. If the consumer called DisableVpcServiceControls, then this is false. The default is false.
}</pre>
</div>
<div class="method">
<code class="details" id="updateConsumerConfig">updateConsumerConfig(parent, body=None, x__xgafv=None)</code>
<pre>Service producers use this method to update the configuration of their connection including the import/export of custom routes and subnetwork routes with public IP.
Args:
parent: string, Required. Parent resource identifying the connection for which the consumer config is being updated in the format: `services/{service}/projects/{project}/global/networks/{network}` {service} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is `servicenetworking.googleapis.com`. {project} is the number of the project that contains the service consumer's VPC network e.g. `12345`. {network} is the name of the service consumer's VPC network. (required)
body: object, The request body.
The object takes the form of:
{ # Request to update the configuration of a service networking connection including the import/export of custom routes and subnetwork routes with public IP.
"consumerConfig": { # Configuration information for a private service access connection. # Required. The updated peering config.
"cloudsqlConfigs": [ # Represents one or multiple Cloud SQL configurations.
{ # Cloud SQL configuration.
"service": "A String", # Required. Peering service used for peering with the Cloud SQL project.
"umbrellaNetwork": "A String", # Required. The name of the umbrella network in the Cloud SQL umbrella project.
"umbrellaProject": "A String", # Required. The project number of the Cloud SQL umbrella project.
},
],
"consumerExportCustomRoutes": True or False, # Export custom routes flag value for peering from consumer to producer.
"consumerExportSubnetRoutesWithPublicIp": True or False, # Export subnet routes with public ip flag value for peering from consumer to producer.
"consumerImportCustomRoutes": True or False, # Import custom routes flag value for peering from consumer to producer.
"consumerImportSubnetRoutesWithPublicIp": True or False, # Import subnet routes with public ip flag value for peering from consumer to producer.
"producerExportCustomRoutes": True or False, # Export custom routes flag value for peering from producer to consumer.
"producerExportSubnetRoutesWithPublicIp": True or False, # Export subnet routes with public ip flag value for peering from producer to consumer.
"producerImportCustomRoutes": True or False, # Import custom routes flag value for peering from producer to consumer.
"producerImportSubnetRoutesWithPublicIp": True or False, # Import subnet routes with public ip flag value for peering from producer to consumer.
"producerNetwork": "A String", # Output only. The VPC host network that is used to host managed service instances. In the format, projects/{project}/global/networks/{network} where {project} is the project number e.g. '12345' and {network} is the network name.
"reservedRanges": [ # Output only. The reserved ranges associated with this private service access connection.
{ # Allocated IP address ranges for this private service access connection.
"address": "A String", # The starting address of the reserved range. The address must be a valid IPv4 address in the x.x.x.x format. This value combined with the IP prefix length is the CIDR range for the reserved range.
"ipPrefixLength": 42, # The prefix length of the reserved range.
"name": "A String", # The name of the reserved range.
},
],
"usedIpRanges": [ # Output only. The IP ranges already in use by consumer or producer
"A String",
],
"vpcScReferenceArchitectureEnabled": True or False, # Output only. Indicates whether the VPC Service Controls reference architecture is configured for the producer VPC host network.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>
|
