Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / cdf480e8145d58600a5224efc68ba2ace973ef62 / . / docs / dyn / servicenetworking_v1.services.connections.html
blob: ccd9fbf0d9ed76f60252bb759688dd9de8d641fc [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="servicenetworking_v1.html">Service Networking API</a> . <a href="servicenetworking_v1.services.html">services</a> . <a href="servicenetworking_v1.services.connections.html">connections</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Creates a private connection that establishes a VPC Network Peering connection to a VPC network in the service producer's organization. The administrator of the service consumer's VPC network invokes this method. The administrator must assign one or more allocated IP ranges for provisioning subnetworks in the service producer's VPC network. This connection is used for all supported services in the service producer's organization, so it only needs to be invoked once.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]84 <code><a href="#deleteConnection">deleteConnection(name, body=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes a private service access connection.</p>
86<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]87 <code><a href="#list">list(parent, network=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<p class="firstline">List the private connections that are configured in a service consumer's VPC network.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]90 <code><a href="#patch">patch(name, body=None, force=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91<p class="firstline">Updates the allocated ranges that are assigned to a connection.</p>
92<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100 <pre>Creates a private connection that establishes a VPC Network Peering connection to a VPC network in the service producer&#x27;s organization. The administrator of the service consumer&#x27;s VPC network invokes this method. The administrator must assign one or more allocated IP ranges for provisioning subnetworks in the service producer&#x27;s VPC network. This connection is used for all supported services in the service producer&#x27;s organization, so it only needs to be invoked once.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101
102Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 parent: string, The service that is managing peering connectivity for a service producer&#x27;s organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]104 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105 The object takes the form of:
106
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]107{ # Represents a private connection resource. A private connection is implemented as a VPC Network Peering connection between a service producer&#x27;s VPC network and a service consumer&#x27;s VPC network.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]108 &quot;network&quot;: &quot;A String&quot;, # The name of service consumer&#x27;s VPC network that&#x27;s connected with service producer network, in the following format: `projects/{project}/global/networks/{network}`. `{project}` is a project number, such as in `12345` that includes the VPC service consumer&#x27;s VPC network. `{network}` is the name of the service consumer&#x27;s VPC network.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]109 &quot;peering&quot;: &quot;A String&quot;, # Output only. The name of the VPC Network Peering connection that was created by the service producer.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]110 &quot;reservedPeeringRanges&quot;: [ # The name of one or more allocated IP address ranges for this service producer of type `PEERING`. Note that invoking CreateConnection method with a different range when connection is already established will not modify already provisioned service producer subnetworks. If CreateConnection method is invoked repeatedly to reconnect when peering connection had been disconnected on the consumer side, leaving this field empty will restore previously allocated IP ranges.
111 &quot;A String&quot;,
112 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]113 &quot;service&quot;: &quot;A String&quot;, # Output only. The name of the peering service that&#x27;s associated with this connection, in the following format: `services/{service name}`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]114}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]115
116 x__xgafv: string, V1 error format.
117 Allowed values
118 1 - v1 error format
119 2 - v2 error format
120
121Returns:
122 An object of the form:
123
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]124 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]125 &quot;done&quot;: 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.
126 &quot;error&quot;: { # 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.
127 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
128 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
129 {
130 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
131 },
132 ],
133 &quot;message&quot;: &quot;A String&quot;, # 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.
134 },
135 &quot;metadata&quot;: { # 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.
136 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
137 },
138 &quot;name&quot;: &quot;A String&quot;, # 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}`.
139 &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
140 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
141 },
142}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]143</div>
144
145<div class="method">
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]146 <code class="details" id="deleteConnection">deleteConnection(name, body=None, x__xgafv=None)</code>
147 <pre>Deletes a private service access connection.
148
149Args:
150 name: string, Required. The private service connection that connects to a service producer organization. The name includes both the private service name and the VPC network peering name in the format of `services/{peering_service_name}/connections/{vpc_peering_name}`. For Google services that support this functionality, this is `services/servicenetworking.googleapis.com/connections/servicenetworking-googleapis-com`. (required)
151 body: object, The request body.
152 The object takes the form of:
153
154{ # Request to delete a private service access connection. The call will fail if there are any managed service instances using this connection.
155 &quot;consumerNetwork&quot;: &quot;A String&quot;, # Required. The network that the consumer is using to connect with services. Must be in the form of projects/{project}/global/networks/{network} {project} is a project number, as in &#x27;12345&#x27; {network} is a network name.
156}
157
158 x__xgafv: string, V1 error format.
159 Allowed values
160 1 - v1 error format
161 2 - v2 error format
162
163Returns:
164 An object of the form:
165
166 { # This resource represents a long-running operation that is the result of a network API call.
167 &quot;done&quot;: 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.
168 &quot;error&quot;: { # 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.
169 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
170 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
171 {
172 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
173 },
174 ],
175 &quot;message&quot;: &quot;A String&quot;, # 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.
176 },
177 &quot;metadata&quot;: { # 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.
178 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
179 },
180 &quot;name&quot;: &quot;A String&quot;, # 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}`.
181 &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
182 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
183 },
184}</pre>
185</div>
186
187<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]188 <code class="details" id="list">list(parent, network=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]189 <pre>List the private connections that are configured in a service consumer&#x27;s VPC network.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]190
191Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]192 parent: string, The service that is managing peering connectivity for a service producer&#x27;s organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`. If you specify `services/-` as the parameter value, all configured peering services are listed. (required)
193 network: string, The name of service consumer&#x27;s VPC network that&#x27;s connected with service producer network through a private connection. The network name must be in the following format: `projects/{project}/global/networks/{network}`. {project} is a project number, such as in `12345` that includes the VPC service consumer&#x27;s VPC network. {network} is the name of the service consumer&#x27;s VPC network.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]194 x__xgafv: string, V1 error format.
195 Allowed values
196 1 - v1 error format
197 2 - v2 error format
198
199Returns:
200 An object of the form:
201
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]202 { # ListConnectionsResponse is the response to list peering states for the given service and consumer project.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]203 &quot;connections&quot;: [ # The list of Connections.
204 { # Represents a private connection resource. A private connection is implemented as a VPC Network Peering connection between a service producer&#x27;s VPC network and a service consumer&#x27;s VPC network.
205 &quot;network&quot;: &quot;A String&quot;, # The name of service consumer&#x27;s VPC network that&#x27;s connected with service producer network, in the following format: `projects/{project}/global/networks/{network}`. `{project}` is a project number, such as in `12345` that includes the VPC service consumer&#x27;s VPC network. `{network}` is the name of the service consumer&#x27;s VPC network.
206 &quot;peering&quot;: &quot;A String&quot;, # Output only. The name of the VPC Network Peering connection that was created by the service producer.
207 &quot;reservedPeeringRanges&quot;: [ # The name of one or more allocated IP address ranges for this service producer of type `PEERING`. Note that invoking CreateConnection method with a different range when connection is already established will not modify already provisioned service producer subnetworks. If CreateConnection method is invoked repeatedly to reconnect when peering connection had been disconnected on the consumer side, leaving this field empty will restore previously allocated IP ranges.
208 &quot;A String&quot;,
209 ],
210 &quot;service&quot;: &quot;A String&quot;, # Output only. The name of the peering service that&#x27;s associated with this connection, in the following format: `services/{service name}`.
211 },
212 ],
213}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]214</div>
215
216<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]217 <code class="details" id="patch">patch(name, body=None, force=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]218 <pre>Updates the allocated ranges that are assigned to a connection.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]219
220Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]221 name: string, The private service connection that connects to a service producer organization. The name includes both the private service name and the VPC network peering name in the format of `services/{peering_service_name}/connections/{vpc_peering_name}`. For Google services that support this functionality, this is `services/servicenetworking.googleapis.com/connections/servicenetworking-googleapis-com`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]222 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]223 The object takes the form of:
224
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]225{ # Represents a private connection resource. A private connection is implemented as a VPC Network Peering connection between a service producer&#x27;s VPC network and a service consumer&#x27;s VPC network.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]226 &quot;network&quot;: &quot;A String&quot;, # The name of service consumer&#x27;s VPC network that&#x27;s connected with service producer network, in the following format: `projects/{project}/global/networks/{network}`. `{project}` is a project number, such as in `12345` that includes the VPC service consumer&#x27;s VPC network. `{network}` is the name of the service consumer&#x27;s VPC network.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]227 &quot;peering&quot;: &quot;A String&quot;, # Output only. The name of the VPC Network Peering connection that was created by the service producer.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]228 &quot;reservedPeeringRanges&quot;: [ # The name of one or more allocated IP address ranges for this service producer of type `PEERING`. Note that invoking CreateConnection method with a different range when connection is already established will not modify already provisioned service producer subnetworks. If CreateConnection method is invoked repeatedly to reconnect when peering connection had been disconnected on the consumer side, leaving this field empty will restore previously allocated IP ranges.
229 &quot;A String&quot;,
230 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]231 &quot;service&quot;: &quot;A String&quot;, # Output only. The name of the peering service that&#x27;s associated with this connection, in the following format: `services/{service name}`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]232}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]233
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]234 force: boolean, If a previously defined allocated range is removed, force flag must be set to true.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]235 updateMask: string, The update mask. If this is omitted, it defaults to &quot;*&quot;. You can only update the listed peering ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]236 x__xgafv: string, V1 error format.
237 Allowed values
238 1 - v1 error format
239 2 - v2 error format
240
241Returns:
242 An object of the form:
243
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]244 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]245 &quot;done&quot;: 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.
246 &quot;error&quot;: { # 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.
247 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
248 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
249 {
250 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
251 },
252 ],
253 &quot;message&quot;: &quot;A String&quot;, # 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.
254 },
255 &quot;metadata&quot;: { # 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.
256 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
257 },
258 &quot;name&quot;: &quot;A String&quot;, # 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}`.
259 &quot;response&quot;: { # The normal response of the operation in case of success. 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`.
260 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
261 },
262}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]263</div>
264
265</body></html>