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"> 78 <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p> 79<p class="firstline">Creates a private connection that establishes a VPC Network Peering</p> 80<p class="toc_element"> 81 <code><a href="#list">list(parent, network=None, x__xgafv=None)</a></code></p> 82<p class="firstline">List the private connections that are configured in a service consumer's</p> 83<p class="toc_element"> 84 <code><a href="#patch">patch(name, body, force=None, updateMask=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Updates the allocated ranges that are assigned to a connection.</p> 86<h3>Method Details</h3> 87<div class="method"> 88 <code class="details" id="create">create(parent, body, x__xgafv=None)</code> 89 <pre>Creates a private connection that establishes a VPC Network Peering 90connection to a VPC network in the service producer's organization. 91The administrator of the service consumer's VPC network invokes this 92method. The administrator must assign one or more allocated IP ranges for 93provisioning subnetworks in the service producer's VPC network. This 94connection is used for all supported services in the service producer's 95organization, so it only needs to be invoked once. The response from the 96`get` operation will be of type `Connection` if the operation successfully 97completes. 98 99Args: 100 parent: string, The service that is managing peering connectivity for a service producer's 101organization. For Google services that support this functionality, this 102value is `services/servicenetworking.googleapis.com`. (required) 103 body: object, The request body. (required) 104 The object takes the form of: 105 106{ # Represents a private connection resource. A private connection is implemented 107 # as a VPC Network Peering connection between a service producer's VPC network 108 # and a service consumer's VPC network. 109 "peering": "A String", # Output only. 110 # The name of the VPC Network Peering connection that was created by the 111 # service producer. 112 "reservedPeeringRanges": [ # The name of one or more allocated IP address ranges for this service 113 # producer of type `PEERING`. 114 # Note that invoking CreateConnection method with a different range when 115 # connection is already established will not modify already provisioned 116 # service producer subnetworks. 117 # If CreateConnection method is invoked repeatedly to reconnect when peering 118 # connection had been disconnected on the consumer side, leaving this field 119 # empty will restore previously allocated IP ranges. 120 "A String", 121 ], 122 "network": "A String", # The name of service consumer's VPC network that's connected with service 123 # producer network, in the following format: 124 # `projects/{project}/global/networks/{network}`. 125 # `{project}` is a project number, such as in `12345` that includes 126 # the VPC service consumer's VPC network. `{network}` is the name of the 127 # service consumer's VPC network. 128 "service": "A String", # Output only. 129 # The name of the peering service that's associated with this connection, in 130 # the following format: `services/{service name}`. 131 } 132 133 x__xgafv: string, V1 error format. 134 Allowed values 135 1 - v1 error format 136 2 - v2 error format 137 138Returns: 139 An object of the form: 140 141 { # This resource represents a long-running operation that is the result of a 142 # network API call. 143 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. 144 # different programming environments, including REST APIs and RPC APIs. It is 145 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 146 # three pieces of data: error code, error message, and error details. 147 # 148 # You can find out more about this error model and how to work with it in the 149 # [API Design Guide](https://cloud.google.com/apis/design/errors). 150 "message": "A String", # A developer-facing error message, which should be in English. Any 151 # user-facing error message should be localized and sent in the 152 # google.rpc.Status.details field, or localized by the client. 153 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 154 "details": [ # A list of messages that carry the error details. There is a common set of 155 # message types for APIs to use. 156 { 157 "a_key": "", # Properties of the object. Contains field @type with type URL. 158 }, 159 ], 160 }, 161 "done": True or False, # If the value is `false`, it means the operation is still in progress. 162 # If `true`, the operation is completed, and either `error` or `response` is 163 # available. 164 "response": { # The normal response of the operation in case of success. If the original 165 # method returns no data on success, such as `Delete`, the response is 166 # `google.protobuf.Empty`. If the original method is standard 167 # `Get`/`Create`/`Update`, the response should be the resource. For other 168 # methods, the response should have the type `XxxResponse`, where `Xxx` 169 # is the original method name. For example, if the original method name 170 # is `TakeSnapshot()`, the inferred response type is 171 # `TakeSnapshotResponse`. 172 "a_key": "", # Properties of the object. Contains field @type with type URL. 173 }, 174 "name": "A String", # The server-assigned name, which is only unique within the same service that 175 # originally returns it. If you use the default HTTP mapping, the 176 # `name` should be a resource name ending with `operations/{unique_id}`. 177 "metadata": { # Service-specific metadata associated with the operation. It typically 178 # contains progress information and common metadata such as create time. 179 # Some services might not provide such metadata. Any method that returns a 180 # long-running operation should document the metadata type, if any. 181 "a_key": "", # Properties of the object. Contains field @type with type URL. 182 }, 183 }</pre> 184</div> 185 186<div class="method"> 187 <code class="details" id="list">list(parent, network=None, x__xgafv=None)</code> 188 <pre>List the private connections that are configured in a service consumer's 189VPC network. 190 191Args: 192 parent: string, The service that is managing peering connectivity for a service producer's 193organization. For Google services that support this functionality, this 194value is `services/servicenetworking.googleapis.com`. 195If you specify `services/-` as the parameter value, all configured peering 196services are listed. (required) 197 network: string, The name of service consumer's VPC network that's connected with service 198producer network through a private connection. The network name must be in 199the following format: 200`projects/{project}/global/networks/{network}`. {project} is a 201project number, such as in `12345` that includes the VPC service 202consumer's VPC network. {network} is the name of the service consumer's VPC 203network. 204 x__xgafv: string, V1 error format. 205 Allowed values 206 1 - v1 error format 207 2 - v2 error format 208 209Returns: 210 An object of the form: 211 212 { # ListConnectionsResponse is the response to list peering states for the 213 # given service and consumer project. 214 "connections": [ # The list of Connections. 215 { # Represents a private connection resource. A private connection is implemented 216 # as a VPC Network Peering connection between a service producer's VPC network 217 # and a service consumer's VPC network. 218 "peering": "A String", # Output only. 219 # The name of the VPC Network Peering connection that was created by the 220 # service producer. 221 "reservedPeeringRanges": [ # The name of one or more allocated IP address ranges for this service 222 # producer of type `PEERING`. 223 # Note that invoking CreateConnection method with a different range when 224 # connection is already established will not modify already provisioned 225 # service producer subnetworks. 226 # If CreateConnection method is invoked repeatedly to reconnect when peering 227 # connection had been disconnected on the consumer side, leaving this field 228 # empty will restore previously allocated IP ranges. 229 "A String", 230 ], 231 "network": "A String", # The name of service consumer's VPC network that's connected with service 232 # producer network, in the following format: 233 # `projects/{project}/global/networks/{network}`. 234 # `{project}` is a project number, such as in `12345` that includes 235 # the VPC service consumer's VPC network. `{network}` is the name of the 236 # service consumer's VPC network. 237 "service": "A String", # Output only. 238 # The name of the peering service that's associated with this connection, in 239 # the following format: `services/{service name}`. 240 }, 241 ], 242 }</pre> 243</div> 244 245<div class="method"> 246 <code class="details" id="patch">patch(name, body, force=None, updateMask=None, x__xgafv=None)</code> 247 <pre>Updates the allocated ranges that are assigned to a connection. 248The response from the `get` operation will be of type `Connection` if the 249operation successfully completes. 250 251Args: 252 name: string, The private service connection that connects to a service producer 253organization. The name includes both the private service name and the VPC 254network peering name in the format of 255`services/{peering_service_name}/connections/{vpc_peering_name}`. For 256Google services that support this functionality, this is 257`services/servicenetworking.googleapis.com/connections/servicenetworking-googleapis-com`. (required) 258 body: object, The request body. (required) 259 The object takes the form of: 260 261{ # Represents a private connection resource. A private connection is implemented 262 # as a VPC Network Peering connection between a service producer's VPC network 263 # and a service consumer's VPC network. 264 "peering": "A String", # Output only. 265 # The name of the VPC Network Peering connection that was created by the 266 # service producer. 267 "reservedPeeringRanges": [ # The name of one or more allocated IP address ranges for this service 268 # producer of type `PEERING`. 269 # Note that invoking CreateConnection method with a different range when 270 # connection is already established will not modify already provisioned 271 # service producer subnetworks. 272 # If CreateConnection method is invoked repeatedly to reconnect when peering 273 # connection had been disconnected on the consumer side, leaving this field 274 # empty will restore previously allocated IP ranges. 275 "A String", 276 ], 277 "network": "A String", # The name of service consumer's VPC network that's connected with service 278 # producer network, in the following format: 279 # `projects/{project}/global/networks/{network}`. 280 # `{project}` is a project number, such as in `12345` that includes 281 # the VPC service consumer's VPC network. `{network}` is the name of the 282 # service consumer's VPC network. 283 "service": "A String", # Output only. 284 # The name of the peering service that's associated with this connection, in 285 # the following format: `services/{service name}`. 286 } 287 288 force: boolean, If a previously defined allocated range is removed, force flag must be 289set to true. 290 updateMask: string, The update mask. If this is omitted, it defaults to "*". You can only 291update the listed peering ranges. 292 x__xgafv: string, V1 error format. 293 Allowed values 294 1 - v1 error format 295 2 - v2 error format 296 297Returns: 298 An object of the form: 299 300 { # This resource represents a long-running operation that is the result of a 301 # network API call. 302 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. 303 # different programming environments, including REST APIs and RPC APIs. It is 304 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 305 # three pieces of data: error code, error message, and error details. 306 # 307 # You can find out more about this error model and how to work with it in the 308 # [API Design Guide](https://cloud.google.com/apis/design/errors). 309 "message": "A String", # A developer-facing error message, which should be in English. Any 310 # user-facing error message should be localized and sent in the 311 # google.rpc.Status.details field, or localized by the client. 312 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 313 "details": [ # A list of messages that carry the error details. There is a common set of 314 # message types for APIs to use. 315 { 316 "a_key": "", # Properties of the object. Contains field @type with type URL. 317 }, 318 ], 319 }, 320 "done": True or False, # If the value is `false`, it means the operation is still in progress. 321 # If `true`, the operation is completed, and either `error` or `response` is 322 # available. 323 "response": { # The normal response of the operation in case of success. If the original 324 # method returns no data on success, such as `Delete`, the response is 325 # `google.protobuf.Empty`. If the original method is standard 326 # `Get`/`Create`/`Update`, the response should be the resource. For other 327 # methods, the response should have the type `XxxResponse`, where `Xxx` 328 # is the original method name. For example, if the original method name 329 # is `TakeSnapshot()`, the inferred response type is 330 # `TakeSnapshotResponse`. 331 "a_key": "", # Properties of the object. Contains field @type with type URL. 332 }, 333 "name": "A String", # The server-assigned name, which is only unique within the same service that 334 # originally returns it. If you use the default HTTP mapping, the 335 # `name` should be a resource name ending with `operations/{unique_id}`. 336 "metadata": { # Service-specific metadata associated with the operation. It typically 337 # contains progress information and common metadata such as create time. 338 # Some services might not provide such metadata. Any method that returns a 339 # long-running operation should document the metadata type, if any. 340 "a_key": "", # Properties of the object. Contains field @type with type URL. 341 }, 342 }</pre> 343</div> 344 345</body></html>