Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / compute_v1.interconnectAttachments.html
blob: dee40c9ef19fe5fe15139102fdc5c5bfa003efdc [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="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.interconnectAttachments.html">interconnectAttachments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None, includeAllScopes=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Retrieves an aggregated list of interconnect attachments.</p>
80<p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(project, region, interconnectAttachment, requestId=None)</a></code></p>
85<p class="firstline">Deletes the specified interconnect attachment.</p>
86<p class="toc_element">
87 <code><a href="#get">get(project, region, interconnectAttachment)</a></code></p>
88<p class="firstline">Returns the specified interconnect attachment.</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]90 <code><a href="#insert">insert(project, region, body=None, requestId=None, validateOnly=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91<p class="firstline">Creates an InterconnectAttachment in the specified project using the data included in the request.</p>
92<p class="toc_element">
93 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
94<p class="firstline">Retrieves the list of interconnect attachments contained within the specified region.</p>
95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]99 <code><a href="#patch">patch(project, region, interconnectAttachment, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100<p class="firstline">Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>
101<h3>Method Details</h3>
102<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]103 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None, includeAllScopes=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]104 <pre>Retrieves an aggregated list of interconnect attachments.
105
106Args:
107 project: string, Project ID for this request. (required)
108 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
109
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]110You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]111
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]112Currently, only sorting by `name` or `creationTimestamp desc` is supported.
113 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
114 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
115 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]117For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]118
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]119You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]120
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]121To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
122 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]123
124Returns:
125 An object of the form:
126
127 {
128 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
129 "kind": "compute#interconnectAttachmentAggregatedList", # [Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments.
130 "items": { # A list of InterconnectAttachmentsScopedList resources.
131 "a_key": { # Name of the scope containing this set of interconnect attachments.
132 "interconnectAttachments": [ # A list of interconnect attachments contained in this scope.
133 { # Represents an Interconnect Attachment (VLAN) resource.
134 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]135 # You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for {$api_version}.interconnectAttachments ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136 "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
137 "bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values:
138 # - BPS_50M: 50 Mbit/s
139 # - BPS_100M: 100 Mbit/s
140 # - BPS_200M: 200 Mbit/s
141 # - BPS_300M: 300 Mbit/s
142 # - BPS_400M: 400 Mbit/s
143 # - BPS_500M: 500 Mbit/s
144 # - BPS_1G: 1 Gbit/s
145 # - BPS_2G: 2 Gbit/s
146 # - BPS_5G: 5 Gbit/s
147 # - BPS_10G: 10 Gbit/s
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]148 # - BPS_20G: 20 Gbit/s
149 # - BPS_50G: 50 Gbit/s
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
151 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
152 "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.
153 "interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.
154 "privateInterconnectInfo": { # Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. # [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.
155 "tag8021q": 42, # [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.
156 },
157 "pairingKey": "A String", # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain"
158 "state": "A String", # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values:
159 # - ACTIVE: The attachment has been turned up and is ready to use.
160 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
161 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
162 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
163 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
164 # - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.
165 "partnerMetadata": { # Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. # Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.
166 "partnerName": "A String", # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]167 "interconnectName": "A String", # Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance "Chicago 1". This value may be validated to match approved Partner values.
168 "portalUrl": "A String", # URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]169 },
170 "type": "A String", # The type of interconnect attachment this is, which can take one of the following values:
171 # - DEDICATED: an attachment to a Dedicated Interconnect.
172 # - PARTNER: an attachment to a Partner Interconnect, created by the customer.
173 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
174 "partnerAsn": "A String", # Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.
175 "description": "A String", # An optional description of this resource.
176 "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
177 "operationalStatus": "A String", # [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values:
178 # - OS_ACTIVE: The attachment has been turned up and is ready to use.
179 # - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
180 "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
181 "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
182 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
183 "googleReferenceId": "A String", # [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]184 "candidateSubnets": [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]185 "A String",
186 ],
187 "edgeAvailabilityDomain": "A String", # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values:
188 # - AVAILABILITY_DOMAIN_ANY
189 # - AVAILABILITY_DOMAIN_1
190 # - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]191 "router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network &amp; region within which the Cloud Router is configured.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]192 "region": "A String", # [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
193 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
194 },
195 ],
196 "warning": { # Informational warning which replaces the list of addresses when the list is empty.
197 "message": "A String", # [Output Only] A human-readable description of the warning code.
198 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
199 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
200 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
201 {
202 "value": "A String", # [Output Only] A warning data value corresponding to the key.
203 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
204 },
205 ],
206 },
207 },
208 },
209 "warning": { # [Output Only] Informational warning message.
210 "message": "A String", # [Output Only] A human-readable description of the warning code.
211 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
212 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
213 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
214 {
215 "value": "A String", # [Output Only] A warning data value corresponding to the key.
216 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
217 },
218 ],
219 },
220 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
221 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
222 }</pre>
223</div>
224
225<div class="method">
226 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
227 <pre>Retrieves the next page of results.
228
229Args:
230 previous_request: The request for the previous page. (required)
231 previous_response: The response from the request for the previous page. (required)
232
233Returns:
234 A request object that you can call 'execute()' on to request the next
235 page. Returns None if there are no more items in the collection.
236 </pre>
237</div>
238
239<div class="method">
240 <code class="details" id="delete">delete(project, region, interconnectAttachment, requestId=None)</code>
241 <pre>Deletes the specified interconnect attachment.
242
243Args:
244 project: string, Project ID for this request. (required)
245 region: string, Name of the region for this request. (required)
246 interconnectAttachment: string, Name of the interconnect attachment to delete. (required)
247 requestId: string, An optional 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.
248
249For 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.
250
251The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
252
253Returns:
254 An object of the form:
255
256 { # Represents an Operation resource.
257 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]258 # Google Compute Engine has three Operation resources:
259 #
260 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
261 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]262 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
263 #
264 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]265 # - For global operations, use the `globalOperations` resource.
266 # - For regional operations, use the `regionOperations` resource.
267 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]268 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]269 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]270 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
271 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
272 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]273 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]274 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
275 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]276 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
277 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]278 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]279 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]280 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]281 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]282 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
283 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
284 {
285 "message": "A String", # [Output Only] A human-readable description of the warning code.
286 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
287 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
288 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
289 {
290 "value": "A String", # [Output Only] A warning data value corresponding to the key.
291 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
292 },
293 ],
294 },
295 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]296 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]297 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]298 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
299 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]300 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
301 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
302 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
303 {
304 "message": "A String", # [Output Only] An optional, human-readable error message.
305 "code": "A String", # [Output Only] The error type identifier for this error.
306 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
307 },
308 ],
309 },
310 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
311 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
312 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
313 }</pre>
314</div>
315
316<div class="method">
317 <code class="details" id="get">get(project, region, interconnectAttachment)</code>
318 <pre>Returns the specified interconnect attachment.
319
320Args:
321 project: string, Project ID for this request. (required)
322 region: string, Name of the region for this request. (required)
323 interconnectAttachment: string, Name of the interconnect attachment to return. (required)
324
325Returns:
326 An object of the form:
327
328 { # Represents an Interconnect Attachment (VLAN) resource.
329 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]330 # You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for {$api_version}.interconnectAttachments ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]331 "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
332 "bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values:
333 # - BPS_50M: 50 Mbit/s
334 # - BPS_100M: 100 Mbit/s
335 # - BPS_200M: 200 Mbit/s
336 # - BPS_300M: 300 Mbit/s
337 # - BPS_400M: 400 Mbit/s
338 # - BPS_500M: 500 Mbit/s
339 # - BPS_1G: 1 Gbit/s
340 # - BPS_2G: 2 Gbit/s
341 # - BPS_5G: 5 Gbit/s
342 # - BPS_10G: 10 Gbit/s
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]343 # - BPS_20G: 20 Gbit/s
344 # - BPS_50G: 50 Gbit/s
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]345 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
346 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
347 "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.
348 "interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.
349 "privateInterconnectInfo": { # Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. # [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.
350 "tag8021q": 42, # [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.
351 },
352 "pairingKey": "A String", # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain"
353 "state": "A String", # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values:
354 # - ACTIVE: The attachment has been turned up and is ready to use.
355 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
356 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
357 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
358 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
359 # - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.
360 "partnerMetadata": { # Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. # Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.
361 "partnerName": "A String", # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]362 "interconnectName": "A String", # Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance "Chicago 1". This value may be validated to match approved Partner values.
363 "portalUrl": "A String", # URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]364 },
365 "type": "A String", # The type of interconnect attachment this is, which can take one of the following values:
366 # - DEDICATED: an attachment to a Dedicated Interconnect.
367 # - PARTNER: an attachment to a Partner Interconnect, created by the customer.
368 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
369 "partnerAsn": "A String", # Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.
370 "description": "A String", # An optional description of this resource.
371 "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
372 "operationalStatus": "A String", # [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values:
373 # - OS_ACTIVE: The attachment has been turned up and is ready to use.
374 # - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
375 "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
376 "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
377 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
378 "googleReferenceId": "A String", # [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]379 "candidateSubnets": [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]380 "A String",
381 ],
382 "edgeAvailabilityDomain": "A String", # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values:
383 # - AVAILABILITY_DOMAIN_ANY
384 # - AVAILABILITY_DOMAIN_1
385 # - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]386 "router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network &amp; region within which the Cloud Router is configured.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]387 "region": "A String", # [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
388 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
389 }</pre>
390</div>
391
392<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]393 <code class="details" id="insert">insert(project, region, body=None, requestId=None, validateOnly=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]394 <pre>Creates an InterconnectAttachment in the specified project using the data included in the request.
395
396Args:
397 project: string, Project ID for this request. (required)
398 region: string, Name of the region for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]399 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]400 The object takes the form of:
401
402{ # Represents an Interconnect Attachment (VLAN) resource.
403 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]404 # You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for {$api_version}.interconnectAttachments ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]405 "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
406 "bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values:
407 # - BPS_50M: 50 Mbit/s
408 # - BPS_100M: 100 Mbit/s
409 # - BPS_200M: 200 Mbit/s
410 # - BPS_300M: 300 Mbit/s
411 # - BPS_400M: 400 Mbit/s
412 # - BPS_500M: 500 Mbit/s
413 # - BPS_1G: 1 Gbit/s
414 # - BPS_2G: 2 Gbit/s
415 # - BPS_5G: 5 Gbit/s
416 # - BPS_10G: 10 Gbit/s
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]417 # - BPS_20G: 20 Gbit/s
418 # - BPS_50G: 50 Gbit/s
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]419 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
420 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
421 "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.
422 "interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.
423 "privateInterconnectInfo": { # Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. # [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.
424 "tag8021q": 42, # [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.
425 },
426 "pairingKey": "A String", # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain"
427 "state": "A String", # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values:
428 # - ACTIVE: The attachment has been turned up and is ready to use.
429 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
430 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
431 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
432 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
433 # - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.
434 "partnerMetadata": { # Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. # Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.
435 "partnerName": "A String", # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]436 "interconnectName": "A String", # Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance "Chicago 1". This value may be validated to match approved Partner values.
437 "portalUrl": "A String", # URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]438 },
439 "type": "A String", # The type of interconnect attachment this is, which can take one of the following values:
440 # - DEDICATED: an attachment to a Dedicated Interconnect.
441 # - PARTNER: an attachment to a Partner Interconnect, created by the customer.
442 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
443 "partnerAsn": "A String", # Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.
444 "description": "A String", # An optional description of this resource.
445 "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
446 "operationalStatus": "A String", # [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values:
447 # - OS_ACTIVE: The attachment has been turned up and is ready to use.
448 # - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
449 "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
450 "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
451 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
452 "googleReferenceId": "A String", # [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]453 "candidateSubnets": [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]454 "A String",
455 ],
456 "edgeAvailabilityDomain": "A String", # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values:
457 # - AVAILABILITY_DOMAIN_ANY
458 # - AVAILABILITY_DOMAIN_1
459 # - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]460 "router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network &amp; region within which the Cloud Router is configured.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]461 "region": "A String", # [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
462 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
463 }
464
465 requestId: string, An optional 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.
466
467For 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.
468
469The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]470 validateOnly: boolean, If true, the request will not be committed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]471
472Returns:
473 An object of the form:
474
475 { # Represents an Operation resource.
476 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]477 # Google Compute Engine has three Operation resources:
478 #
479 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
480 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]481 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
482 #
483 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]484 # - For global operations, use the `globalOperations` resource.
485 # - For regional operations, use the `regionOperations` resource.
486 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]487 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]488 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]489 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
490 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
491 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]492 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]493 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
494 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]495 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
496 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]497 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]498 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]499 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]500 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]501 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
502 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
503 {
504 "message": "A String", # [Output Only] A human-readable description of the warning code.
505 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
506 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
507 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
508 {
509 "value": "A String", # [Output Only] A warning data value corresponding to the key.
510 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
511 },
512 ],
513 },
514 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]515 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]516 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]517 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
518 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]519 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
520 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
521 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
522 {
523 "message": "A String", # [Output Only] An optional, human-readable error message.
524 "code": "A String", # [Output Only] The error type identifier for this error.
525 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
526 },
527 ],
528 },
529 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
530 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
531 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
532 }</pre>
533</div>
534
535<div class="method">
536 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
537 <pre>Retrieves the list of interconnect attachments contained within the specified region.
538
539Args:
540 project: string, Project ID for this request. (required)
541 region: string, Name of the region for this request. (required)
542 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
543
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]544You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]545
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]546Currently, only sorting by `name` or `creationTimestamp desc` is supported.
547 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
548 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
549 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]550
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]551For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]552
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]553You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]554
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]555To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]556
557Returns:
558 An object of the form:
559
560 { # Response to the list request, and contains a list of interconnect attachments.
561 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
562 "kind": "compute#interconnectAttachmentList", # [Output Only] Type of resource. Always compute#interconnectAttachmentList for lists of interconnect attachments.
563 "items": [ # A list of InterconnectAttachment resources.
564 { # Represents an Interconnect Attachment (VLAN) resource.
565 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]566 # You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for {$api_version}.interconnectAttachments ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]567 "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
568 "bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values:
569 # - BPS_50M: 50 Mbit/s
570 # - BPS_100M: 100 Mbit/s
571 # - BPS_200M: 200 Mbit/s
572 # - BPS_300M: 300 Mbit/s
573 # - BPS_400M: 400 Mbit/s
574 # - BPS_500M: 500 Mbit/s
575 # - BPS_1G: 1 Gbit/s
576 # - BPS_2G: 2 Gbit/s
577 # - BPS_5G: 5 Gbit/s
578 # - BPS_10G: 10 Gbit/s
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]579 # - BPS_20G: 20 Gbit/s
580 # - BPS_50G: 50 Gbit/s
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]581 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
582 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
583 "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.
584 "interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.
585 "privateInterconnectInfo": { # Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. # [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.
586 "tag8021q": 42, # [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.
587 },
588 "pairingKey": "A String", # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain"
589 "state": "A String", # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values:
590 # - ACTIVE: The attachment has been turned up and is ready to use.
591 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
592 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
593 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
594 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
595 # - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.
596 "partnerMetadata": { # Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. # Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.
597 "partnerName": "A String", # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]598 "interconnectName": "A String", # Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance "Chicago 1". This value may be validated to match approved Partner values.
599 "portalUrl": "A String", # URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]600 },
601 "type": "A String", # The type of interconnect attachment this is, which can take one of the following values:
602 # - DEDICATED: an attachment to a Dedicated Interconnect.
603 # - PARTNER: an attachment to a Partner Interconnect, created by the customer.
604 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
605 "partnerAsn": "A String", # Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.
606 "description": "A String", # An optional description of this resource.
607 "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
608 "operationalStatus": "A String", # [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values:
609 # - OS_ACTIVE: The attachment has been turned up and is ready to use.
610 # - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
611 "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
612 "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
613 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
614 "googleReferenceId": "A String", # [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]615 "candidateSubnets": [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]616 "A String",
617 ],
618 "edgeAvailabilityDomain": "A String", # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values:
619 # - AVAILABILITY_DOMAIN_ANY
620 # - AVAILABILITY_DOMAIN_1
621 # - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]622 "router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network &amp; region within which the Cloud Router is configured.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]623 "region": "A String", # [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
624 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
625 },
626 ],
627 "warning": { # [Output Only] Informational warning message.
628 "message": "A String", # [Output Only] A human-readable description of the warning code.
629 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
630 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
631 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
632 {
633 "value": "A String", # [Output Only] A warning data value corresponding to the key.
634 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
635 },
636 ],
637 },
638 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
639 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
640 }</pre>
641</div>
642
643<div class="method">
644 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
645 <pre>Retrieves the next page of results.
646
647Args:
648 previous_request: The request for the previous page. (required)
649 previous_response: The response from the request for the previous page. (required)
650
651Returns:
652 A request object that you can call 'execute()' on to request the next
653 page. Returns None if there are no more items in the collection.
654 </pre>
655</div>
656
657<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]658 <code class="details" id="patch">patch(project, region, interconnectAttachment, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]659 <pre>Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
660
661Args:
662 project: string, Project ID for this request. (required)
663 region: string, Name of the region scoping this request. (required)
664 interconnectAttachment: string, Name of the interconnect attachment to patch. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]665 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]666 The object takes the form of:
667
668{ # Represents an Interconnect Attachment (VLAN) resource.
669 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]670 # You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for {$api_version}.interconnectAttachments ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]671 "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
672 "bandwidth": "A String", # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values:
673 # - BPS_50M: 50 Mbit/s
674 # - BPS_100M: 100 Mbit/s
675 # - BPS_200M: 200 Mbit/s
676 # - BPS_300M: 300 Mbit/s
677 # - BPS_400M: 400 Mbit/s
678 # - BPS_500M: 500 Mbit/s
679 # - BPS_1G: 1 Gbit/s
680 # - BPS_2G: 2 Gbit/s
681 # - BPS_5G: 5 Gbit/s
682 # - BPS_10G: 10 Gbit/s
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]683 # - BPS_20G: 20 Gbit/s
684 # - BPS_50G: 50 Gbit/s
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]685 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
686 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
687 "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.
688 "interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.
689 "privateInterconnectInfo": { # Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. # [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.
690 "tag8021q": 42, # [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.
691 },
692 "pairingKey": "A String", # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain"
693 "state": "A String", # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values:
694 # - ACTIVE: The attachment has been turned up and is ready to use.
695 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
696 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
697 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
698 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
699 # - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.
700 "partnerMetadata": { # Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. # Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.
701 "partnerName": "A String", # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]702 "interconnectName": "A String", # Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance "Chicago 1". This value may be validated to match approved Partner values.
703 "portalUrl": "A String", # URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]704 },
705 "type": "A String", # The type of interconnect attachment this is, which can take one of the following values:
706 # - DEDICATED: an attachment to a Dedicated Interconnect.
707 # - PARTNER: an attachment to a Partner Interconnect, created by the customer.
708 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
709 "partnerAsn": "A String", # Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.
710 "description": "A String", # An optional description of this resource.
711 "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
712 "operationalStatus": "A String", # [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values:
713 # - OS_ACTIVE: The attachment has been turned up and is ready to use.
714 # - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
715 "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
716 "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
717 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
718 "googleReferenceId": "A String", # [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]719 "candidateSubnets": [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]720 "A String",
721 ],
722 "edgeAvailabilityDomain": "A String", # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values:
723 # - AVAILABILITY_DOMAIN_ANY
724 # - AVAILABILITY_DOMAIN_1
725 # - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]726 "router": "A String", # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network &amp; region within which the Cloud Router is configured.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]727 "region": "A String", # [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
728 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
729 }
730
731 requestId: string, An optional 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.
732
733For 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.
734
735The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
736
737Returns:
738 An object of the form:
739
740 { # Represents an Operation resource.
741 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]742 # Google Compute Engine has three Operation resources:
743 #
744 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
745 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]746 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
747 #
748 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]749 # - For global operations, use the `globalOperations` resource.
750 # - For regional operations, use the `regionOperations` resource.
751 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]752 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]753 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]754 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
755 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
756 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]757 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]758 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
759 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]760 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
761 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]762 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]763 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]764 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]765 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]766 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
767 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
768 {
769 "message": "A String", # [Output Only] A human-readable description of the warning code.
770 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
771 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
772 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
773 {
774 "value": "A String", # [Output Only] A warning data value corresponding to the key.
775 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
776 },
777 ],
778 },
779 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]780 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]781 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]782 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
783 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]784 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
785 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
786 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
787 {
788 "message": "A String", # [Output Only] An optional, human-readable error message.
789 "code": "A String", # [Output Only] The error type identifier for this error.
790 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
791 },
792 ],
793 },
794 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
795 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
796 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
797 }</pre>
798</div>
799
800</body></html>