blob: 140bd587f9203ccafc7516786f5f2849aafca7b6 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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_beta.html">Compute Engine API</a> . <a href="compute_beta.interconnectAttachments.html">interconnectAttachments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
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">
90 <code><a href="#insert">insert(project, region, body, requestId=None)</a></code></p>
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">
99 <code><a href="#patch">patch(project, region, interconnectAttachment, body, requestId=None)</a></code></p>
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<p class="toc_element">
102 <code><a href="#setLabels">setLabels(project, region, resource, body, requestId=None)</a></code></p>
103<p class="firstline">Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation.</p>
104<p class="toc_element">
105 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
106<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
107<h3>Method Details</h3>
108<div class="method">
109 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
110 <pre>Retrieves an aggregated list of interconnect attachments.
111
112Args:
113 project: string, Project ID for this request. (required)
114 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
115
116You 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.
117
118Currently, only sorting by name or creationTimestamp desc is supported.
119 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)
120 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.
121 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 =, !=, >, or <.
122
123For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
124
125You 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.
126
127To 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).
128
129Returns:
130 An object of the form:
131
132 {
133 "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.
134 "kind": "compute#interconnectAttachmentAggregatedList", # [Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments.
135 "items": { # A list of InterconnectAttachmentsScopedList resources.
136 "a_key": { # Name of the scope containing this set of interconnect attachments.
137 "interconnectAttachments": [ # A list of interconnect attachments contained in this scope.
138 { # Represents an Interconnect Attachment (VLAN) resource.
139 #
140 # 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 beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==)
141 "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
142 "labels": { # Labels to apply to this InterconnectAttachment resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
143 "a_key": "A String",
144 },
145 "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:
146 # - BPS_50M: 50 Mbit/s
147 # - BPS_100M: 100 Mbit/s
148 # - BPS_200M: 200 Mbit/s
149 # - BPS_300M: 300 Mbit/s
150 # - BPS_400M: 400 Mbit/s
151 # - BPS_500M: 500 Mbit/s
152 # - BPS_1G: 1 Gbit/s
153 # - BPS_2G: 2 Gbit/s
154 # - BPS_5G: 5 Gbit/s
155 # - BPS_10G: 10 Gbit/s
156 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
157 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
158 "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.
159 "interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.
160 "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.
161 "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.
162 },
163 "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"
164 "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:
165 # - ACTIVE: The attachment has been turned up and is ready to use.
166 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
167 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
168 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
169 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
170 # - 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.
171 "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.
172 "partnerName": "A String", # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.
173 "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.
174 "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.
175 },
176 "type": "A String", # The type of interconnect attachment this is, which can take one of the following values:
177 # - DEDICATED: an attachment to a Dedicated Interconnect.
178 # - PARTNER: an attachment to a Partner Interconnect, created by the customer.
179 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
180 "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.
181 "description": "A String", # An optional description of this resource.
182 "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
183 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
184 #
185 # To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.
186 "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:
187 # - OS_ACTIVE: The attachment has been turned up and is ready to use.
188 # - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
189 "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
190 "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
191 "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.
192 "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.
193 "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.
194 "A String",
195 ],
196 "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:
197 # - AVAILABILITY_DOMAIN_ANY
198 # - AVAILABILITY_DOMAIN_1
199 # - 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.
200 "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 & region within which the Cloud Router is configured.
201 "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.
202 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
203 },
204 ],
205 "warning": { # Informational warning which replaces the list of addresses when the list is empty.
206 "message": "A String", # [Output Only] A human-readable description of the warning code.
207 "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.
208 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
209 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
210 {
211 "value": "A String", # [Output Only] A warning data value corresponding to the key.
212 "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).
213 },
214 ],
215 },
216 },
217 },
218 "warning": { # [Output Only] Informational warning message.
219 "message": "A String", # [Output Only] A human-readable description of the warning code.
220 "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.
221 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
222 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
223 {
224 "value": "A String", # [Output Only] A warning data value corresponding to the key.
225 "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).
226 },
227 ],
228 },
229 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
230 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
231 }</pre>
232</div>
233
234<div class="method">
235 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
236 <pre>Retrieves the next page of results.
237
238Args:
239 previous_request: The request for the previous page. (required)
240 previous_response: The response from the request for the previous page. (required)
241
242Returns:
243 A request object that you can call 'execute()' on to request the next
244 page. Returns None if there are no more items in the collection.
245 </pre>
246</div>
247
248<div class="method">
249 <code class="details" id="delete">delete(project, region, interconnectAttachment, requestId=None)</code>
250 <pre>Deletes the specified interconnect attachment.
251
252Args:
253 project: string, Project ID for this request. (required)
254 region: string, Name of the region for this request. (required)
255 interconnectAttachment: string, Name of the interconnect attachment to delete. (required)
256 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.
257
258For 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.
259
260The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
261
262Returns:
263 An object of the form:
264
265 { # Represents an Operation resource.
266 #
267 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
268 #
269 # Operations can be global, regional or zonal.
270 # - For global operations, use the globalOperations resource.
271 # - For regional operations, use the regionOperations resource.
272 # - For zonal operations, use the zonalOperations resource.
273 #
274 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
275 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
276 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
277 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
278 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
279 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
280 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
281 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
282 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
283 "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.
284 "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.
285 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
286 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
287 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
288 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
289 {
290 "message": "A String", # [Output Only] A human-readable description of the warning code.
291 "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.
292 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
293 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
294 {
295 "value": "A String", # [Output Only] A warning data value corresponding to the key.
296 "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).
297 },
298 ],
299 },
300 ],
301 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
302 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
303 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
304 "name": "A String", # [Output Only] Name of the resource.
305 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
306 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
307 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
308 {
309 "message": "A String", # [Output Only] An optional, human-readable error message.
310 "code": "A String", # [Output Only] The error type identifier for this error.
311 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
312 },
313 ],
314 },
315 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
316 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
317 "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.
318 }</pre>
319</div>
320
321<div class="method">
322 <code class="details" id="get">get(project, region, interconnectAttachment)</code>
323 <pre>Returns the specified interconnect attachment.
324
325Args:
326 project: string, Project ID for this request. (required)
327 region: string, Name of the region for this request. (required)
328 interconnectAttachment: string, Name of the interconnect attachment to return. (required)
329
330Returns:
331 An object of the form:
332
333 { # Represents an Interconnect Attachment (VLAN) resource.
334 #
335 # 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 beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==)
336 "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
337 "labels": { # Labels to apply to this InterconnectAttachment resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
338 "a_key": "A String",
339 },
340 "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:
341 # - BPS_50M: 50 Mbit/s
342 # - BPS_100M: 100 Mbit/s
343 # - BPS_200M: 200 Mbit/s
344 # - BPS_300M: 300 Mbit/s
345 # - BPS_400M: 400 Mbit/s
346 # - BPS_500M: 500 Mbit/s
347 # - BPS_1G: 1 Gbit/s
348 # - BPS_2G: 2 Gbit/s
349 # - BPS_5G: 5 Gbit/s
350 # - BPS_10G: 10 Gbit/s
351 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
352 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
353 "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.
354 "interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.
355 "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.
356 "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.
357 },
358 "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"
359 "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:
360 # - ACTIVE: The attachment has been turned up and is ready to use.
361 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
362 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
363 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
364 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
365 # - 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.
366 "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.
367 "partnerName": "A String", # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.
368 "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.
369 "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.
370 },
371 "type": "A String", # The type of interconnect attachment this is, which can take one of the following values:
372 # - DEDICATED: an attachment to a Dedicated Interconnect.
373 # - PARTNER: an attachment to a Partner Interconnect, created by the customer.
374 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
375 "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.
376 "description": "A String", # An optional description of this resource.
377 "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
378 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
379 #
380 # To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.
381 "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:
382 # - OS_ACTIVE: The attachment has been turned up and is ready to use.
383 # - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
384 "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
385 "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
386 "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.
387 "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.
388 "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.
389 "A String",
390 ],
391 "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:
392 # - AVAILABILITY_DOMAIN_ANY
393 # - AVAILABILITY_DOMAIN_1
394 # - 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.
395 "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 & region within which the Cloud Router is configured.
396 "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.
397 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
398 }</pre>
399</div>
400
401<div class="method">
402 <code class="details" id="insert">insert(project, region, body, requestId=None)</code>
403 <pre>Creates an InterconnectAttachment in the specified project using the data included in the request.
404
405Args:
406 project: string, Project ID for this request. (required)
407 region: string, Name of the region for this request. (required)
408 body: object, The request body. (required)
409 The object takes the form of:
410
411{ # Represents an Interconnect Attachment (VLAN) resource.
412 #
413 # 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 beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==)
414 "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
415 "labels": { # Labels to apply to this InterconnectAttachment resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
416 "a_key": "A String",
417 },
418 "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:
419 # - BPS_50M: 50 Mbit/s
420 # - BPS_100M: 100 Mbit/s
421 # - BPS_200M: 200 Mbit/s
422 # - BPS_300M: 300 Mbit/s
423 # - BPS_400M: 400 Mbit/s
424 # - BPS_500M: 500 Mbit/s
425 # - BPS_1G: 1 Gbit/s
426 # - BPS_2G: 2 Gbit/s
427 # - BPS_5G: 5 Gbit/s
428 # - BPS_10G: 10 Gbit/s
429 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
430 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
431 "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.
432 "interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.
433 "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.
434 "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.
435 },
436 "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"
437 "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:
438 # - ACTIVE: The attachment has been turned up and is ready to use.
439 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
440 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
441 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
442 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
443 # - 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.
444 "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.
445 "partnerName": "A String", # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.
446 "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.
447 "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.
448 },
449 "type": "A String", # The type of interconnect attachment this is, which can take one of the following values:
450 # - DEDICATED: an attachment to a Dedicated Interconnect.
451 # - PARTNER: an attachment to a Partner Interconnect, created by the customer.
452 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
453 "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.
454 "description": "A String", # An optional description of this resource.
455 "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
456 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
457 #
458 # To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.
459 "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:
460 # - OS_ACTIVE: The attachment has been turned up and is ready to use.
461 # - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
462 "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
463 "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
464 "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.
465 "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.
466 "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.
467 "A String",
468 ],
469 "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:
470 # - AVAILABILITY_DOMAIN_ANY
471 # - AVAILABILITY_DOMAIN_1
472 # - 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.
473 "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 & region within which the Cloud Router is configured.
474 "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.
475 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
476 }
477
478 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.
479
480For 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.
481
482The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
483
484Returns:
485 An object of the form:
486
487 { # Represents an Operation resource.
488 #
489 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
490 #
491 # Operations can be global, regional or zonal.
492 # - For global operations, use the globalOperations resource.
493 # - For regional operations, use the regionOperations resource.
494 # - For zonal operations, use the zonalOperations resource.
495 #
496 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
497 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
498 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
499 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
500 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
501 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
502 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
503 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
504 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
505 "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.
506 "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.
507 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
508 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
509 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
510 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
511 {
512 "message": "A String", # [Output Only] A human-readable description of the warning code.
513 "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.
514 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
515 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
516 {
517 "value": "A String", # [Output Only] A warning data value corresponding to the key.
518 "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).
519 },
520 ],
521 },
522 ],
523 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
524 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
525 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
526 "name": "A String", # [Output Only] Name of the resource.
527 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
528 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
529 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
530 {
531 "message": "A String", # [Output Only] An optional, human-readable error message.
532 "code": "A String", # [Output Only] The error type identifier for this error.
533 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
534 },
535 ],
536 },
537 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
538 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
539 "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.
540 }</pre>
541</div>
542
543<div class="method">
544 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
545 <pre>Retrieves the list of interconnect attachments contained within the specified region.
546
547Args:
548 project: string, Project ID for this request. (required)
549 region: string, Name of the region for this request. (required)
550 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
551
552You 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.
553
554Currently, only sorting by name or creationTimestamp desc is supported.
555 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)
556 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.
557 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 =, !=, >, or <.
558
559For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
560
561You 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.
562
563To 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).
564
565Returns:
566 An object of the form:
567
568 { # Response to the list request, and contains a list of interconnect attachments.
569 "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.
570 "kind": "compute#interconnectAttachmentList", # [Output Only] Type of resource. Always compute#interconnectAttachmentList for lists of interconnect attachments.
571 "items": [ # A list of InterconnectAttachment resources.
572 { # Represents an Interconnect Attachment (VLAN) resource.
573 #
574 # 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 beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==)
575 "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
576 "labels": { # Labels to apply to this InterconnectAttachment resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
577 "a_key": "A String",
578 },
579 "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:
580 # - BPS_50M: 50 Mbit/s
581 # - BPS_100M: 100 Mbit/s
582 # - BPS_200M: 200 Mbit/s
583 # - BPS_300M: 300 Mbit/s
584 # - BPS_400M: 400 Mbit/s
585 # - BPS_500M: 500 Mbit/s
586 # - BPS_1G: 1 Gbit/s
587 # - BPS_2G: 2 Gbit/s
588 # - BPS_5G: 5 Gbit/s
589 # - BPS_10G: 10 Gbit/s
590 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
591 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
592 "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.
593 "interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.
594 "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.
595 "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.
596 },
597 "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"
598 "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:
599 # - ACTIVE: The attachment has been turned up and is ready to use.
600 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
601 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
602 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
603 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
604 # - 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.
605 "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.
606 "partnerName": "A String", # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.
607 "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.
608 "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.
609 },
610 "type": "A String", # The type of interconnect attachment this is, which can take one of the following values:
611 # - DEDICATED: an attachment to a Dedicated Interconnect.
612 # - PARTNER: an attachment to a Partner Interconnect, created by the customer.
613 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
614 "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.
615 "description": "A String", # An optional description of this resource.
616 "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
617 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
618 #
619 # To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.
620 "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:
621 # - OS_ACTIVE: The attachment has been turned up and is ready to use.
622 # - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
623 "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
624 "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
625 "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.
626 "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.
627 "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.
628 "A String",
629 ],
630 "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:
631 # - AVAILABILITY_DOMAIN_ANY
632 # - AVAILABILITY_DOMAIN_1
633 # - 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.
634 "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 & region within which the Cloud Router is configured.
635 "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.
636 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
637 },
638 ],
639 "warning": { # [Output Only] Informational warning message.
640 "message": "A String", # [Output Only] A human-readable description of the warning code.
641 "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.
642 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
643 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
644 {
645 "value": "A String", # [Output Only] A warning data value corresponding to the key.
646 "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).
647 },
648 ],
649 },
650 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
651 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
652 }</pre>
653</div>
654
655<div class="method">
656 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
657 <pre>Retrieves the next page of results.
658
659Args:
660 previous_request: The request for the previous page. (required)
661 previous_response: The response from the request for the previous page. (required)
662
663Returns:
664 A request object that you can call 'execute()' on to request the next
665 page. Returns None if there are no more items in the collection.
666 </pre>
667</div>
668
669<div class="method">
670 <code class="details" id="patch">patch(project, region, interconnectAttachment, body, requestId=None)</code>
671 <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.
672
673Args:
674 project: string, Project ID for this request. (required)
675 region: string, Name of the region scoping this request. (required)
676 interconnectAttachment: string, Name of the interconnect attachment to patch. (required)
677 body: object, The request body. (required)
678 The object takes the form of:
679
680{ # Represents an Interconnect Attachment (VLAN) resource.
681 #
682 # 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 beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==)
683 "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
684 "labels": { # Labels to apply to this InterconnectAttachment resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
685 "a_key": "A String",
686 },
687 "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:
688 # - BPS_50M: 50 Mbit/s
689 # - BPS_100M: 100 Mbit/s
690 # - BPS_200M: 200 Mbit/s
691 # - BPS_300M: 300 Mbit/s
692 # - BPS_400M: 400 Mbit/s
693 # - BPS_500M: 500 Mbit/s
694 # - BPS_1G: 1 Gbit/s
695 # - BPS_2G: 2 Gbit/s
696 # - BPS_5G: 5 Gbit/s
697 # - BPS_10G: 10 Gbit/s
698 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
699 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
700 "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.
701 "interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.
702 "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.
703 "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.
704 },
705 "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"
706 "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:
707 # - ACTIVE: The attachment has been turned up and is ready to use.
708 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
709 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
710 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
711 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
712 # - 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.
713 "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.
714 "partnerName": "A String", # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.
715 "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.
716 "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.
717 },
718 "type": "A String", # The type of interconnect attachment this is, which can take one of the following values:
719 # - DEDICATED: an attachment to a Dedicated Interconnect.
720 # - PARTNER: an attachment to a Partner Interconnect, created by the customer.
721 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
722 "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.
723 "description": "A String", # An optional description of this resource.
724 "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
725 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
726 #
727 # To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.
728 "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:
729 # - OS_ACTIVE: The attachment has been turned up and is ready to use.
730 # - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
731 "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
732 "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
733 "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.
734 "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.
735 "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.
736 "A String",
737 ],
738 "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:
739 # - AVAILABILITY_DOMAIN_ANY
740 # - AVAILABILITY_DOMAIN_1
741 # - 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.
742 "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 & region within which the Cloud Router is configured.
743 "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.
744 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
745 }
746
747 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.
748
749For 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.
750
751The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
752
753Returns:
754 An object of the form:
755
756 { # Represents an Operation resource.
757 #
758 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
759 #
760 # Operations can be global, regional or zonal.
761 # - For global operations, use the globalOperations resource.
762 # - For regional operations, use the regionOperations resource.
763 # - For zonal operations, use the zonalOperations resource.
764 #
765 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
766 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
767 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
768 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
769 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
770 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
771 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
772 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
773 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
774 "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.
775 "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.
776 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
777 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
778 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
779 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
780 {
781 "message": "A String", # [Output Only] A human-readable description of the warning code.
782 "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.
783 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
784 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
785 {
786 "value": "A String", # [Output Only] A warning data value corresponding to the key.
787 "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).
788 },
789 ],
790 },
791 ],
792 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
793 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
794 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
795 "name": "A String", # [Output Only] Name of the resource.
796 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
797 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
798 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
799 {
800 "message": "A String", # [Output Only] An optional, human-readable error message.
801 "code": "A String", # [Output Only] The error type identifier for this error.
802 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
803 },
804 ],
805 },
806 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
807 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
808 "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.
809 }</pre>
810</div>
811
812<div class="method">
813 <code class="details" id="setLabels">setLabels(project, region, resource, body, requestId=None)</code>
814 <pre>Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation.
815
816Args:
817 project: string, Project ID for this request. (required)
818 region: string, The region for this request. (required)
819 resource: string, Name or id of the resource for this request. (required)
820 body: object, The request body. (required)
821 The object takes the form of:
822
823{
824 "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.
825 "labels": { # The labels to set for this resource.
826 "a_key": "A String",
827 },
828 }
829
830 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.
831
832For 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.
833
834The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
835
836Returns:
837 An object of the form:
838
839 { # Represents an Operation resource.
840 #
841 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
842 #
843 # Operations can be global, regional or zonal.
844 # - For global operations, use the globalOperations resource.
845 # - For regional operations, use the regionOperations resource.
846 # - For zonal operations, use the zonalOperations resource.
847 #
848 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
849 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
850 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
851 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
852 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
853 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
854 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
855 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
856 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
857 "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.
858 "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.
859 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
860 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
861 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
862 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
863 {
864 "message": "A String", # [Output Only] A human-readable description of the warning code.
865 "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.
866 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
867 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
868 {
869 "value": "A String", # [Output Only] A warning data value corresponding to the key.
870 "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).
871 },
872 ],
873 },
874 ],
875 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
876 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
877 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
878 "name": "A String", # [Output Only] Name of the resource.
879 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
880 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
881 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
882 {
883 "message": "A String", # [Output Only] An optional, human-readable error message.
884 "code": "A String", # [Output Only] The error type identifier for this error.
885 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
886 },
887 ],
888 },
889 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
890 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
891 "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.
892 }</pre>
893</div>
894
895<div class="method">
896 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
897 <pre>Returns permissions that a caller has on the specified resource.
898
899Args:
900 project: string, Project ID for this request. (required)
901 region: string, The name of the region for this request. (required)
902 resource: string, Name or id of the resource for this request. (required)
903 body: object, The request body. (required)
904 The object takes the form of:
905
906{
907 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
908 "A String",
909 ],
910 }
911
912
913Returns:
914 An object of the form:
915
916 {
917 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
918 "A String",
919 ],
920 }</pre>
921</div>
922
923</body></html>