1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.interconnects.html">interconnects</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(project, interconnect, requestId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes the specified interconnect.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(project, interconnect, x__xgafv=None)</a></code></p> 85<p class="firstline">Returns the specified interconnect. Get a list of available interconnects by making a list() request.</p> 86<p class="toc_element"> 87 <code><a href="#getDiagnostics">getDiagnostics(project, interconnect, x__xgafv=None)</a></code></p> 88<p class="firstline">Returns the interconnectDiagnostics for the specified interconnect.</p> 89<p class="toc_element"> 90 <code><a href="#getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p> 91<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"> 93 <code><a href="#getMacsecConfig">getMacsecConfig(project, interconnect, x__xgafv=None)</a></code></p> 94<p class="firstline">Returns the interconnectMacsecConfig for the specified interconnect.</p> 95<p class="toc_element"> 96 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Creates a Interconnect in the specified project using the data included in the request.</p> 98<p class="toc_element"> 99 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Retrieves the list of interconnect available to the specified project.</p> 101<p class="toc_element"> 102 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 103<p class="firstline">Retrieves the next page of results.</p> 104<p class="toc_element"> 105 <code><a href="#patch">patch(project, interconnect, body=None, requestId=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p> 107<p class="toc_element"> 108 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</a></code></p> 109<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p> 110<p class="toc_element"> 111 <code><a href="#setLabels">setLabels(project, resource, body=None, x__xgafv=None)</a></code></p> 112<p class="firstline">Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation.</p> 113<p class="toc_element"> 114 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p> 115<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 116<h3>Method Details</h3> 117<div class="method"> 118 <code class="details" id="close">close()</code> 119 <pre>Close httplib2 connections.</pre> 120</div> 121 122<div class="method"> 123 <code class="details" id="delete">delete(project, interconnect, requestId=None, x__xgafv=None)</code> 124 <pre>Deletes the specified interconnect. 125 126Args: 127 project: string, Project ID for this request. (required) 128 interconnect: string, Name of the interconnect to delete. (required) 129 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. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 130 x__xgafv: string, V1 error format. 131 Allowed values 132 1 - v1 error format 133 2 - v2 error format 134 135Returns: 136 An object of the form: 137 138 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 139 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 140 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 141 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 142 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 143 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 144 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 145 { 146 "code": "A String", # [Output Only] The error type identifier for this error. 147 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 148 "message": "A String", # [Output Only] An optional, human-readable error message. 149 }, 150 ], 151 }, 152 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 153 "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. 154 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 155 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 156 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 157 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 158 "a_key": "", # Properties of the object. Contains field @type with type URL. 159 }, 160 "name": "A String", # [Output Only] Name of the operation. 161 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 162 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 163 "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. 164 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 165 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 166 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 167 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 168 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 169 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 170 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 171 "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. 172 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 173 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 174 { 175 "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. 176 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 177 { 178 "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). 179 "value": "A String", # [Output Only] A warning data value corresponding to the key. 180 }, 181 ], 182 "message": "A String", # [Output Only] A human-readable description of the warning code. 183 }, 184 ], 185 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 186}</pre> 187</div> 188 189<div class="method"> 190 <code class="details" id="get">get(project, interconnect, x__xgafv=None)</code> 191 <pre>Returns the specified interconnect. Get a list of available interconnects by making a list() request. 192 193Args: 194 project: string, Project ID for this request. (required) 195 interconnect: string, Name of the interconnect to return. (required) 196 x__xgafv: string, V1 error format. 197 Allowed values 198 1 - v1 error format 199 2 - v2 error format 200 201Returns: 202 An object of the form: 203 204 { # Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. 205 "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. 206 "circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. 207 { # Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. 208 "customerDemarcId": "A String", # Customer-side demarc ID for this circuit. 209 "googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up. 210 "googleDemarcId": "A String", # Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA. 211 }, 212 ], 213 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 214 "customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. 215 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 216 "expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect. 217 { # Description of a planned outage on this Interconnect. 218 "affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected. 219 "A String", 220 ], 221 "description": "A String", # A description about the purpose of the outage. 222 "endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch). 223 "issueType": "A String", # Form this outage is expected to take, which can take one of the following values: - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values. 224 "name": "A String", # Unique identifier for this outage notification. 225 "source": "A String", # The party that generated this notification, which can take the following value: - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. 226 "startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch). 227 "state": "A String", # State of this notification, which can take one of the following values: - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. - COMPLETED: The outage associated with this notification is complete. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values. 228 }, 229 ], 230 "googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. 231 "googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. 232 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 233 "interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. 234 "A String", 235 ], 236 "interconnectType": "A String", # Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. 237 "kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects. 238 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Interconnect, 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. To see the latest fingerprint, make a get() request to retrieve an Interconnect. 239 "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. 240 "a_key": "A String", 241 }, 242 "linkType": "A String", # Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. 243 "location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned. 244 "macsec": { # Configuration information for enabling Media Access Control security (Macsec) on this Interconnect between Google and your on-premises router. # Configuration to enable Media Access Control security (MACsec) on the Interconnect between Google and your on-premises router. 245 "failOpen": True or False, # If set to true, the Interconnect will be configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect will be configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router. 246 "preSharedKeys": [ # Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK will be generated for each key in the key chain. Google router will automatically pick the key with the most recent startTime when establishing or re-establishing a MACsec secure link. 247 { # Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode. 248 "name": "A String", # Required. A name for this pre-shared key. 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. 249 "startTime": "A String", # A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart. 250 }, 251 ], 252 }, 253 "macsecEnabled": True or False, # Enable or disable MACsec on this Interconnect. MACsec enablement will fail if the macsec object is not specified. 254 "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. 255 "nocContactEmail": "A String", # Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications. 256 "operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. 257 "peerIpAddress": "A String", # [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests. 258 "provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect. 259 "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer. 260 "satisfiesPzs": True or False, # [Output Only] Set to true if the resource satisfies the zone separation organization policy constraints and false otherwise. Defaults to false if the field is not present. 261 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 262 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 263 "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. 264}</pre> 265</div> 266 267<div class="method"> 268 <code class="details" id="getDiagnostics">getDiagnostics(project, interconnect, x__xgafv=None)</code> 269 <pre>Returns the interconnectDiagnostics for the specified interconnect. 270 271Args: 272 project: string, Project ID for this request. (required) 273 interconnect: string, Name of the interconnect resource to query. (required) 274 x__xgafv: string, V1 error format. 275 Allowed values 276 1 - v1 error format 277 2 - v2 error format 278 279Returns: 280 An object of the form: 281 282 { # Response for the InterconnectsGetDiagnosticsRequest. 283 "result": { # Diagnostics information about interconnect, contains detailed and current technical information about Google's side of the connection. 284 "arpCaches": [ # A list of InterconnectDiagnostics.ARPEntry objects, describing individual neighbors currently seen by the Google router in the ARP cache for the Interconnect. This will be empty when the Interconnect is not bundled. 285 { # Describing the ARP neighbor entries seen on this link 286 "ipAddress": "A String", # The IP address of this ARP neighbor. 287 "macAddress": "A String", # The MAC address of this ARP neighbor. 288 }, 289 ], 290 "links": [ # A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect. 291 { 292 "arpCaches": [ # A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP neighbor entries seen on this link. This will be empty if the link is bundled 293 { # Describing the ARP neighbor entries seen on this link 294 "ipAddress": "A String", # The IP address of this ARP neighbor. 295 "macAddress": "A String", # The MAC address of this ARP neighbor. 296 }, 297 ], 298 "circuitId": "A String", # The unique ID for this link assigned during turn up by Google. 299 "googleDemarc": "A String", # The Demarc address assigned by Google and provided in the LoA. 300 "lacpStatus": { 301 "googleSystemId": "A String", # System ID of the port on Google's side of the LACP exchange. 302 "neighborSystemId": "A String", # System ID of the port on the neighbor's side of the LACP exchange. 303 "state": "A String", # The state of a LACP link, which can take one of the following values: - ACTIVE: The link is configured and active within the bundle. - DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty. 304 }, 305 "macsec": { # Describes the status of MACsec encryption on the link. # Describes the status of MACsec encryption on this link. 306 "ckn": "A String", # Indicates the Connectivity Association Key Name (CKN) currently being used if MACsec is operational. 307 "operational": True or False, # Indicates whether or not MACsec is operational on this link. 308 }, 309 "receivingOpticalPower": { # An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level. 310 "state": "A String", # The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include: - OK: The value has not crossed a warning threshold. - LOW_WARNING: The value has crossed below the low warning threshold. - HIGH_WARNING: The value has crossed above the high warning threshold. - LOW_ALARM: The value has crossed below the low alarm threshold. - HIGH_ALARM: The value has crossed above the high alarm threshold. 311 "value": 3.14, # Value of the current receiving or transmitting optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links. 312 }, 313 "transmittingOpticalPower": { # An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the transmitted light level. 314 "state": "A String", # The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include: - OK: The value has not crossed a warning threshold. - LOW_WARNING: The value has crossed below the low warning threshold. - HIGH_WARNING: The value has crossed above the high warning threshold. - LOW_ALARM: The value has crossed below the low alarm threshold. - HIGH_ALARM: The value has crossed above the high alarm threshold. 315 "value": 3.14, # Value of the current receiving or transmitting optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links. 316 }, 317 }, 318 ], 319 "macAddress": "A String", # The MAC address of the Interconnect's bundle interface. 320 }, 321}</pre> 322</div> 323 324<div class="method"> 325 <code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code> 326 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. 327 328Args: 329 project: string, Project ID for this request. (required) 330 resource: string, Name or id of the resource for this request. (required) 331 optionsRequestedPolicyVersion: integer, Requested IAM Policy version. 332 x__xgafv: string, V1 error format. 333 Allowed values 334 1 - v1 error format 335 2 - v2 error format 336 337Returns: 338 An object of the form: 339 340 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals 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. For some types of Google Cloud resources, a `binding` can also 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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 341 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 342 { # 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. 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. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "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:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 343 "auditLogConfigs": [ # The configuration for logging of each type of permission. 344 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 345 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 346 "A String", 347 ], 348 "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. 349 "logType": "A String", # The log type that this config enables. 350 }, 351 ], 352 "exemptedMembers": [ # This is deprecated and has no effect. Do not use. 353 "A String", 354 ], 355 "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. 356 }, 357 ], 358 "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 359 { # Associates `members`, or principals, with a `role`. 360 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 361 "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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 362 "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. 363 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 364 "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. 365 "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. 366 }, 367 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?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. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 368 "A String", 369 ], 370 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 371 }, 372 ], 373 "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. **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. 374 "rules": [ # This is deprecated and has no effect. Do not use. 375 { # This is deprecated and has no effect. Do not use. 376 "action": "A String", # This is deprecated and has no effect. Do not use. 377 "conditions": [ # This is deprecated and has no effect. Do not use. 378 { # This is deprecated and has no effect. Do not use. 379 "iam": "A String", # This is deprecated and has no effect. Do not use. 380 "op": "A String", # This is deprecated and has no effect. Do not use. 381 "svc": "A String", # This is deprecated and has no effect. Do not use. 382 "sys": "A String", # This is deprecated and has no effect. Do not use. 383 "values": [ # This is deprecated and has no effect. Do not use. 384 "A String", 385 ], 386 }, 387 ], 388 "description": "A String", # This is deprecated and has no effect. Do not use. 389 "ins": [ # This is deprecated and has no effect. Do not use. 390 "A String", 391 ], 392 "logConfigs": [ # This is deprecated and has no effect. Do not use. 393 { # This is deprecated and has no effect. Do not use. 394 "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 395 "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 396 "permissionType": "A String", # This is deprecated and has no effect. Do not use. 397 }, 398 "logName": "A String", # This is deprecated and has no effect. Do not use. 399 }, 400 "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 401 "customFields": [ # This is deprecated and has no effect. Do not use. 402 { # This is deprecated and has no effect. Do not use. 403 "name": "A String", # This is deprecated and has no effect. Do not use. 404 "value": "A String", # This is deprecated and has no effect. Do not use. 405 }, 406 ], 407 "field": "A String", # This is deprecated and has no effect. Do not use. 408 "metric": "A String", # This is deprecated and has no effect. Do not use. 409 }, 410 "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 411 "logMode": "A String", # This is deprecated and has no effect. Do not use. 412 }, 413 }, 414 ], 415 "notIns": [ # This is deprecated and has no effect. Do not use. 416 "A String", 417 ], 418 "permissions": [ # This is deprecated and has no effect. Do not use. 419 "A String", 420 ], 421 }, 422 ], 423 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * 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 **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. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 424}</pre> 425</div> 426 427<div class="method"> 428 <code class="details" id="getMacsecConfig">getMacsecConfig(project, interconnect, x__xgafv=None)</code> 429 <pre>Returns the interconnectMacsecConfig for the specified interconnect. 430 431Args: 432 project: string, Project ID for this request. (required) 433 interconnect: string, Name of the interconnect resource to query. (required) 434 x__xgafv: string, V1 error format. 435 Allowed values 436 1 - v1 error format 437 2 - v2 error format 438 439Returns: 440 An object of the form: 441 442 { # Response for the InterconnectsGetMacsecConfigRequest. 443 "etag": "A String", # end_interface: MixerGetResponseWithEtagBuilder 444 "result": { # MACsec configuration information for the Interconnect. Contains the generated Connectivity Association Key Name (CKN) and the key (CAK) for this Interconnect. 445 "preSharedKeys": [ # A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK will be generated for each key in the key chain. Google router will automatically pick the key with the most recent startTime when establishing or re-establishing a MACsec secure link. 446 { # Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode. 447 "cak": "A String", # An auto-generated Connectivity Association Key (CAK) for this key. 448 "ckn": "A String", # An auto-generated Connectivity Association Key Name (CKN) for this key. 449 "name": "A String", # User provided name for this pre-shared key. 450 "startTime": "A String", # User provided timestamp on or after which this key is valid. 451 }, 452 ], 453 }, 454}</pre> 455</div> 456 457<div class="method"> 458 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code> 459 <pre>Creates a Interconnect in the specified project using the data included in the request. 460 461Args: 462 project: string, Project ID for this request. (required) 463 body: object, The request body. 464 The object takes the form of: 465 466{ # Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. 467 "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. 468 "circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. 469 { # Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. 470 "customerDemarcId": "A String", # Customer-side demarc ID for this circuit. 471 "googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up. 472 "googleDemarcId": "A String", # Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA. 473 }, 474 ], 475 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 476 "customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. 477 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 478 "expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect. 479 { # Description of a planned outage on this Interconnect. 480 "affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected. 481 "A String", 482 ], 483 "description": "A String", # A description about the purpose of the outage. 484 "endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch). 485 "issueType": "A String", # Form this outage is expected to take, which can take one of the following values: - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values. 486 "name": "A String", # Unique identifier for this outage notification. 487 "source": "A String", # The party that generated this notification, which can take the following value: - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. 488 "startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch). 489 "state": "A String", # State of this notification, which can take one of the following values: - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. - COMPLETED: The outage associated with this notification is complete. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values. 490 }, 491 ], 492 "googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. 493 "googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. 494 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 495 "interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. 496 "A String", 497 ], 498 "interconnectType": "A String", # Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. 499 "kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects. 500 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Interconnect, 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. To see the latest fingerprint, make a get() request to retrieve an Interconnect. 501 "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. 502 "a_key": "A String", 503 }, 504 "linkType": "A String", # Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. 505 "location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned. 506 "macsec": { # Configuration information for enabling Media Access Control security (Macsec) on this Interconnect between Google and your on-premises router. # Configuration to enable Media Access Control security (MACsec) on the Interconnect between Google and your on-premises router. 507 "failOpen": True or False, # If set to true, the Interconnect will be configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect will be configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router. 508 "preSharedKeys": [ # Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK will be generated for each key in the key chain. Google router will automatically pick the key with the most recent startTime when establishing or re-establishing a MACsec secure link. 509 { # Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode. 510 "name": "A String", # Required. A name for this pre-shared key. 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. 511 "startTime": "A String", # A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart. 512 }, 513 ], 514 }, 515 "macsecEnabled": True or False, # Enable or disable MACsec on this Interconnect. MACsec enablement will fail if the macsec object is not specified. 516 "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. 517 "nocContactEmail": "A String", # Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications. 518 "operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. 519 "peerIpAddress": "A String", # [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests. 520 "provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect. 521 "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer. 522 "satisfiesPzs": True or False, # [Output Only] Set to true if the resource satisfies the zone separation organization policy constraints and false otherwise. Defaults to false if the field is not present. 523 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 524 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 525 "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. 526} 527 528 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. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 529 x__xgafv: string, V1 error format. 530 Allowed values 531 1 - v1 error format 532 2 - v2 error format 533 534Returns: 535 An object of the form: 536 537 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 538 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 539 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 540 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 541 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 542 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 543 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 544 { 545 "code": "A String", # [Output Only] The error type identifier for this error. 546 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 547 "message": "A String", # [Output Only] An optional, human-readable error message. 548 }, 549 ], 550 }, 551 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 552 "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. 553 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 554 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 555 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 556 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 557 "a_key": "", # Properties of the object. Contains field @type with type URL. 558 }, 559 "name": "A String", # [Output Only] Name of the operation. 560 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 561 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 562 "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. 563 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 564 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 565 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 566 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 567 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 568 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 569 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 570 "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. 571 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 572 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 573 { 574 "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. 575 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 576 { 577 "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). 578 "value": "A String", # [Output Only] A warning data value corresponding to the key. 579 }, 580 ], 581 "message": "A String", # [Output Only] A human-readable description of the warning code. 582 }, 583 ], 584 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 585}</pre> 586</div> 587 588<div class="method"> 589 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 590 <pre>Retrieves the list of interconnect available to the specified project. 591 592Args: 593 project: string, Project ID for this request. (required) 594 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You 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. To 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) ``` 595 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`) 596 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 597 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. 598 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 599 x__xgafv: string, V1 error format. 600 Allowed values 601 1 - v1 error format 602 2 - v2 error format 603 604Returns: 605 An object of the form: 606 607 { # Response to the list request, and contains a list of interconnects. 608 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 609 "items": [ # A list of Interconnect resources. 610 { # Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. 611 "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. 612 "circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. 613 { # Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. 614 "customerDemarcId": "A String", # Customer-side demarc ID for this circuit. 615 "googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up. 616 "googleDemarcId": "A String", # Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA. 617 }, 618 ], 619 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 620 "customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. 621 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 622 "expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect. 623 { # Description of a planned outage on this Interconnect. 624 "affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected. 625 "A String", 626 ], 627 "description": "A String", # A description about the purpose of the outage. 628 "endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch). 629 "issueType": "A String", # Form this outage is expected to take, which can take one of the following values: - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values. 630 "name": "A String", # Unique identifier for this outage notification. 631 "source": "A String", # The party that generated this notification, which can take the following value: - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. 632 "startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch). 633 "state": "A String", # State of this notification, which can take one of the following values: - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. - COMPLETED: The outage associated with this notification is complete. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values. 634 }, 635 ], 636 "googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. 637 "googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. 638 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 639 "interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. 640 "A String", 641 ], 642 "interconnectType": "A String", # Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. 643 "kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects. 644 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Interconnect, 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. To see the latest fingerprint, make a get() request to retrieve an Interconnect. 645 "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. 646 "a_key": "A String", 647 }, 648 "linkType": "A String", # Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. 649 "location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned. 650 "macsec": { # Configuration information for enabling Media Access Control security (Macsec) on this Interconnect between Google and your on-premises router. # Configuration to enable Media Access Control security (MACsec) on the Interconnect between Google and your on-premises router. 651 "failOpen": True or False, # If set to true, the Interconnect will be configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect will be configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router. 652 "preSharedKeys": [ # Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK will be generated for each key in the key chain. Google router will automatically pick the key with the most recent startTime when establishing or re-establishing a MACsec secure link. 653 { # Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode. 654 "name": "A String", # Required. A name for this pre-shared key. 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. 655 "startTime": "A String", # A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart. 656 }, 657 ], 658 }, 659 "macsecEnabled": True or False, # Enable or disable MACsec on this Interconnect. MACsec enablement will fail if the macsec object is not specified. 660 "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. 661 "nocContactEmail": "A String", # Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications. 662 "operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. 663 "peerIpAddress": "A String", # [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests. 664 "provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect. 665 "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer. 666 "satisfiesPzs": True or False, # [Output Only] Set to true if the resource satisfies the zone separation organization policy constraints and false otherwise. Defaults to false if the field is not present. 667 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 668 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 669 "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. 670 }, 671 ], 672 "kind": "compute#interconnectList", # [Output Only] Type of resource. Always compute#interconnectList for lists of interconnects. 673 "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. 674 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 675 "warning": { # [Output Only] Informational warning message. 676 "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. 677 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 678 { 679 "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). 680 "value": "A String", # [Output Only] A warning data value corresponding to the key. 681 }, 682 ], 683 "message": "A String", # [Output Only] A human-readable description of the warning code. 684 }, 685}</pre> 686</div> 687 688<div class="method"> 689 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 690 <pre>Retrieves the next page of results. 691 692Args: 693 previous_request: The request for the previous page. (required) 694 previous_response: The response from the request for the previous page. (required) 695 696Returns: 697 A request object that you can call 'execute()' on to request the next 698 page. Returns None if there are no more items in the collection. 699 </pre> 700</div> 701 702<div class="method"> 703 <code class="details" id="patch">patch(project, interconnect, body=None, requestId=None, x__xgafv=None)</code> 704 <pre>Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. 705 706Args: 707 project: string, Project ID for this request. (required) 708 interconnect: string, Name of the interconnect to update. (required) 709 body: object, The request body. 710 The object takes the form of: 711 712{ # Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. 713 "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. 714 "circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. 715 { # Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. 716 "customerDemarcId": "A String", # Customer-side demarc ID for this circuit. 717 "googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up. 718 "googleDemarcId": "A String", # Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA. 719 }, 720 ], 721 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 722 "customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. 723 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 724 "expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect. 725 { # Description of a planned outage on this Interconnect. 726 "affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected. 727 "A String", 728 ], 729 "description": "A String", # A description about the purpose of the outage. 730 "endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch). 731 "issueType": "A String", # Form this outage is expected to take, which can take one of the following values: - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values. 732 "name": "A String", # Unique identifier for this outage notification. 733 "source": "A String", # The party that generated this notification, which can take the following value: - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. 734 "startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch). 735 "state": "A String", # State of this notification, which can take one of the following values: - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. - COMPLETED: The outage associated with this notification is complete. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values. 736 }, 737 ], 738 "googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. 739 "googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. 740 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 741 "interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. 742 "A String", 743 ], 744 "interconnectType": "A String", # Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. 745 "kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects. 746 "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Interconnect, 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. To see the latest fingerprint, make a get() request to retrieve an Interconnect. 747 "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. 748 "a_key": "A String", 749 }, 750 "linkType": "A String", # Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. 751 "location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned. 752 "macsec": { # Configuration information for enabling Media Access Control security (Macsec) on this Interconnect between Google and your on-premises router. # Configuration to enable Media Access Control security (MACsec) on the Interconnect between Google and your on-premises router. 753 "failOpen": True or False, # If set to true, the Interconnect will be configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect will be configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router. 754 "preSharedKeys": [ # Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK will be generated for each key in the key chain. Google router will automatically pick the key with the most recent startTime when establishing or re-establishing a MACsec secure link. 755 { # Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode. 756 "name": "A String", # Required. A name for this pre-shared key. 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. 757 "startTime": "A String", # A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart. 758 }, 759 ], 760 }, 761 "macsecEnabled": True or False, # Enable or disable MACsec on this Interconnect. MACsec enablement will fail if the macsec object is not specified. 762 "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. 763 "nocContactEmail": "A String", # Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications. 764 "operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. 765 "peerIpAddress": "A String", # [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests. 766 "provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect. 767 "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer. 768 "satisfiesPzs": True or False, # [Output Only] Set to true if the resource satisfies the zone separation organization policy constraints and false otherwise. Defaults to false if the field is not present. 769 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 770 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 771 "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. 772} 773 774 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. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 775 x__xgafv: string, V1 error format. 776 Allowed values 777 1 - v1 error format 778 2 - v2 error format 779 780Returns: 781 An object of the form: 782 783 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 784 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 785 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 786 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 787 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 788 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 789 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 790 { 791 "code": "A String", # [Output Only] The error type identifier for this error. 792 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 793 "message": "A String", # [Output Only] An optional, human-readable error message. 794 }, 795 ], 796 }, 797 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 798 "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. 799 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 800 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 801 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 802 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 803 "a_key": "", # Properties of the object. Contains field @type with type URL. 804 }, 805 "name": "A String", # [Output Only] Name of the operation. 806 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 807 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 808 "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. 809 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 810 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 811 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 812 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 813 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 814 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 815 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 816 "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. 817 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 818 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 819 { 820 "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. 821 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 822 { 823 "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). 824 "value": "A String", # [Output Only] A warning data value corresponding to the key. 825 }, 826 ], 827 "message": "A String", # [Output Only] A human-readable description of the warning code. 828 }, 829 ], 830 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 831}</pre> 832</div> 833 834<div class="method"> 835 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</code> 836 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. 837 838Args: 839 project: string, Project ID for this request. (required) 840 resource: string, Name or id of the resource for this request. (required) 841 body: object, The request body. 842 The object takes the form of: 843 844{ 845 "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. 846 { # Associates `members`, or principals, with a `role`. 847 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 848 "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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 849 "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. 850 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 851 "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. 852 "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. 853 }, 854 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?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. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 855 "A String", 856 ], 857 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 858 }, 859 ], 860 "etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. 861 "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals 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. For some types of Google Cloud resources, a `binding` can also 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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # 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. 862 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 863 { # 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. 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. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "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:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 864 "auditLogConfigs": [ # The configuration for logging of each type of permission. 865 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 866 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 867 "A String", 868 ], 869 "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. 870 "logType": "A String", # The log type that this config enables. 871 }, 872 ], 873 "exemptedMembers": [ # This is deprecated and has no effect. Do not use. 874 "A String", 875 ], 876 "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. 877 }, 878 ], 879 "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 880 { # Associates `members`, or principals, with a `role`. 881 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 882 "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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 883 "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. 884 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 885 "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. 886 "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. 887 }, 888 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?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. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 889 "A String", 890 ], 891 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 892 }, 893 ], 894 "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. **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. 895 "rules": [ # This is deprecated and has no effect. Do not use. 896 { # This is deprecated and has no effect. Do not use. 897 "action": "A String", # This is deprecated and has no effect. Do not use. 898 "conditions": [ # This is deprecated and has no effect. Do not use. 899 { # This is deprecated and has no effect. Do not use. 900 "iam": "A String", # This is deprecated and has no effect. Do not use. 901 "op": "A String", # This is deprecated and has no effect. Do not use. 902 "svc": "A String", # This is deprecated and has no effect. Do not use. 903 "sys": "A String", # This is deprecated and has no effect. Do not use. 904 "values": [ # This is deprecated and has no effect. Do not use. 905 "A String", 906 ], 907 }, 908 ], 909 "description": "A String", # This is deprecated and has no effect. Do not use. 910 "ins": [ # This is deprecated and has no effect. Do not use. 911 "A String", 912 ], 913 "logConfigs": [ # This is deprecated and has no effect. Do not use. 914 { # This is deprecated and has no effect. Do not use. 915 "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 916 "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 917 "permissionType": "A String", # This is deprecated and has no effect. Do not use. 918 }, 919 "logName": "A String", # This is deprecated and has no effect. Do not use. 920 }, 921 "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 922 "customFields": [ # This is deprecated and has no effect. Do not use. 923 { # This is deprecated and has no effect. Do not use. 924 "name": "A String", # This is deprecated and has no effect. Do not use. 925 "value": "A String", # This is deprecated and has no effect. Do not use. 926 }, 927 ], 928 "field": "A String", # This is deprecated and has no effect. Do not use. 929 "metric": "A String", # This is deprecated and has no effect. Do not use. 930 }, 931 "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 932 "logMode": "A String", # This is deprecated and has no effect. Do not use. 933 }, 934 }, 935 ], 936 "notIns": [ # This is deprecated and has no effect. Do not use. 937 "A String", 938 ], 939 "permissions": [ # This is deprecated and has no effect. Do not use. 940 "A String", 941 ], 942 }, 943 ], 944 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * 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 **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. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 945 }, 946} 947 948 x__xgafv: string, V1 error format. 949 Allowed values 950 1 - v1 error format 951 2 - v2 error format 952 953Returns: 954 An object of the form: 955 956 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals 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. For some types of Google Cloud resources, a `binding` can also 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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[email protected]", "group:[email protected]", "domain:google.com", "serviceAccount:[email protected]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[email protected]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). 957 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 958 { # 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. 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. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "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:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging. 959 "auditLogConfigs": [ # The configuration for logging of each type of permission. 960 { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging. 961 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. 962 "A String", 963 ], 964 "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use. 965 "logType": "A String", # The log type that this config enables. 966 }, 967 ], 968 "exemptedMembers": [ # This is deprecated and has no effect. Do not use. 969 "A String", 970 ], 971 "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. 972 }, 973 ], 974 "bindings": [ # Associates a list of `members`, or principals, with 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 principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:[email protected]`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. 975 { # Associates `members`, or principals, with a `role`. 976 "bindingId": "A String", # This is deprecated and has no effect. Do not use. 977 "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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 978 "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. 979 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 980 "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. 981 "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. 982 }, 983 "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `[email protected]?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. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 984 "A String", 985 ], 986 "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 987 }, 988 ], 989 "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. **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. 990 "rules": [ # This is deprecated and has no effect. Do not use. 991 { # This is deprecated and has no effect. Do not use. 992 "action": "A String", # This is deprecated and has no effect. Do not use. 993 "conditions": [ # This is deprecated and has no effect. Do not use. 994 { # This is deprecated and has no effect. Do not use. 995 "iam": "A String", # This is deprecated and has no effect. Do not use. 996 "op": "A String", # This is deprecated and has no effect. Do not use. 997 "svc": "A String", # This is deprecated and has no effect. Do not use. 998 "sys": "A String", # This is deprecated and has no effect. Do not use. 999 "values": [ # This is deprecated and has no effect. Do not use. 1000 "A String", 1001 ], 1002 }, 1003 ], 1004 "description": "A String", # This is deprecated and has no effect. Do not use. 1005 "ins": [ # This is deprecated and has no effect. Do not use. 1006 "A String", 1007 ], 1008 "logConfigs": [ # This is deprecated and has no effect. Do not use. 1009 { # This is deprecated and has no effect. Do not use. 1010 "cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1011 "authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1012 "permissionType": "A String", # This is deprecated and has no effect. Do not use. 1013 }, 1014 "logName": "A String", # This is deprecated and has no effect. Do not use. 1015 }, 1016 "counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1017 "customFields": [ # This is deprecated and has no effect. Do not use. 1018 { # This is deprecated and has no effect. Do not use. 1019 "name": "A String", # This is deprecated and has no effect. Do not use. 1020 "value": "A String", # This is deprecated and has no effect. Do not use. 1021 }, 1022 ], 1023 "field": "A String", # This is deprecated and has no effect. Do not use. 1024 "metric": "A String", # This is deprecated and has no effect. Do not use. 1025 }, 1026 "dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use. 1027 "logMode": "A String", # This is deprecated and has no effect. Do not use. 1028 }, 1029 }, 1030 ], 1031 "notIns": [ # This is deprecated and has no effect. Do not use. 1032 "A String", 1033 ], 1034 "permissions": [ # This is deprecated and has no effect. Do not use. 1035 "A String", 1036 ], 1037 }, 1038 ], 1039 "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * 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 **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. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). 1040}</pre> 1041</div> 1042 1043<div class="method"> 1044 <code class="details" id="setLabels">setLabels(project, resource, body=None, x__xgafv=None)</code> 1045 <pre>Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation. 1046 1047Args: 1048 project: string, Project ID for this request. (required) 1049 resource: string, Name or id of the resource for this request. (required) 1050 body: object, The request body. 1051 The object takes the form of: 1052 1053{ 1054 "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 when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint. 1055 "labels": { # A list of labels to apply for this resource. Each label key & value must 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. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": ""). 1056 "a_key": "A String", 1057 }, 1058} 1059 1060 x__xgafv: string, V1 error format. 1061 Allowed values 1062 1 - v1 error format 1063 2 - v2 error format 1064 1065Returns: 1066 An object of the form: 1067 1068 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 1069 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1070 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1071 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1072 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1073 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1074 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1075 { 1076 "code": "A String", # [Output Only] The error type identifier for this error. 1077 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1078 "message": "A String", # [Output Only] An optional, human-readable error message. 1079 }, 1080 ], 1081 }, 1082 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1083 "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. 1084 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1085 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1086 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1087 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 1088 "a_key": "", # Properties of the object. Contains field @type with type URL. 1089 }, 1090 "name": "A String", # [Output Only] Name of the operation. 1091 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 1092 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1093 "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. 1094 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1095 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1096 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1097 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1098 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1099 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1100 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1101 "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. 1102 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1103 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1104 { 1105 "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. 1106 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1107 { 1108 "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). 1109 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1110 }, 1111 ], 1112 "message": "A String", # [Output Only] A human-readable description of the warning code. 1113 }, 1114 ], 1115 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1116}</pre> 1117</div> 1118 1119<div class="method"> 1120 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code> 1121 <pre>Returns permissions that a caller has on the specified resource. 1122 1123Args: 1124 project: string, Project ID for this request. (required) 1125 resource: string, Name or id of the resource for this request. (required) 1126 body: object, The request body. 1127 The object takes the form of: 1128 1129{ 1130 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 1131 "A String", 1132 ], 1133} 1134 1135 x__xgafv: string, V1 error format. 1136 Allowed values 1137 1 - v1 error format 1138 2 - v2 error format 1139 1140Returns: 1141 An object of the form: 1142 1143 { 1144 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 1145 "A String", 1146 ], 1147}</pre> 1148</div> 1149 1150</body></html>