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
|
<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_v1beta.html">Service Networking API</a> . <a href="servicenetworking_v1beta.services.html">services</a> . <a href="servicenetworking_v1beta.services.connections.html">connections</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a private connection that establishes a VPC Network Peering</p>
<p class="toc_element">
<code><a href="#list">list(parent, network=None, x__xgafv=None)</a></code></p>
<p class="firstline">List the private connections that are configured in a service consumer's</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(parent, body, x__xgafv=None)</code>
<pre>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. The response from the
`get` operation will be of type `Connection` if the operation successfully
completes.
Args:
parent: string, The service that is managing peering connectivity for a service producer's
organization. For Google services that support this functionality, this
value is `services/servicenetworking.googleapis.com`. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Represents a private connection resource. A private connection is implemented
# as a VPC Network Peering connection between a service producer's VPC network
# and a service consumer's VPC network.
"peering": "A String", # Output only.
# The name of the VPC Network Peering connection that was created by the
# service producer.
"reservedPeeringRanges": [ # The name of one or more allocated IP address ranges for this service
# producer of type `PEERING`.
# Note that invoking this method with a different range when connection is
# already established will not modify already provisioned service
# producer subnetworks.
"A String",
],
"network": "A String", # The name of service consumer's VPC network that'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's VPC network. `{network}` is the name of the
# service consumer's VPC network.
"service": "A String", # Output only.
# The name of the peering service that's associated with this connection, in
# the following format: `services/{service name}`.
}
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.
"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.
},
"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.
"response": { # 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`.
"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}`.
"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.
# 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).
"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.
"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.
},
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, network=None, x__xgafv=None)</code>
<pre>List the private connections that are configured in a service consumer's
VPC network.
Args:
parent: string, The service that is managing peering connectivity for a service producer's
organization. For Google services that support this functionality, this
value is `services/servicenetworking.googleapis.com`.
If you specify `-` as the parameter value, all configured public peering
services are listed. (required)
network: string, The name of service consumer's VPC network that'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's VPC network. {network} is the name of the service consumer's VPC
network.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # ListConnectionsResponse is the response to list peering states for the
# given service and consumer project.
"connections": [ # The list of Connections.
{ # Represents a private connection resource. A private connection is implemented
# as a VPC Network Peering connection between a service producer's VPC network
# and a service consumer's VPC network.
"peering": "A String", # Output only.
# The name of the VPC Network Peering connection that was created by the
# service producer.
"reservedPeeringRanges": [ # The name of one or more allocated IP address ranges for this service
# producer of type `PEERING`.
# Note that invoking this method with a different range when connection is
# already established will not modify already provisioned service
# producer subnetworks.
"A String",
],
"network": "A String", # The name of service consumer's VPC network that'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's VPC network. `{network}` is the name of the
# service consumer's VPC network.
"service": "A String", # Output only.
# The name of the peering service that's associated with this connection, in
# the following format: `services/{service name}`.
},
],
}</pre>
</div>
</body></html>
|
