blob: da0fdca19863aa2182631eb6810f213c50a65bd0 [file] [log] [blame]
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001<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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.interconnectAttachments.html">interconnectAttachments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None, includeAllScopes=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -040079<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 -070090 <code><a href="#getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -040091<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#insert">insert(project, region, body=None, requestId=None, validateOnly=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -040094<p class="firstline">Creates an InterconnectAttachment in the specified project using the data included in the request.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070096 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -040097<p class="firstline">Retrieves the list of interconnect attachments contained within the specified region.</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 <code><a href="#patch">patch(project, region, interconnectAttachment, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700103<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>
104<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700105 <code><a href="#setIamPolicy">setIamPolicy(project, region, resource, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700106<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
107<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700108 <code><a href="#setLabels">setLabels(project, region, resource, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700109<p class="firstline">Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation.</p>
110<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700111 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400112<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
113<h3>Method Details</h3>
114<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700115 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None, includeAllScopes=None)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400116 <pre>Retrieves an aggregated list of interconnect attachments.
117
118Args:
119 project: string, Project ID for this request. (required)
120 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
121
Dan O'Mearadd494642020-05-01 07:42:23 -0700122You 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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400123
Dan O'Mearadd494642020-05-01 07:42:23 -0700124Currently, only sorting by `name` or `creationTimestamp desc` is supported.
125 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`)
126 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.
127 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
128 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;`.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400129
Dan O'Mearadd494642020-05-01 07:42:23 -0700130For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400131
Dan O'Mearadd494642020-05-01 07:42:23 -0700132You 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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400133
Dan O'Mearadd494642020-05-01 07:42:23 -0700134To 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) ```
135 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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400136
137Returns:
138 An object of the form:
139
140 {
141 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700142 "kind": "compute#interconnectAttachmentAggregatedList", # [Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments.
143 "items": { # A list of InterconnectAttachmentsScopedList resources.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400144 "a_key": { # Name of the scope containing this set of interconnect attachments.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700145 "interconnectAttachments": [ # A list of interconnect attachments contained in this scope.
146 { # Represents an Interconnect Attachment (VLAN) resource.
147 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700148 # 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 ==)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400149 "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700150 "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700151 "a_key": "A String",
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400152 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700153 "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:
154 # - BPS_50M: 50 Mbit/s
155 # - BPS_100M: 100 Mbit/s
156 # - BPS_200M: 200 Mbit/s
157 # - BPS_300M: 300 Mbit/s
158 # - BPS_400M: 400 Mbit/s
159 # - BPS_500M: 500 Mbit/s
160 # - BPS_1G: 1 Gbit/s
161 # - BPS_2G: 2 Gbit/s
162 # - BPS_5G: 5 Gbit/s
163 # - BPS_10G: 10 Gbit/s
Dan O'Mearadd494642020-05-01 07:42:23 -0700164 # - BPS_20G: 20 Gbit/s
165 # - BPS_50G: 50 Gbit/s
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400166 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
167 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700168 "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.
169 "interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.
170 "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.
171 "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.
172 },
173 "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"
174 "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:
175 # - ACTIVE: The attachment has been turned up and is ready to use.
176 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
177 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
178 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
179 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
180 # - 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.
181 "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.
182 "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 -0700183 "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.
184 "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 -0700185 },
186 "type": "A String", # The type of interconnect attachment this is, which can take one of the following values:
187 # - DEDICATED: an attachment to a Dedicated Interconnect.
188 # - PARTNER: an attachment to a Partner Interconnect, created by the customer.
189 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
190 "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.
191 "description": "A String", # An optional description of this resource.
192 "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
193 "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.
194 #
195 # To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.
196 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
197 "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:
198 # - OS_ACTIVE: The attachment has been turned up and is ready to use.
199 # - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
200 "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
201 "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
202 "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.
203 "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 -0700204 "mtu": 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.
205 "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 -0700206 "A String",
207 ],
208 "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:
209 # - AVAILABILITY_DOMAIN_ANY
210 # - AVAILABILITY_DOMAIN_1
211 # - 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 -0700212 "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 -0700213 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400214 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400215 },
216 ],
217 "warning": { # Informational warning which replaces the list of addresses when the list is empty.
218 "message": "A String", # [Output Only] A human-readable description of the warning code.
219 "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.
220 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
221 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
222 {
223 "value": "A String", # [Output Only] A warning data value corresponding to the key.
224 "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).
225 },
226 ],
227 },
228 },
229 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700230 "warning": { # [Output Only] Informational warning message.
231 "message": "A String", # [Output Only] A human-readable description of the warning code.
232 "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.
233 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
234 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
235 {
236 "value": "A String", # [Output Only] A warning data value corresponding to the key.
237 "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).
238 },
239 ],
240 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700241 "unreachables": [ # [Output Only] Unreachable resources.
242 "A String",
243 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700244 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400245 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
246 }</pre>
247</div>
248
249<div class="method">
250 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
251 <pre>Retrieves the next page of results.
252
253Args:
254 previous_request: The request for the previous page. (required)
255 previous_response: The response from the request for the previous page. (required)
256
257Returns:
258 A request object that you can call 'execute()' on to request the next
259 page. Returns None if there are no more items in the collection.
260 </pre>
261</div>
262
263<div class="method">
264 <code class="details" id="delete">delete(project, region, interconnectAttachment, requestId=None)</code>
265 <pre>Deletes the specified interconnect attachment.
266
267Args:
268 project: string, Project ID for this request. (required)
269 region: string, Name of the region for this request. (required)
270 interconnectAttachment: string, Name of the interconnect attachment to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700271 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.
272
273For 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.
274
275The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400276
277Returns:
278 An object of the form:
279
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700280 { # Represents an Operation resource.
281 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700282 # Google Compute Engine has three Operation resources:
283 #
284 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
285 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700286 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
287 #
288 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700289 # - For global operations, use the `globalOperations` resource.
290 # - For regional operations, use the `regionOperations` resource.
291 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700292 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700293 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400294 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700295 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400296 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700297 "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 -0700298 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400299 "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 -0700300 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
301 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400302 "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 -0700303 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400304 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700305 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400306 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
307 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
308 {
309 "message": "A String", # [Output Only] A human-readable description of the warning code.
310 "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.
311 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
312 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
313 {
314 "value": "A String", # [Output Only] A warning data value corresponding to the key.
315 "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).
316 },
317 ],
318 },
319 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700320 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700321 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400322 "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 -0700323 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
324 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700325 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400326 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
327 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
328 {
329 "message": "A String", # [Output Only] An optional, human-readable error message.
330 "code": "A String", # [Output Only] The error type identifier for this error.
331 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
332 },
333 ],
334 },
335 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
336 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
337 "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.
338 }</pre>
339</div>
340
341<div class="method">
342 <code class="details" id="get">get(project, region, interconnectAttachment)</code>
343 <pre>Returns the specified interconnect attachment.
344
345Args:
346 project: string, Project ID for this request. (required)
347 region: string, Name of the region for this request. (required)
348 interconnectAttachment: string, Name of the interconnect attachment to return. (required)
349
350Returns:
351 An object of the form:
352
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700353 { # Represents an Interconnect Attachment (VLAN) resource.
354 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700355 # 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 ==)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400356 "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700357 "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700358 "a_key": "A String",
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400359 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700360 "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:
361 # - BPS_50M: 50 Mbit/s
362 # - BPS_100M: 100 Mbit/s
363 # - BPS_200M: 200 Mbit/s
364 # - BPS_300M: 300 Mbit/s
365 # - BPS_400M: 400 Mbit/s
366 # - BPS_500M: 500 Mbit/s
367 # - BPS_1G: 1 Gbit/s
368 # - BPS_2G: 2 Gbit/s
369 # - BPS_5G: 5 Gbit/s
370 # - BPS_10G: 10 Gbit/s
Dan O'Mearadd494642020-05-01 07:42:23 -0700371 # - BPS_20G: 20 Gbit/s
372 # - BPS_50G: 50 Gbit/s
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400373 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
374 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700375 "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.
376 "interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.
377 "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.
378 "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.
379 },
380 "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"
381 "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:
382 # - ACTIVE: The attachment has been turned up and is ready to use.
383 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
384 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
385 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
386 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
387 # - 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.
388 "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.
389 "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 -0700390 "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.
391 "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 -0700392 },
393 "type": "A String", # The type of interconnect attachment this is, which can take one of the following values:
394 # - DEDICATED: an attachment to a Dedicated Interconnect.
395 # - PARTNER: an attachment to a Partner Interconnect, created by the customer.
396 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
397 "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.
398 "description": "A String", # An optional description of this resource.
399 "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
400 "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.
401 #
402 # To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.
403 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
404 "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:
405 # - OS_ACTIVE: The attachment has been turned up and is ready to use.
406 # - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
407 "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
408 "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
409 "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.
410 "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 -0700411 "mtu": 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.
412 "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 -0700413 "A String",
414 ],
415 "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:
416 # - AVAILABILITY_DOMAIN_ANY
417 # - AVAILABILITY_DOMAIN_1
418 # - 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 -0700419 "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 -0700420 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400421 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400422 }</pre>
423</div>
424
425<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700426 <code class="details" id="getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400427 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.
428
429Args:
430 project: string, Project ID for this request. (required)
431 region: string, The name of the region for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700432 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700433 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400434
435Returns:
436 An object of the form:
437
Dan O'Mearadd494642020-05-01 07:42:23 -0700438 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400439 #
440 #
441 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700442 # A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400443 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700444 # Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400445 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700446 # **JSON example:**
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400447 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700448 # { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700449 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700450 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700451 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700452 # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700453 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700454 # For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400455 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
456 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.
457 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700458 # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400459 #
460 # Example Policy with multiple AuditConfigs:
461 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700462 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400463 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700464 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400465 "exemptedMembers": [
466 "A String",
467 ],
468 "auditLogConfigs": [ # The configuration for logging of each type of permission.
469 { # Provides the configuration for logging a type of permissions. Example:
470 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700471 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400472 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700473 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400474 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].
475 "A String",
476 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700477 "ignoreChildExemptions": True or False,
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400478 "logType": "A String", # The log type that this config enables.
479 },
480 ],
481 "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
482 },
483 ],
484 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
485 { # A rule to be applied in a Policy.
486 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
487 { # Specifies what kind of log the caller must write
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700488 "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.
489 #
490 # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.
491 #
492 # Field names correspond to IAM request parameters and field values are their respective values.
493 #
494 # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.
495 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700496 # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==&gt; increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400497 "field": "A String", # The field value to attribute.
Dan O'Mearadd494642020-05-01 07:42:23 -0700498 "customFields": [ # Custom fields.
499 { # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.
500 "name": "A String", # Name is the field name.
501 "value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.
502 },
503 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400504 "metric": "A String", # The metric to update.
505 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700506 "dataAccess": { # Write a Data Access (Gin) log # Data access options.
Dan O'Mearadd494642020-05-01 07:42:23 -0700507 "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is currently supported in the LocalIAM implementation, Stubby C++, and Stubby Java. For Apps Framework, see go/af-audit-logging#failclosed. TODO(b/77591626): Add support for Stubby Go. TODO(b/129671387): Add support for Scaffolding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700508 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400509 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
510 "logName": "A String", # The log_name to populate in the Cloud Audit Record.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700511 "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.
512 "permissionType": "A String", # The type of the permission that was checked.
513 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400514 },
515 },
516 ],
517 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
518 "A String",
519 ],
520 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
521 "A String",
522 ],
523 "action": "A String", # Required
524 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
525 "A String",
526 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700527 "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400528 { # A condition to be met.
529 "iam": "A String", # Trusted attributes supplied by the IAM system.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400530 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700531 "values": [ # The objects of the condition.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400532 "A String",
533 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700534 "svc": "A String", # Trusted attributes discharged by the service.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400535 "op": "A String", # An operator to apply the subject with.
536 },
537 ],
538 "description": "A String", # Human-readable description of the rule.
539 },
540 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700541 "version": 42, # Specifies the format of the policy.
542 #
543 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.
544 #
545 # Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:
546 #
547 # * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions
548 #
549 # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
550 #
551 # If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400552 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
553 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700554 # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
555 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400556 { # Associates `members` with a `role`.
557 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
558 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
559 #
560 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
561 #
562 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
563 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700564 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400565 #
566 #
567 #
568 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
569 #
570 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
571 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700572 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.
573 #
574 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.
575 #
576 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.
577 #
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400578 #
579 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700580 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400581 "A String",
582 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700583 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700584 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700585 # Example (Comparison):
586 #
587 # title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() &lt; 100"
588 #
589 # Example (Equality):
590 #
591 # title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"
592 #
593 # Example (Logic):
594 #
595 # title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
596 #
597 # Example (Data Manipulation):
598 #
599 # title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"
600 #
601 # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
602 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700603 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
Dan O'Mearadd494642020-05-01 07:42:23 -0700604 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
605 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700606 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400607 },
608 ],
609 "iamOwned": True or False,
610 }</pre>
611</div>
612
613<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700614 <code class="details" id="insert">insert(project, region, body=None, requestId=None, validateOnly=None)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400615 <pre>Creates an InterconnectAttachment in the specified project using the data included in the request.
616
617Args:
618 project: string, Project ID for this request. (required)
619 region: string, Name of the region for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700620 body: object, The request body.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400621 The object takes the form of:
622
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700623{ # Represents an Interconnect Attachment (VLAN) resource.
624 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700625 # 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 ==)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400626 "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700627 "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700628 "a_key": "A String",
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400629 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700630 "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:
631 # - BPS_50M: 50 Mbit/s
632 # - BPS_100M: 100 Mbit/s
633 # - BPS_200M: 200 Mbit/s
634 # - BPS_300M: 300 Mbit/s
635 # - BPS_400M: 400 Mbit/s
636 # - BPS_500M: 500 Mbit/s
637 # - BPS_1G: 1 Gbit/s
638 # - BPS_2G: 2 Gbit/s
639 # - BPS_5G: 5 Gbit/s
640 # - BPS_10G: 10 Gbit/s
Dan O'Mearadd494642020-05-01 07:42:23 -0700641 # - BPS_20G: 20 Gbit/s
642 # - BPS_50G: 50 Gbit/s
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400643 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
644 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700645 "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.
646 "interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.
647 "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.
648 "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.
649 },
650 "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"
651 "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:
652 # - ACTIVE: The attachment has been turned up and is ready to use.
653 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
654 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
655 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
656 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
657 # - 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.
658 "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.
659 "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 -0700660 "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.
661 "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 -0700662 },
663 "type": "A String", # The type of interconnect attachment this is, which can take one of the following values:
664 # - DEDICATED: an attachment to a Dedicated Interconnect.
665 # - PARTNER: an attachment to a Partner Interconnect, created by the customer.
666 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
667 "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.
668 "description": "A String", # An optional description of this resource.
669 "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
670 "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.
671 #
672 # To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.
673 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
674 "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:
675 # - OS_ACTIVE: The attachment has been turned up and is ready to use.
676 # - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
677 "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
678 "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
679 "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.
680 "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 -0700681 "mtu": 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.
682 "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 -0700683 "A String",
684 ],
685 "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:
686 # - AVAILABILITY_DOMAIN_ANY
687 # - AVAILABILITY_DOMAIN_1
688 # - 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 -0700689 "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 -0700690 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400691 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400692 }
693
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700694 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.
695
696For 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.
697
698The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
699 validateOnly: boolean, If true, the request will not be committed.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400700
701Returns:
702 An object of the form:
703
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700704 { # Represents an Operation resource.
705 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700706 # Google Compute Engine has three Operation resources:
707 #
708 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
709 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700710 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
711 #
712 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700713 # - For global operations, use the `globalOperations` resource.
714 # - For regional operations, use the `regionOperations` resource.
715 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700716 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700717 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400718 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700719 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400720 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700721 "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 -0700722 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400723 "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 -0700724 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
725 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400726 "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 -0700727 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400728 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700729 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400730 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
731 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
732 {
733 "message": "A String", # [Output Only] A human-readable description of the warning code.
734 "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.
735 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
736 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
737 {
738 "value": "A String", # [Output Only] A warning data value corresponding to the key.
739 "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).
740 },
741 ],
742 },
743 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700744 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700745 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400746 "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 -0700747 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
748 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700749 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400750 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
751 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
752 {
753 "message": "A String", # [Output Only] An optional, human-readable error message.
754 "code": "A String", # [Output Only] The error type identifier for this error.
755 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
756 },
757 ],
758 },
759 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
760 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
761 "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.
762 }</pre>
763</div>
764
765<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700766 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400767 <pre>Retrieves the list of interconnect attachments contained within the specified region.
768
769Args:
770 project: string, Project ID for this request. (required)
771 region: string, Name of the region for this request. (required)
772 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
773
Dan O'Mearadd494642020-05-01 07:42:23 -0700774You 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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400775
Dan O'Mearadd494642020-05-01 07:42:23 -0700776Currently, only sorting by `name` or `creationTimestamp desc` is supported.
777 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`)
778 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.
779 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
780 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;`.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400781
Dan O'Mearadd494642020-05-01 07:42:23 -0700782For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400783
Dan O'Mearadd494642020-05-01 07:42:23 -0700784You 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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400785
Dan O'Mearadd494642020-05-01 07:42:23 -0700786To 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) ```
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400787
788Returns:
789 An object of the form:
790
791 { # Response to the list request, and contains a list of interconnect attachments.
792 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700793 "kind": "compute#interconnectAttachmentList", # [Output Only] Type of resource. Always compute#interconnectAttachmentList for lists of interconnect attachments.
794 "items": [ # A list of InterconnectAttachment resources.
795 { # Represents an Interconnect Attachment (VLAN) resource.
796 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700797 # 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 ==)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400798 "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700799 "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700800 "a_key": "A String",
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400801 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700802 "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:
803 # - BPS_50M: 50 Mbit/s
804 # - BPS_100M: 100 Mbit/s
805 # - BPS_200M: 200 Mbit/s
806 # - BPS_300M: 300 Mbit/s
807 # - BPS_400M: 400 Mbit/s
808 # - BPS_500M: 500 Mbit/s
809 # - BPS_1G: 1 Gbit/s
810 # - BPS_2G: 2 Gbit/s
811 # - BPS_5G: 5 Gbit/s
812 # - BPS_10G: 10 Gbit/s
Dan O'Mearadd494642020-05-01 07:42:23 -0700813 # - BPS_20G: 20 Gbit/s
814 # - BPS_50G: 50 Gbit/s
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400815 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
816 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700817 "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.
818 "interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.
819 "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.
820 "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.
821 },
822 "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"
823 "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:
824 # - ACTIVE: The attachment has been turned up and is ready to use.
825 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
826 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
827 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
828 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
829 # - 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.
830 "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.
831 "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 -0700832 "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.
833 "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 -0700834 },
835 "type": "A String", # The type of interconnect attachment this is, which can take one of the following values:
836 # - DEDICATED: an attachment to a Dedicated Interconnect.
837 # - PARTNER: an attachment to a Partner Interconnect, created by the customer.
838 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
839 "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.
840 "description": "A String", # An optional description of this resource.
841 "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
842 "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.
843 #
844 # To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.
845 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
846 "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:
847 # - OS_ACTIVE: The attachment has been turned up and is ready to use.
848 # - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
849 "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
850 "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
851 "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.
852 "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 -0700853 "mtu": 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.
854 "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 -0700855 "A String",
856 ],
857 "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:
858 # - AVAILABILITY_DOMAIN_ANY
859 # - AVAILABILITY_DOMAIN_1
860 # - 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 -0700861 "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 -0700862 "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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400863 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400864 },
865 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700866 "warning": { # [Output Only] Informational warning message.
867 "message": "A String", # [Output Only] A human-readable description of the warning code.
868 "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.
869 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
870 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
871 {
872 "value": "A String", # [Output Only] A warning data value corresponding to the key.
873 "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).
874 },
875 ],
876 },
877 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400878 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
879 }</pre>
880</div>
881
882<div class="method">
883 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
884 <pre>Retrieves the next page of results.
885
886Args:
887 previous_request: The request for the previous page. (required)
888 previous_response: The response from the request for the previous page. (required)
889
890Returns:
891 A request object that you can call 'execute()' on to request the next
892 page. Returns None if there are no more items in the collection.
893 </pre>
894</div>
895
896<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700897 <code class="details" id="patch">patch(project, region, interconnectAttachment, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700898 <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.
899
900Args:
901 project: string, Project ID for this request. (required)
902 region: string, Name of the region scoping this request. (required)
903 interconnectAttachment: string, Name of the interconnect attachment to patch. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700904 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700905 The object takes the form of:
906
907{ # Represents an Interconnect Attachment (VLAN) resource.
908 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700909 # 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 -0700910 "customerRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
Dan O'Mearadd494642020-05-01 07:42:23 -0700911 "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700912 "a_key": "A String",
913 },
914 "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:
915 # - BPS_50M: 50 Mbit/s
916 # - BPS_100M: 100 Mbit/s
917 # - BPS_200M: 200 Mbit/s
918 # - BPS_300M: 300 Mbit/s
919 # - BPS_400M: 400 Mbit/s
920 # - BPS_500M: 500 Mbit/s
921 # - BPS_1G: 1 Gbit/s
922 # - BPS_2G: 2 Gbit/s
923 # - BPS_5G: 5 Gbit/s
924 # - BPS_10G: 10 Gbit/s
Dan O'Mearadd494642020-05-01 07:42:23 -0700925 # - BPS_20G: 20 Gbit/s
926 # - BPS_50G: 50 Gbit/s
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700927 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
928 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
929 "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.
930 "interconnect": "A String", # URL of the underlying Interconnect object that this attachment's traffic will traverse through.
931 "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.
932 "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.
933 },
934 "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"
935 "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:
936 # - ACTIVE: The attachment has been turned up and is ready to use.
937 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
938 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
939 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
940 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
941 # - 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.
942 "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.
943 "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 -0700944 "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.
945 "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 -0700946 },
947 "type": "A String", # The type of interconnect attachment this is, which can take one of the following values:
948 # - DEDICATED: an attachment to a Dedicated Interconnect.
949 # - PARTNER: an attachment to a Partner Interconnect, created by the customer.
950 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
951 "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.
952 "description": "A String", # An optional description of this resource.
953 "adminEnabled": True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
954 "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.
955 #
956 # To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.
957 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
958 "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:
959 # - OS_ACTIVE: The attachment has been turned up and is ready to use.
960 # - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
961 "cloudRouterIpAddress": "A String", # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
962 "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
963 "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.
964 "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 -0700965 "mtu": 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.
966 "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 -0700967 "A String",
968 ],
969 "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:
970 # - AVAILABILITY_DOMAIN_ANY
971 # - AVAILABILITY_DOMAIN_1
972 # - 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 -0700973 "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 -0700974 "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.
975 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
976 }
977
978 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.
979
980For 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.
981
982The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
983
984Returns:
985 An object of the form:
986
987 { # Represents an Operation resource.
988 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700989 # Google Compute Engine has three Operation resources:
990 #
991 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
992 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700993 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
994 #
995 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700996 # - For global operations, use the `globalOperations` resource.
997 # - For regional operations, use the `regionOperations` resource.
998 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700999 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001000 # 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 -07001001 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1002 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
1003 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -07001004 "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 -07001005 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
1006 "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 -07001007 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
1008 "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 -07001009 "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 -07001010 "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 -07001011 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -07001012 "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 -07001013 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
1014 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1015 {
1016 "message": "A String", # [Output Only] A human-readable description of the warning code.
1017 "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.
1018 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1019 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
1020 {
1021 "value": "A String", # [Output Only] A warning data value corresponding to the key.
1022 "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).
1023 },
1024 ],
1025 },
1026 ],
1027 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -07001028 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001029 "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 -07001030 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
1031 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001032 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
1033 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1034 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
1035 {
1036 "message": "A String", # [Output Only] An optional, human-readable error message.
1037 "code": "A String", # [Output Only] The error type identifier for this error.
1038 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1039 },
1040 ],
1041 },
1042 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1043 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
1044 "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.
1045 }</pre>
1046</div>
1047
1048<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07001049 <code class="details" id="setIamPolicy">setIamPolicy(project, region, resource, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001050 <pre>Sets the access control policy on the specified resource. Replaces any existing policy.
1051
1052Args:
1053 project: string, Project ID for this request. (required)
1054 region: string, The name of the region for this request. (required)
1055 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07001056 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001057 The object takes the form of:
1058
1059{
Dan O'Mearadd494642020-05-01 07:42:23 -07001060 "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001061 #
1062 #
1063 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001064 # A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001065 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001066 # Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001067 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001068 # **JSON example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001069 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001070 # { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001071 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001072 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001073 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001074 # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001075 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001076 # For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001077 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
1078 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.
1079 #
1080 # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.
1081 #
1082 # Example Policy with multiple AuditConfigs:
1083 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001084 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001085 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001086 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001087 "exemptedMembers": [
1088 "A String",
1089 ],
1090 "auditLogConfigs": [ # The configuration for logging of each type of permission.
1091 { # Provides the configuration for logging a type of permissions. Example:
1092 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001093 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001094 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001095 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001096 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].
1097 "A String",
1098 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001099 "ignoreChildExemptions": True or False,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001100 "logType": "A String", # The log type that this config enables.
1101 },
1102 ],
1103 "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
1104 },
1105 ],
1106 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
1107 { # A rule to be applied in a Policy.
1108 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
1109 { # Specifies what kind of log the caller must write
1110 "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.
1111 #
1112 # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.
1113 #
1114 # Field names correspond to IAM request parameters and field values are their respective values.
1115 #
1116 # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.
1117 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001118 # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==&gt; increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001119 "field": "A String", # The field value to attribute.
Dan O'Mearadd494642020-05-01 07:42:23 -07001120 "customFields": [ # Custom fields.
1121 { # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.
1122 "name": "A String", # Name is the field name.
1123 "value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.
1124 },
1125 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001126 "metric": "A String", # The metric to update.
1127 },
1128 "dataAccess": { # Write a Data Access (Gin) log # Data access options.
Dan O'Mearadd494642020-05-01 07:42:23 -07001129 "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is currently supported in the LocalIAM implementation, Stubby C++, and Stubby Java. For Apps Framework, see go/af-audit-logging#failclosed. TODO(b/77591626): Add support for Stubby Go. TODO(b/129671387): Add support for Scaffolding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001130 },
1131 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
1132 "logName": "A String", # The log_name to populate in the Cloud Audit Record.
1133 "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.
1134 "permissionType": "A String", # The type of the permission that was checked.
1135 },
1136 },
1137 },
1138 ],
1139 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
1140 "A String",
1141 ],
1142 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
1143 "A String",
1144 ],
1145 "action": "A String", # Required
1146 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
1147 "A String",
1148 ],
1149 "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.
1150 { # A condition to be met.
1151 "iam": "A String", # Trusted attributes supplied by the IAM system.
1152 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
1153 "values": [ # The objects of the condition.
1154 "A String",
1155 ],
1156 "svc": "A String", # Trusted attributes discharged by the service.
1157 "op": "A String", # An operator to apply the subject with.
1158 },
1159 ],
1160 "description": "A String", # Human-readable description of the rule.
1161 },
1162 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001163 "version": 42, # Specifies the format of the policy.
1164 #
1165 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.
1166 #
1167 # Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:
1168 #
1169 # * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions
1170 #
1171 # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
1172 #
1173 # If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001174 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
1175 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001176 # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
1177 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001178 { # Associates `members` with a `role`.
1179 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1180 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
1181 #
1182 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
1183 #
1184 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
1185 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001186 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001187 #
1188 #
1189 #
1190 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
1191 #
1192 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
1193 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001194 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.
1195 #
1196 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.
1197 #
1198 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.
1199 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001200 #
1201 #
1202 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
1203 "A String",
1204 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001205 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001206 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001207 # Example (Comparison):
1208 #
1209 # title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() &lt; 100"
1210 #
1211 # Example (Equality):
1212 #
1213 # title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"
1214 #
1215 # Example (Logic):
1216 #
1217 # title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
1218 #
1219 # Example (Data Manipulation):
1220 #
1221 # title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"
1222 #
1223 # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
1224 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001225 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
Dan O'Mearadd494642020-05-01 07:42:23 -07001226 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
1227 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001228 },
1229 },
1230 ],
1231 "iamOwned": True or False,
1232 },
1233 "bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.
1234 { # Associates `members` with a `role`.
1235 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1236 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
1237 #
1238 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
1239 #
1240 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
1241 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001242 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001243 #
1244 #
1245 #
1246 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
1247 #
1248 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
1249 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001250 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.
1251 #
1252 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.
1253 #
1254 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.
1255 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001256 #
1257 #
1258 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
1259 "A String",
1260 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001261 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001262 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001263 # Example (Comparison):
1264 #
1265 # title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() &lt; 100"
1266 #
1267 # Example (Equality):
1268 #
1269 # title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"
1270 #
1271 # Example (Logic):
1272 #
1273 # title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
1274 #
1275 # Example (Data Manipulation):
1276 #
1277 # title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"
1278 #
1279 # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
1280 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001281 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
Dan O'Mearadd494642020-05-01 07:42:23 -07001282 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
1283 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001284 },
1285 },
1286 ],
1287 "etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.
1288 }
1289
1290
1291Returns:
1292 An object of the form:
1293
Dan O'Mearadd494642020-05-01 07:42:23 -07001294 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001295 #
1296 #
1297 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001298 # A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001299 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001300 # Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001301 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001302 # **JSON example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001303 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001304 # { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001305 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001306 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001307 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001308 # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001309 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001310 # For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001311 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
1312 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.
1313 #
1314 # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.
1315 #
1316 # Example Policy with multiple AuditConfigs:
1317 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001318 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001319 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001320 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001321 "exemptedMembers": [
1322 "A String",
1323 ],
1324 "auditLogConfigs": [ # The configuration for logging of each type of permission.
1325 { # Provides the configuration for logging a type of permissions. Example:
1326 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001327 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001328 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001329 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001330 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].
1331 "A String",
1332 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001333 "ignoreChildExemptions": True or False,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001334 "logType": "A String", # The log type that this config enables.
1335 },
1336 ],
1337 "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
1338 },
1339 ],
1340 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
1341 { # A rule to be applied in a Policy.
1342 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
1343 { # Specifies what kind of log the caller must write
1344 "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.
1345 #
1346 # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.
1347 #
1348 # Field names correspond to IAM request parameters and field values are their respective values.
1349 #
1350 # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.
1351 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001352 # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==&gt; increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001353 "field": "A String", # The field value to attribute.
Dan O'Mearadd494642020-05-01 07:42:23 -07001354 "customFields": [ # Custom fields.
1355 { # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.
1356 "name": "A String", # Name is the field name.
1357 "value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.
1358 },
1359 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001360 "metric": "A String", # The metric to update.
1361 },
1362 "dataAccess": { # Write a Data Access (Gin) log # Data access options.
Dan O'Mearadd494642020-05-01 07:42:23 -07001363 "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is currently supported in the LocalIAM implementation, Stubby C++, and Stubby Java. For Apps Framework, see go/af-audit-logging#failclosed. TODO(b/77591626): Add support for Stubby Go. TODO(b/129671387): Add support for Scaffolding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001364 },
1365 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
1366 "logName": "A String", # The log_name to populate in the Cloud Audit Record.
1367 "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.
1368 "permissionType": "A String", # The type of the permission that was checked.
1369 },
1370 },
1371 },
1372 ],
1373 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
1374 "A String",
1375 ],
1376 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
1377 "A String",
1378 ],
1379 "action": "A String", # Required
1380 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
1381 "A String",
1382 ],
1383 "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.
1384 { # A condition to be met.
1385 "iam": "A String", # Trusted attributes supplied by the IAM system.
1386 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
1387 "values": [ # The objects of the condition.
1388 "A String",
1389 ],
1390 "svc": "A String", # Trusted attributes discharged by the service.
1391 "op": "A String", # An operator to apply the subject with.
1392 },
1393 ],
1394 "description": "A String", # Human-readable description of the rule.
1395 },
1396 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001397 "version": 42, # Specifies the format of the policy.
1398 #
1399 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.
1400 #
1401 # Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:
1402 #
1403 # * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions
1404 #
1405 # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
1406 #
1407 # If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001408 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.
1409 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001410 # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
1411 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001412 { # Associates `members` with a `role`.
1413 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1414 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
1415 #
1416 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
1417 #
1418 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
1419 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001420 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001421 #
1422 #
1423 #
1424 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
1425 #
1426 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
1427 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001428 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.
1429 #
1430 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.
1431 #
1432 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.
1433 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001434 #
1435 #
1436 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
1437 "A String",
1438 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001439 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001440 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001441 # Example (Comparison):
1442 #
1443 # title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() &lt; 100"
1444 #
1445 # Example (Equality):
1446 #
1447 # title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"
1448 #
1449 # Example (Logic):
1450 #
1451 # title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
1452 #
1453 # Example (Data Manipulation):
1454 #
1455 # title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"
1456 #
1457 # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
1458 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001459 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
Dan O'Mearadd494642020-05-01 07:42:23 -07001460 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
1461 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001462 },
1463 },
1464 ],
1465 "iamOwned": True or False,
1466 }</pre>
1467</div>
1468
1469<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07001470 <code class="details" id="setLabels">setLabels(project, region, resource, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001471 <pre>Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation.
1472
1473Args:
1474 project: string, Project ID for this request. (required)
1475 region: string, The region for this request. (required)
1476 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07001477 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001478 The object takes the form of:
1479
1480{
1481 "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.
1482 "labels": { # The labels to set for this resource.
1483 "a_key": "A String",
1484 },
1485 }
1486
1487 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.
1488
1489For 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.
1490
1491The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1492
1493Returns:
1494 An object of the form:
1495
1496 { # Represents an Operation resource.
1497 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001498 # Google Compute Engine has three Operation resources:
1499 #
1500 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
1501 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001502 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
1503 #
1504 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -07001505 # - For global operations, use the `globalOperations` resource.
1506 # - For regional operations, use the `regionOperations` resource.
1507 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001508 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001509 # 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 -07001510 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1511 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
1512 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -07001513 "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 -07001514 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
1515 "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 -07001516 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
1517 "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 -07001518 "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 -07001519 "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 -07001520 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -07001521 "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 -07001522 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
1523 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1524 {
1525 "message": "A String", # [Output Only] A human-readable description of the warning code.
1526 "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.
1527 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1528 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
1529 {
1530 "value": "A String", # [Output Only] A warning data value corresponding to the key.
1531 "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).
1532 },
1533 ],
1534 },
1535 ],
1536 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -07001537 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001538 "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 -07001539 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
1540 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001541 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
1542 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1543 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
1544 {
1545 "message": "A String", # [Output Only] An optional, human-readable error message.
1546 "code": "A String", # [Output Only] The error type identifier for this error.
1547 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1548 },
1549 ],
1550 },
1551 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1552 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
1553 "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.
1554 }</pre>
1555</div>
1556
1557<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07001558 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001559 <pre>Returns permissions that a caller has on the specified resource.
1560
1561Args:
1562 project: string, Project ID for this request. (required)
1563 region: string, The name of the region for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001564 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07001565 body: object, The request body.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -04001566 The object takes the form of:
1567
1568{
1569 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
1570 "A String",
1571 ],
1572 }
1573
1574
1575Returns:
1576 An object of the form:
1577
1578 {
1579 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
1580 "A String",
1581 ],
1582 }</pre>
1583</div>
1584
1585</body></html>