Debian Codegraph @

docs/dyn/datastream_v1.projects.locations.privateConnections.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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="datastream_v1.html">Datastream API</a> . <a href="datastream_v1.projects.html">projects</a> . <a href="datastream_v1.projects.locations.html">locations</a> . <a href="datastream_v1.projects.locations.privateConnections.html">privateConnections</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="datastream_v1.projects.locations.privateConnections.routes.html">routes()</a></code>
79 </p>
80 <p class="firstline">Returns the routes Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="#close">close()</a></code></p>
84 <p class="firstline">Close httplib2 connections.</p>
85 <p class="toc_element">
86 <code><a href="#create">create(parent, body=None, force=None, privateConnectionId=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p>
87 <p class="firstline">Use this method to create a private connectivity configuration.</p>
88 <p class="toc_element">
89 <code><a href="#delete">delete(name, force=None, requestId=None, x__xgafv=None)</a></code></p>
90 <p class="firstline">Use this method to delete a private connectivity configuration.</p>
91 <p class="toc_element">
92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
93 <p class="firstline">Use this method to get details about a private connectivity configuration.</p>
94 <p class="toc_element">
95 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
96 <p class="firstline">Use this method to list private connectivity configurations in a project and location.</p>
97 <p class="toc_element">
98 <code><a href="#list_next">list_next()</a></code></p>
99 <p class="firstline">Retrieves the next page of results.</p>
100 <h3>Method Details</h3>
101 <div class="method">
102 <code class="details" id="close">close()</code>
103 <pre>Close httplib2 connections.</pre>
104 </div>
105
106 <div class="method">
107 <code class="details" id="create">create(parent, body=None, force=None, privateConnectionId=None, requestId=None, validateOnly=None, x__xgafv=None)</code>
108 <pre>Use this method to create a private connectivity configuration.
109
110 Args:
111 parent: string, Required. The parent that owns the collection of PrivateConnections. (required)
112 body: object, The request body.
113 The object takes the form of:
114
115 { # The PrivateConnection resource is used to establish private connectivity between Datastream and a customer&#x27;s network.
116 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The create time of the resource.
117 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name.
118 &quot;error&quot;: { # Represent a user-facing Error. # Output only. In case of error, the details of the error in a user-friendly format.
119 &quot;details&quot;: { # Additional information about the error.
120 &quot;a_key&quot;: &quot;A String&quot;,
121 },
122 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
123 &quot;errorUuid&quot;: &quot;A String&quot;, # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
124 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
125 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
126 },
127 &quot;labels&quot;: { # Labels.
128 &quot;a_key&quot;: &quot;A String&quot;,
129 },
130 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource&#x27;s name.
131 &quot;pscInterfaceConfig&quot;: { # The PSC Interface configuration is used to create PSC Interface between Datastream and the consumer&#x27;s PSC. # PSC Interface Config.
132 &quot;networkAttachment&quot;: &quot;A String&quot;, # Required. Fully qualified name of the Network Attachment that Datastream will connect to. Format: `projects/{project}/regions/{region}/networkAttachments/{name}`
133 },
134 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
135 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
136 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the Private Connection.
137 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The update time of the resource.
138 &quot;vpcPeeringConfig&quot;: { # The VPC Peering configuration is used to create VPC peering between Datastream and the consumer&#x27;s VPC. # VPC Peering Config.
139 &quot;subnet&quot;: &quot;A String&quot;, # Required. A free subnet for peering. (CIDR of /29)
140 &quot;vpc&quot;: &quot;A String&quot;, # Required. Fully qualified name of the VPC that Datastream will peer to. Format: `projects/{project}/global/{networks}/{name}`
141 },
142 }
143
144 force: boolean, Optional. If set to true, will skip validations.
145 privateConnectionId: string, Required. The private connectivity identifier.
146 requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
147 validateOnly: boolean, Optional. When supplied with PSC Interface config, will get/create the tenant project required for the customer to allow list and won&#x27;t actually create the private connection.
148 x__xgafv: string, V1 error format.
149 Allowed values
150 1 - v1 error format
151 2 - v2 error format
152
153 Returns:
154 An object of the form:
155
156 { # This resource represents a long-running operation that is the result of a network API call.
157 &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.
158 &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.
159 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
160 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
161 {
162 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
163 },
164 ],
165 &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.
166 },
167 &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.
168 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
169 },
170 &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}`.
171 &quot;response&quot;: { # 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`.
172 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
173 },
174 }</pre>
175 </div>
176
177 <div class="method">
178 <code class="details" id="delete">delete(name, force=None, requestId=None, x__xgafv=None)</code>
179 <pre>Use this method to delete a private connectivity configuration.
180
181 Args:
182 name: string, Required. The name of the private connectivity configuration to delete. (required)
183 force: boolean, Optional. If set to true, any child routes that belong to this PrivateConnection will also be deleted.
184 requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
185 x__xgafv: string, V1 error format.
186 Allowed values
187 1 - v1 error format
188 2 - v2 error format
189
190 Returns:
191 An object of the form:
192
193 { # This resource represents a long-running operation that is the result of a network API call.
194 &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.
195 &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.
196 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
197 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
198 {
199 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
200 },
201 ],
202 &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.
203 },
204 &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.
205 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
206 },
207 &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}`.
208 &quot;response&quot;: { # 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`.
209 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
210 },
211 }</pre>
212 </div>
213
214 <div class="method">
215 <code class="details" id="get">get(name, x__xgafv=None)</code>
216 <pre>Use this method to get details about a private connectivity configuration.
217
218 Args:
219 name: string, Required. The name of the private connectivity configuration to get. (required)
220 x__xgafv: string, V1 error format.
221 Allowed values
222 1 - v1 error format
223 2 - v2 error format
224
225 Returns:
226 An object of the form:
227
228 { # The PrivateConnection resource is used to establish private connectivity between Datastream and a customer&#x27;s network.
229 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The create time of the resource.
230 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name.
231 &quot;error&quot;: { # Represent a user-facing Error. # Output only. In case of error, the details of the error in a user-friendly format.
232 &quot;details&quot;: { # Additional information about the error.
233 &quot;a_key&quot;: &quot;A String&quot;,
234 },
235 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
236 &quot;errorUuid&quot;: &quot;A String&quot;, # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
237 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
238 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
239 },
240 &quot;labels&quot;: { # Labels.
241 &quot;a_key&quot;: &quot;A String&quot;,
242 },
243 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource&#x27;s name.
244 &quot;pscInterfaceConfig&quot;: { # The PSC Interface configuration is used to create PSC Interface between Datastream and the consumer&#x27;s PSC. # PSC Interface Config.
245 &quot;networkAttachment&quot;: &quot;A String&quot;, # Required. Fully qualified name of the Network Attachment that Datastream will connect to. Format: `projects/{project}/regions/{region}/networkAttachments/{name}`
246 },
247 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
248 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
249 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the Private Connection.
250 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The update time of the resource.
251 &quot;vpcPeeringConfig&quot;: { # The VPC Peering configuration is used to create VPC peering between Datastream and the consumer&#x27;s VPC. # VPC Peering Config.
252 &quot;subnet&quot;: &quot;A String&quot;, # Required. A free subnet for peering. (CIDR of /29)
253 &quot;vpc&quot;: &quot;A String&quot;, # Required. Fully qualified name of the VPC that Datastream will peer to. Format: `projects/{project}/global/{networks}/{name}`
254 },
255 }</pre>
256 </div>
257
258 <div class="method">
259 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
260 <pre>Use this method to list private connectivity configurations in a project and location.
261
262 Args:
263 parent: string, Required. The parent that owns the collection of private connectivity configurations. (required)
264 filter: string, Optional. Filter request.
265 orderBy: string, Optional. Order by fields for the result.
266 pageSize: integer, Maximum number of private connectivity configurations to return. If unspecified, at most 50 private connectivity configurations that will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
267 pageToken: string, Optional. Page token received from a previous `ListPrivateConnections` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPrivateConnections` must match the call that provided the page token.
268 x__xgafv: string, V1 error format.
269 Allowed values
270 1 - v1 error format
271 2 - v2 error format
272
273 Returns:
274 An object of the form:
275
276 { # Response containing a list of private connection configurations.
277 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
278 &quot;privateConnections&quot;: [ # List of private connectivity configurations.
279 { # The PrivateConnection resource is used to establish private connectivity between Datastream and a customer&#x27;s network.
280 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The create time of the resource.
281 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name.
282 &quot;error&quot;: { # Represent a user-facing Error. # Output only. In case of error, the details of the error in a user-friendly format.
283 &quot;details&quot;: { # Additional information about the error.
284 &quot;a_key&quot;: &quot;A String&quot;,
285 },
286 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
287 &quot;errorUuid&quot;: &quot;A String&quot;, # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
288 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
289 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
290 },
291 &quot;labels&quot;: { # Labels.
292 &quot;a_key&quot;: &quot;A String&quot;,
293 },
294 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource&#x27;s name.
295 &quot;pscInterfaceConfig&quot;: { # The PSC Interface configuration is used to create PSC Interface between Datastream and the consumer&#x27;s PSC. # PSC Interface Config.
296 &quot;networkAttachment&quot;: &quot;A String&quot;, # Required. Fully qualified name of the Network Attachment that Datastream will connect to. Format: `projects/{project}/regions/{region}/networkAttachments/{name}`
297 },
298 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
299 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
300 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the Private Connection.
301 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The update time of the resource.
302 &quot;vpcPeeringConfig&quot;: { # The VPC Peering configuration is used to create VPC peering between Datastream and the consumer&#x27;s VPC. # VPC Peering Config.
303 &quot;subnet&quot;: &quot;A String&quot;, # Required. A free subnet for peering. (CIDR of /29)
304 &quot;vpc&quot;: &quot;A String&quot;, # Required. Fully qualified name of the VPC that Datastream will peer to. Format: `projects/{project}/global/{networks}/{name}`
305 },
306 },
307 ],
308 &quot;unreachable&quot;: [ # Locations that could not be reached.
309 &quot;A String&quot;,
310 ],
311 }</pre>
312 </div>
313
314 <div class="method">
315 <code class="details" id="list_next">list_next()</code>
316 <pre>Retrieves the next page of results.
317
318 Args:
319 previous_request: The request for the previous page. (required)
320 previous_response: The response from the request for the previous page. (required)
321
322 Returns:
323 A request object that you can call &#x27;execute()&#x27; on to request the next
324 page. Returns None if there are no more items in the collection.
325 </pre>
326 </div>
327
328 </body></html>