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="#delete">delete(project, interconnect, requestId=None)</a></code></p> 79<p class="firstline">Deletes the specified interconnect.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(project, interconnect)</a></code></p> 82<p class="firstline">Returns the specified interconnect. Get a list of available interconnects by making a list() request.</p> 83<p class="toc_element"> 84 <code><a href="#getDiagnostics">getDiagnostics(project, interconnect)</a></code></p> 85<p class="firstline">Returns the interconnectDiagnostics for the specified interconnect.</p> 86<p class="toc_element"> 87 <code><a href="#getIamPolicy">getIamPolicy(project, resource)</a></code></p> 88<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p> 89<p class="toc_element"> 90 <code><a href="#insert">insert(project, body, requestId=None)</a></code></p> 91<p class="firstline">Creates a Interconnect in the specified project using the data included in the request.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 94<p class="firstline">Retrieves the list of interconnect available to the specified project.</p> 95<p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97<p class="firstline">Retrieves the next page of results.</p> 98<p class="toc_element"> 99 <code><a href="#patch">patch(project, interconnect, body, requestId=None)</a></code></p> 100<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> 101<p class="toc_element"> 102 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body)</a></code></p> 103<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p> 104<p class="toc_element"> 105 <code><a href="#setLabels">setLabels(project, resource, body)</a></code></p> 106<p class="firstline">Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation.</p> 107<p class="toc_element"> 108 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p> 109<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 110<h3>Method Details</h3> 111<div class="method"> 112 <code class="details" id="delete">delete(project, interconnect, requestId=None)</code> 113 <pre>Deletes the specified interconnect. 114 115Args: 116 project: string, Project ID for this request. (required) 117 interconnect: string, Name of the interconnect to delete. (required) 118 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. 119 120For 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. 121 122The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 123 124Returns: 125 An object of the form: 126 127 { # Represents an Operation resource. 128 # 129 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 130 # 131 # Operations can be global, regional or zonal. 132 # - For global operations, use the globalOperations resource. 133 # - For regional operations, use the regionOperations resource. 134 # - For zonal operations, use the zonalOperations resource. 135 # 136 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 137 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 138 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 139 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 140 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 141 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 142 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 143 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 144 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 145 "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. 146 "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. 147 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 148 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 149 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 150 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 151 { 152 "message": "A String", # [Output Only] A human-readable description of the warning code. 153 "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. 154 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 155 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 156 { 157 "value": "A String", # [Output Only] A warning data value corresponding to the key. 158 "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). 159 }, 160 ], 161 }, 162 ], 163 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 164 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 165 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 166 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 167 "name": "A String", # [Output Only] Name of the resource. 168 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 169 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 170 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 171 { 172 "message": "A String", # [Output Only] An optional, human-readable error message. 173 "code": "A String", # [Output Only] The error type identifier for this error. 174 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 175 }, 176 ], 177 }, 178 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 179 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 180 "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. 181 }</pre> 182</div> 183 184<div class="method"> 185 <code class="details" id="get">get(project, interconnect)</code> 186 <pre>Returns the specified interconnect. Get a list of available interconnects by making a list() request. 187 188Args: 189 project: string, Project ID for this request. (required) 190 interconnect: string, Name of the interconnect to return. (required) 191 192Returns: 193 An object of the form: 194 195 { # Represents an Interconnect resource. 196 # 197 # An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) 198 "linkType": "A String", # Type of link requested, which can take one of the following values: 199 # - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics 200 # - 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. 201 "customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. 202 "circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. 203 { # Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. Next id: 4 204 "customerDemarcId": "A String", # Customer-side demarc ID for this circuit. 205 "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. 206 "googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up. 207 }, 208 ], 209 "labels": { # Labels to apply to this Interconnect resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. 210 "a_key": "A String", 211 }, 212 "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. 213 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 214 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 215 "interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. 216 "A String", 217 ], 218 "googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. 219 "expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect. 220 { # Description of a planned outage on this Interconnect. Next id: 9 221 "description": "A String", # A description about the purpose of the outage. 222 "affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected. 223 "A String", 224 ], 225 "source": "A String", # The party that generated this notification, which can take the following value: 226 # - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. 227 "state": "A String", # State of this notification, which can take one of the following values: 228 # - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. 229 # - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values. 230 "startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch). 231 "issueType": "A String", # Form this outage is expected to take, which can take one of the following values: 232 # - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. 233 # - 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. 234 "endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch). 235 "name": "A String", # Unique identifier for this outage notification. 236 }, 237 ], 238 "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. 239 "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values: 240 # - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. 241 # - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. 242 # - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. 243 "location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned. 244 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 245 "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. 246 "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. 247 # 248 # To see the latest fingerprint, make a get() request to retrieve an Interconnect. 249 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 250 "operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: 251 # - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. 252 # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. 253 # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. 254 "interconnectType": "A String", # Type of interconnect, which can take one of the following values: 255 # - PARTNER: A partner-managed interconnection shared between customers though a partner. 256 # - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. 257 "kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects. 258 "provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect. 259 "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. 260 "googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. 261 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 262 "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer. 263 }</pre> 264</div> 265 266<div class="method"> 267 <code class="details" id="getDiagnostics">getDiagnostics(project, interconnect)</code> 268 <pre>Returns the interconnectDiagnostics for the specified interconnect. 269 270Args: 271 project: string, Project ID for this request. (required) 272 interconnect: string, Name of the interconnect resource to query. (required) 273 274Returns: 275 An object of the form: 276 277 { # Response for the InterconnectsGetDiagnosticsRequest. 278 "result": { # Diagnostics information about interconnect, contains detailed and current technical information about Google?s side of the connection. 279 "macAddress": "A String", # The MAC address of the Interconnect's bundle interface. 280 "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. 281 { # Describing the ARP neighbor entries seen on this link 282 "macAddress": "A String", # The MAC address of this ARP neighbor. 283 "ipAddress": "A String", # The IP address of this ARP neighbor. 284 }, 285 ], 286 "links": [ # A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect. 287 { 288 "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 289 { # Describing the ARP neighbor entries seen on this link 290 "macAddress": "A String", # The MAC address of this ARP neighbor. 291 "ipAddress": "A String", # The IP address of this ARP neighbor. 292 }, 293 ], 294 "circuitId": "A String", # The unique ID for this link assigned during turn up by Google. 295 "receivingOpticalPower": { # An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level. 296 "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: 297 # - OK: The value has not crossed a warning threshold. 298 # - LOW_WARNING: The value has crossed below the low warning threshold. 299 # - HIGH_WARNING: The value has crossed above the high warning threshold. 300 # - LOW_ALARM: The value has crossed below the low alarm threshold. 301 # - HIGH_ALARM: The value has crossed above the high alarm threshold. 302 "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. 303 }, 304 "googleDemarc": "A String", # The Demarc address assigned by Google and provided in the LoA. 305 "lacpStatus": { 306 "neighborSystemId": "A String", # System ID of the port on the neighbor?s side of the LACP exchange. 307 "state": "A String", # The state of a LACP link, which can take one of the following values: 308 # - ACTIVE: The link is configured and active within the bundle. 309 # - DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty. 310 "googleSystemId": "A String", # System ID of the port on Google?s side of the LACP exchange. 311 }, 312 "transmittingOpticalPower": { # An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the transmitted light level. 313 "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: 314 # - OK: The value has not crossed a warning threshold. 315 # - LOW_WARNING: The value has crossed below the low warning threshold. 316 # - HIGH_WARNING: The value has crossed above the high warning threshold. 317 # - LOW_ALARM: The value has crossed below the low alarm threshold. 318 # - HIGH_ALARM: The value has crossed above the high alarm threshold. 319 "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. 320 }, 321 }, 322 ], 323 }, 324 }</pre> 325</div> 326 327<div class="method"> 328 <code class="details" id="getIamPolicy">getIamPolicy(project, resource)</code> 329 <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. 330 331Args: 332 project: string, Project ID for this request. (required) 333 resource: string, Name or id of the resource for this request. (required) 334 335Returns: 336 An object of the form: 337 338 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 339 # 340 # 341 # 342 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. 343 # 344 # **JSON Example** 345 # 346 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } 347 # 348 # **YAML Example** 349 # 350 # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer 351 # 352 # 353 # 354 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). 355 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 356 { # 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. 357 # 358 # 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. 359 # 360 # Example Policy with multiple AuditConfigs: 361 # 362 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } 363 # 364 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. 365 "exemptedMembers": [ 366 "A String", 367 ], 368 "auditLogConfigs": [ # The configuration for logging of each type of permission. 369 { # Provides the configuration for logging a type of permissions. Example: 370 # 371 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 372 # 373 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. 374 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 375 "A String", 376 ], 377 "logType": "A String", # The log type that this config enables. 378 }, 379 ], 380 "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. 381 }, 382 ], 383 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. 384 { # A rule to be applied in a Policy. 385 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 386 { # Specifies what kind of log the caller must write 387 "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options. 388 # 389 # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. 390 # 391 # Field names correspond to IAM request parameters and field values are their respective values. 392 # 393 # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. 394 # 395 # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} 396 # 397 # At this time we do not support multiple field names (though this may be supported in the future). 398 "field": "A String", # The field value to attribute. 399 "metric": "A String", # The metric to update. 400 }, 401 "dataAccess": { # Write a Data Access (Gin) log # Data access options. 402 "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. 403 }, 404 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. 405 "logName": "A String", # The log_name to populate in the Cloud Audit Record. 406 "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline. 407 "permissionType": "A String", # The type of the permission that was checked. 408 }, 409 }, 410 }, 411 ], 412 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 413 "A String", 414 ], 415 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. 416 "A String", 417 ], 418 "action": "A String", # Required 419 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. 420 "A String", 421 ], 422 "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match. 423 { # A condition to be met. 424 "iam": "A String", # Trusted attributes supplied by the IAM system. 425 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 426 "values": [ # The objects of the condition. 427 "A String", 428 ], 429 "svc": "A String", # Trusted attributes discharged by the service. 430 "op": "A String", # An operator to apply the subject with. 431 }, 432 ], 433 "description": "A String", # Human-readable description of the rule. 434 }, 435 ], 436 "version": 42, # Deprecated. 437 "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. 438 # 439 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 440 "bindings": [ # Associates a list of `members` to a `role`. `bindings` with no members will result in an error. 441 { # Associates `members` with a `role`. 442 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 443 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 444 # 445 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 446 # 447 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 448 # 449 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . 450 # 451 # 452 # 453 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 454 # 455 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 456 # 457 # 458 # 459 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 460 "A String", 461 ], 462 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 463 # 464 # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" 465 "title": "A String", # An 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. 466 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 467 # 468 # The application context of the containing message determines which well-known feature set of CEL is supported. 469 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 470 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 471 }, 472 }, 473 ], 474 "iamOwned": True or False, 475 }</pre> 476</div> 477 478<div class="method"> 479 <code class="details" id="insert">insert(project, body, requestId=None)</code> 480 <pre>Creates a Interconnect in the specified project using the data included in the request. 481 482Args: 483 project: string, Project ID for this request. (required) 484 body: object, The request body. (required) 485 The object takes the form of: 486 487{ # Represents an Interconnect resource. 488 # 489 # An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) 490 "linkType": "A String", # Type of link requested, which can take one of the following values: 491 # - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics 492 # - 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. 493 "customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. 494 "circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. 495 { # Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. Next id: 4 496 "customerDemarcId": "A String", # Customer-side demarc ID for this circuit. 497 "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. 498 "googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up. 499 }, 500 ], 501 "labels": { # Labels to apply to this Interconnect resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. 502 "a_key": "A String", 503 }, 504 "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. 505 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 506 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 507 "interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. 508 "A String", 509 ], 510 "googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. 511 "expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect. 512 { # Description of a planned outage on this Interconnect. Next id: 9 513 "description": "A String", # A description about the purpose of the outage. 514 "affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected. 515 "A String", 516 ], 517 "source": "A String", # The party that generated this notification, which can take the following value: 518 # - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. 519 "state": "A String", # State of this notification, which can take one of the following values: 520 # - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. 521 # - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values. 522 "startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch). 523 "issueType": "A String", # Form this outage is expected to take, which can take one of the following values: 524 # - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. 525 # - 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. 526 "endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch). 527 "name": "A String", # Unique identifier for this outage notification. 528 }, 529 ], 530 "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. 531 "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values: 532 # - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. 533 # - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. 534 # - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. 535 "location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned. 536 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 537 "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. 538 "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. 539 # 540 # To see the latest fingerprint, make a get() request to retrieve an Interconnect. 541 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 542 "operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: 543 # - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. 544 # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. 545 # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. 546 "interconnectType": "A String", # Type of interconnect, which can take one of the following values: 547 # - PARTNER: A partner-managed interconnection shared between customers though a partner. 548 # - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. 549 "kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects. 550 "provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect. 551 "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. 552 "googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. 553 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 554 "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer. 555 } 556 557 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. 558 559For 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. 560 561The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 562 563Returns: 564 An object of the form: 565 566 { # Represents an Operation resource. 567 # 568 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 569 # 570 # Operations can be global, regional or zonal. 571 # - For global operations, use the globalOperations resource. 572 # - For regional operations, use the regionOperations resource. 573 # - For zonal operations, use the zonalOperations resource. 574 # 575 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 576 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 577 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 578 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 579 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 580 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 581 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 582 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 583 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 584 "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. 585 "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. 586 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 587 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 588 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 589 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 590 { 591 "message": "A String", # [Output Only] A human-readable description of the warning code. 592 "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. 593 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 594 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 595 { 596 "value": "A String", # [Output Only] A warning data value corresponding to the key. 597 "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). 598 }, 599 ], 600 }, 601 ], 602 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 603 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 604 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 605 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 606 "name": "A String", # [Output Only] Name of the resource. 607 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 608 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 609 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 610 { 611 "message": "A String", # [Output Only] An optional, human-readable error message. 612 "code": "A String", # [Output Only] The error type identifier for this error. 613 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 614 }, 615 ], 616 }, 617 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 618 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 619 "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. 620 }</pre> 621</div> 622 623<div class="method"> 624 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 625 <pre>Retrieves the list of interconnect available to the specified project. 626 627Args: 628 project: string, Project ID for this request. (required) 629 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 630 631You 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. 632 633Currently, only sorting by name or creationTimestamp desc is supported. 634 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) 635 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. 636 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. 637 638For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 639 640You 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. 641 642To 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). 643 644Returns: 645 An object of the form: 646 647 { # Response to the list request, and contains a list of interconnects. 648 "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. 649 "kind": "compute#interconnectList", # [Output Only] Type of resource. Always compute#interconnectList for lists of interconnects. 650 "items": [ # A list of Interconnect resources. 651 { # Represents an Interconnect resource. 652 # 653 # An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) 654 "linkType": "A String", # Type of link requested, which can take one of the following values: 655 # - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics 656 # - 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. 657 "customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. 658 "circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. 659 { # Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. Next id: 4 660 "customerDemarcId": "A String", # Customer-side demarc ID for this circuit. 661 "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. 662 "googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up. 663 }, 664 ], 665 "labels": { # Labels to apply to this Interconnect resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. 666 "a_key": "A String", 667 }, 668 "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. 669 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 670 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 671 "interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. 672 "A String", 673 ], 674 "googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. 675 "expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect. 676 { # Description of a planned outage on this Interconnect. Next id: 9 677 "description": "A String", # A description about the purpose of the outage. 678 "affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected. 679 "A String", 680 ], 681 "source": "A String", # The party that generated this notification, which can take the following value: 682 # - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. 683 "state": "A String", # State of this notification, which can take one of the following values: 684 # - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. 685 # - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values. 686 "startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch). 687 "issueType": "A String", # Form this outage is expected to take, which can take one of the following values: 688 # - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. 689 # - 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. 690 "endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch). 691 "name": "A String", # Unique identifier for this outage notification. 692 }, 693 ], 694 "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. 695 "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values: 696 # - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. 697 # - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. 698 # - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. 699 "location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned. 700 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 701 "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. 702 "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. 703 # 704 # To see the latest fingerprint, make a get() request to retrieve an Interconnect. 705 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 706 "operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: 707 # - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. 708 # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. 709 # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. 710 "interconnectType": "A String", # Type of interconnect, which can take one of the following values: 711 # - PARTNER: A partner-managed interconnection shared between customers though a partner. 712 # - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. 713 "kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects. 714 "provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect. 715 "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. 716 "googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. 717 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 718 "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer. 719 }, 720 ], 721 "warning": { # [Output Only] Informational warning message. 722 "message": "A String", # [Output Only] A human-readable description of the warning code. 723 "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. 724 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 725 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 726 { 727 "value": "A String", # [Output Only] A warning data value corresponding to the key. 728 "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). 729 }, 730 ], 731 }, 732 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 733 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 734 }</pre> 735</div> 736 737<div class="method"> 738 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 739 <pre>Retrieves the next page of results. 740 741Args: 742 previous_request: The request for the previous page. (required) 743 previous_response: The response from the request for the previous page. (required) 744 745Returns: 746 A request object that you can call 'execute()' on to request the next 747 page. Returns None if there are no more items in the collection. 748 </pre> 749</div> 750 751<div class="method"> 752 <code class="details" id="patch">patch(project, interconnect, body, requestId=None)</code> 753 <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. 754 755Args: 756 project: string, Project ID for this request. (required) 757 interconnect: string, Name of the interconnect to update. (required) 758 body: object, The request body. (required) 759 The object takes the form of: 760 761{ # Represents an Interconnect resource. 762 # 763 # An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) 764 "linkType": "A String", # Type of link requested, which can take one of the following values: 765 # - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics 766 # - 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. 767 "customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. 768 "circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. 769 { # Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. Next id: 4 770 "customerDemarcId": "A String", # Customer-side demarc ID for this circuit. 771 "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. 772 "googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up. 773 }, 774 ], 775 "labels": { # Labels to apply to this Interconnect resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. 776 "a_key": "A String", 777 }, 778 "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. 779 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 780 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 781 "interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. 782 "A String", 783 ], 784 "googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. 785 "expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect. 786 { # Description of a planned outage on this Interconnect. Next id: 9 787 "description": "A String", # A description about the purpose of the outage. 788 "affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected. 789 "A String", 790 ], 791 "source": "A String", # The party that generated this notification, which can take the following value: 792 # - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. 793 "state": "A String", # State of this notification, which can take one of the following values: 794 # - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. 795 # - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values. 796 "startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch). 797 "issueType": "A String", # Form this outage is expected to take, which can take one of the following values: 798 # - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. 799 # - 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. 800 "endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch). 801 "name": "A String", # Unique identifier for this outage notification. 802 }, 803 ], 804 "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. 805 "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values: 806 # - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. 807 # - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. 808 # - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. 809 "location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned. 810 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 811 "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. 812 "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. 813 # 814 # To see the latest fingerprint, make a get() request to retrieve an Interconnect. 815 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 816 "operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: 817 # - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. 818 # - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. 819 # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. 820 "interconnectType": "A String", # Type of interconnect, which can take one of the following values: 821 # - PARTNER: A partner-managed interconnection shared between customers though a partner. 822 # - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. 823 "kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects. 824 "provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect. 825 "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. 826 "googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. 827 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 828 "requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer. 829 } 830 831 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. 832 833For 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. 834 835The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 836 837Returns: 838 An object of the form: 839 840 { # Represents an Operation resource. 841 # 842 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 843 # 844 # Operations can be global, regional or zonal. 845 # - For global operations, use the globalOperations resource. 846 # - For regional operations, use the regionOperations resource. 847 # - For zonal operations, use the zonalOperations resource. 848 # 849 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 850 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 851 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 852 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 853 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 854 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 855 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 856 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 857 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 858 "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. 859 "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. 860 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 861 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 862 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 863 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 864 { 865 "message": "A String", # [Output Only] A human-readable description of the warning code. 866 "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. 867 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 868 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 869 { 870 "value": "A String", # [Output Only] A warning data value corresponding to the key. 871 "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). 872 }, 873 ], 874 }, 875 ], 876 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 877 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 878 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 879 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 880 "name": "A String", # [Output Only] Name of the resource. 881 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 882 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 883 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 884 { 885 "message": "A String", # [Output Only] An optional, human-readable error message. 886 "code": "A String", # [Output Only] The error type identifier for this error. 887 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 888 }, 889 ], 890 }, 891 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 892 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 893 "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. 894 }</pre> 895</div> 896 897<div class="method"> 898 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body)</code> 899 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. 900 901Args: 902 project: string, Project ID for this request. (required) 903 resource: string, Name or id of the resource for this request. (required) 904 body: object, The request body. (required) 905 The object takes the form of: 906 907{ 908 "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. 909 # 910 # 911 # 912 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. 913 # 914 # **JSON Example** 915 # 916 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } 917 # 918 # **YAML Example** 919 # 920 # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer 921 # 922 # 923 # 924 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). 925 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 926 { # 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. 927 # 928 # 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. 929 # 930 # Example Policy with multiple AuditConfigs: 931 # 932 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } 933 # 934 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. 935 "exemptedMembers": [ 936 "A String", 937 ], 938 "auditLogConfigs": [ # The configuration for logging of each type of permission. 939 { # Provides the configuration for logging a type of permissions. Example: 940 # 941 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 942 # 943 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. 944 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 945 "A String", 946 ], 947 "logType": "A String", # The log type that this config enables. 948 }, 949 ], 950 "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. 951 }, 952 ], 953 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. 954 { # A rule to be applied in a Policy. 955 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 956 { # Specifies what kind of log the caller must write 957 "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options. 958 # 959 # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. 960 # 961 # Field names correspond to IAM request parameters and field values are their respective values. 962 # 963 # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. 964 # 965 # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} 966 # 967 # At this time we do not support multiple field names (though this may be supported in the future). 968 "field": "A String", # The field value to attribute. 969 "metric": "A String", # The metric to update. 970 }, 971 "dataAccess": { # Write a Data Access (Gin) log # Data access options. 972 "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. 973 }, 974 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. 975 "logName": "A String", # The log_name to populate in the Cloud Audit Record. 976 "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline. 977 "permissionType": "A String", # The type of the permission that was checked. 978 }, 979 }, 980 }, 981 ], 982 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 983 "A String", 984 ], 985 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. 986 "A String", 987 ], 988 "action": "A String", # Required 989 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. 990 "A String", 991 ], 992 "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match. 993 { # A condition to be met. 994 "iam": "A String", # Trusted attributes supplied by the IAM system. 995 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 996 "values": [ # The objects of the condition. 997 "A String", 998 ], 999 "svc": "A String", # Trusted attributes discharged by the service. 1000 "op": "A String", # An operator to apply the subject with. 1001 }, 1002 ], 1003 "description": "A String", # Human-readable description of the rule. 1004 }, 1005 ], 1006 "version": 42, # Deprecated. 1007 "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. 1008 # 1009 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 1010 "bindings": [ # Associates a list of `members` to a `role`. `bindings` with no members will result in an error. 1011 { # Associates `members` with a `role`. 1012 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1013 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 1014 # 1015 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 1016 # 1017 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 1018 # 1019 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . 1020 # 1021 # 1022 # 1023 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 1024 # 1025 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 1026 # 1027 # 1028 # 1029 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 1030 "A String", 1031 ], 1032 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 1033 # 1034 # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" 1035 "title": "A String", # An 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. 1036 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1037 # 1038 # The application context of the containing message determines which well-known feature set of CEL is supported. 1039 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1040 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1041 }, 1042 }, 1043 ], 1044 "iamOwned": True or False, 1045 }, 1046 "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. 1047 { # Associates `members` with a `role`. 1048 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1049 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 1050 # 1051 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 1052 # 1053 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 1054 # 1055 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . 1056 # 1057 # 1058 # 1059 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 1060 # 1061 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 1062 # 1063 # 1064 # 1065 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 1066 "A String", 1067 ], 1068 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 1069 # 1070 # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" 1071 "title": "A String", # An 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. 1072 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1073 # 1074 # The application context of the containing message determines which well-known feature set of CEL is supported. 1075 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1076 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1077 }, 1078 }, 1079 ], 1080 "etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. 1081 } 1082 1083 1084Returns: 1085 An object of the form: 1086 1087 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. 1088 # 1089 # 1090 # 1091 # A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. 1092 # 1093 # **JSON Example** 1094 # 1095 # { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } 1096 # 1097 # **YAML Example** 1098 # 1099 # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer 1100 # 1101 # 1102 # 1103 # For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). 1104 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. 1105 { # 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. 1106 # 1107 # 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. 1108 # 1109 # Example Policy with multiple AuditConfigs: 1110 # 1111 # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } 1112 # 1113 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging. 1114 "exemptedMembers": [ 1115 "A String", 1116 ], 1117 "auditLogConfigs": [ # The configuration for logging of each type of permission. 1118 { # Provides the configuration for logging a type of permissions. Example: 1119 # 1120 # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } 1121 # 1122 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging. 1123 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. 1124 "A String", 1125 ], 1126 "logType": "A String", # The log type that this config enables. 1127 }, 1128 ], 1129 "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. 1130 }, 1131 ], 1132 "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. 1133 { # A rule to be applied in a Policy. 1134 "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. 1135 { # Specifies what kind of log the caller must write 1136 "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options. 1137 # 1138 # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. 1139 # 1140 # Field names correspond to IAM request parameters and field values are their respective values. 1141 # 1142 # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. 1143 # 1144 # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} 1145 # 1146 # At this time we do not support multiple field names (though this may be supported in the future). 1147 "field": "A String", # The field value to attribute. 1148 "metric": "A String", # The metric to update. 1149 }, 1150 "dataAccess": { # Write a Data Access (Gin) log # Data access options. 1151 "logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. 1152 }, 1153 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. 1154 "logName": "A String", # The log_name to populate in the Cloud Audit Record. 1155 "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline. 1156 "permissionType": "A String", # The type of the permission that was checked. 1157 }, 1158 }, 1159 }, 1160 ], 1161 "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. 1162 "A String", 1163 ], 1164 "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. 1165 "A String", 1166 ], 1167 "action": "A String", # Required 1168 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. 1169 "A String", 1170 ], 1171 "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match. 1172 { # A condition to be met. 1173 "iam": "A String", # Trusted attributes supplied by the IAM system. 1174 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. 1175 "values": [ # The objects of the condition. 1176 "A String", 1177 ], 1178 "svc": "A String", # Trusted attributes discharged by the service. 1179 "op": "A String", # An operator to apply the subject with. 1180 }, 1181 ], 1182 "description": "A String", # Human-readable description of the rule. 1183 }, 1184 ], 1185 "version": 42, # Deprecated. 1186 "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. 1187 # 1188 # If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly. 1189 "bindings": [ # Associates a list of `members` to a `role`. `bindings` with no members will result in an error. 1190 { # Associates `members` with a `role`. 1191 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. 1192 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: 1193 # 1194 # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. 1195 # 1196 # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. 1197 # 1198 # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` . 1199 # 1200 # 1201 # 1202 # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. 1203 # 1204 # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. 1205 # 1206 # 1207 # 1208 # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. 1209 "A String", 1210 ], 1211 "condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. 1212 # 1213 # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" 1214 "title": "A String", # An 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. 1215 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 1216 # 1217 # The application context of the containing message determines which well-known feature set of CEL is supported. 1218 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 1219 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 1220 }, 1221 }, 1222 ], 1223 "iamOwned": True or False, 1224 }</pre> 1225</div> 1226 1227<div class="method"> 1228 <code class="details" id="setLabels">setLabels(project, resource, body)</code> 1229 <pre>Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation. 1230 1231Args: 1232 project: string, Project ID for this request. (required) 1233 resource: string, Name or id of the resource for this request. (required) 1234 body: object, The request body. (required) 1235 The object takes the form of: 1236 1237{ 1238 "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. 1239 "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": ""). 1240 "a_key": "A String", 1241 }, 1242 } 1243 1244 1245Returns: 1246 An object of the form: 1247 1248 { # Represents an Operation resource. 1249 # 1250 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 1251 # 1252 # Operations can be global, regional or zonal. 1253 # - For global operations, use the globalOperations resource. 1254 # - For regional operations, use the regionOperations resource. 1255 # - For zonal operations, use the zonalOperations resource. 1256 # 1257 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 1258 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1259 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1260 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1261 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1262 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1263 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1264 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1265 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1266 "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. 1267 "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. 1268 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1269 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1270 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1271 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1272 { 1273 "message": "A String", # [Output Only] A human-readable description of the warning code. 1274 "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. 1275 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1276 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1277 { 1278 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1279 "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). 1280 }, 1281 ], 1282 }, 1283 ], 1284 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1285 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 1286 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1287 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1288 "name": "A String", # [Output Only] Name of the resource. 1289 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1290 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1291 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1292 { 1293 "message": "A String", # [Output Only] An optional, human-readable error message. 1294 "code": "A String", # [Output Only] The error type identifier for this error. 1295 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1296 }, 1297 ], 1298 }, 1299 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1300 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1301 "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. 1302 }</pre> 1303</div> 1304 1305<div class="method"> 1306 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code> 1307 <pre>Returns permissions that a caller has on the specified resource. 1308 1309Args: 1310 project: string, Project ID for this request. (required) 1311 resource: string, Name or id of the resource for this request. (required) 1312 body: object, The request body. (required) 1313 The object takes the form of: 1314 1315{ 1316 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 1317 "A String", 1318 ], 1319 } 1320 1321 1322Returns: 1323 An object of the form: 1324 1325 { 1326 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 1327 "A String", 1328 ], 1329 }</pre> 1330</div> 1331 1332</body></html>