delete(project, interconnect, requestId=None)
Deletes the specified interconnect.
Returns the specified interconnect. Get a list of available interconnects by making a list() request.
getDiagnostics(project, interconnect)
Returns the interconnectDiagnostics for the specified interconnect.
insert(project, body, requestId=None)
Creates a Interconnect in the specified project using the data included in the request.
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)
Retrieves the list of interconnect available to the specified project.
list_next(previous_request, previous_response)
Retrieves the next page of results.
patch(project, interconnect, body, requestId=None)
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.
delete(project, interconnect, requestId=None)
Deletes the specified interconnect.
Args:
project: string, Project ID for this request. (required)
interconnect: string, Name of the interconnect to delete. (required)
requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Returns:
An object of the form:
{ # Represents an Operation resource.
#
# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
#
# Operations can be global, regional or zonal.
# - For global operations, use the globalOperations resource.
# - For regional operations, use the regionOperations resource.
# - For zonal operations, use the zonalOperations resource.
#
# For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
"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.
"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.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
"message": "A String", # [Output Only] A human-readable description of the warning code.
"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.
"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"value": "A String", # [Output Only] A warning data value corresponding to the key.
"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).
},
],
},
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"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.
}
get(project, interconnect)
Returns the specified interconnect. Get a list of available interconnects by making a list() request.
Args:
project: string, Project ID for this request. (required)
interconnect: string, Name of the interconnect to return. (required)
Returns:
An object of the form:
{ # Represents an Interconnect resource.
#
# An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==)
"linkType": "A String", # Type of link requested, which can take one of the following values:
# - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
# - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.
"customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
"circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
{ # 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
"customerDemarcId": "A String", # Customer-side demarc ID for this circuit.
"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.
"googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
},
],
"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.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
"A String",
],
"googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
"expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect.
{ # Description of a planned outage on this Interconnect. Next id: 9
"description": "A String", # A description about the purpose of the outage.
"affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.
"A String",
],
"source": "A String", # The party that generated this notification, which can take the following value:
# - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.
"state": "A String", # State of this notification, which can take one of the following values:
# - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling.
# - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values.
"startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch).
"issueType": "A String", # Form this outage is expected to take, which can take one of the following values:
# - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.
# - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values.
"endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch).
"name": "A String", # Unique identifier for this outage notification.
},
],
"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.
"state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values:
# - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect.
# - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect.
# - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
"location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"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.
"operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values:
# - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
# - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
# - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
"interconnectType": "A String", # Type of interconnect, which can take one of the following values:
# - PARTNER: A partner-managed interconnection shared between customers though a partner.
# - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
"kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects.
"provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect.
"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.
"googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer.
}
getDiagnostics(project, interconnect)
Returns the interconnectDiagnostics for the specified interconnect.
Args:
project: string, Project ID for this request. (required)
interconnect: string, Name of the interconnect resource to query. (required)
Returns:
An object of the form:
{ # Response for the InterconnectsGetDiagnosticsRequest.
"result": { # Diagnostics information about interconnect, contains detailed and current technical information about Google?s side of the connection.
"macAddress": "A String", # The MAC address of the Interconnect's bundle interface.
"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.
{ # Describing the ARP neighbor entries seen on this link
"macAddress": "A String", # The MAC address of this ARP neighbor.
"ipAddress": "A String", # The IP address of this ARP neighbor.
},
],
"links": [ # A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect.
{
"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
{ # Describing the ARP neighbor entries seen on this link
"macAddress": "A String", # The MAC address of this ARP neighbor.
"ipAddress": "A String", # The IP address of this ARP neighbor.
},
],
"circuitId": "A String", # The unique ID for this link assigned during turn up by Google.
"receivingOpticalPower": { # An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level.
"state": "A String", # The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include:
# - OK: The value has not crossed a warning threshold.
# - LOW_WARNING: The value has crossed below the low warning threshold.
# - HIGH_WARNING: The value has crossed above the high warning threshold.
# - LOW_ALARM: The value has crossed below the low alarm threshold.
# - HIGH_ALARM: The value has crossed above the high alarm threshold.
"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.
},
"googleDemarc": "A String", # The Demarc address assigned by Google and provided in the LoA.
"lacpStatus": {
"neighborSystemId": "A String", # System ID of the port on the neighbor?s side of the LACP exchange.
"state": "A String", # The state of a LACP link, which can take one of the following values:
# - ACTIVE: The link is configured and active within the bundle.
# - DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty.
"googleSystemId": "A String", # System ID of the port on Google?s side of the LACP exchange.
},
"transmittingOpticalPower": { # An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the transmitted light level.
"state": "A String", # The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include:
# - OK: The value has not crossed a warning threshold.
# - LOW_WARNING: The value has crossed below the low warning threshold.
# - HIGH_WARNING: The value has crossed above the high warning threshold.
# - LOW_ALARM: The value has crossed below the low alarm threshold.
# - HIGH_ALARM: The value has crossed above the high alarm threshold.
"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.
},
},
],
},
}
insert(project, body, requestId=None)
Creates a Interconnect in the specified project using the data included in the request.
Args:
project: string, Project ID for this request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Represents an Interconnect resource.
#
# An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==)
"linkType": "A String", # Type of link requested, which can take one of the following values:
# - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
# - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.
"customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
"circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
{ # 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
"customerDemarcId": "A String", # Customer-side demarc ID for this circuit.
"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.
"googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
},
],
"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.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
"A String",
],
"googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
"expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect.
{ # Description of a planned outage on this Interconnect. Next id: 9
"description": "A String", # A description about the purpose of the outage.
"affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.
"A String",
],
"source": "A String", # The party that generated this notification, which can take the following value:
# - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.
"state": "A String", # State of this notification, which can take one of the following values:
# - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling.
# - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values.
"startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch).
"issueType": "A String", # Form this outage is expected to take, which can take one of the following values:
# - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.
# - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values.
"endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch).
"name": "A String", # Unique identifier for this outage notification.
},
],
"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.
"state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values:
# - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect.
# - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect.
# - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
"location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"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.
"operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values:
# - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
# - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
# - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
"interconnectType": "A String", # Type of interconnect, which can take one of the following values:
# - PARTNER: A partner-managed interconnection shared between customers though a partner.
# - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
"kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects.
"provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect.
"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.
"googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer.
}
requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Returns:
An object of the form:
{ # Represents an Operation resource.
#
# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
#
# Operations can be global, regional or zonal.
# - For global operations, use the globalOperations resource.
# - For regional operations, use the regionOperations resource.
# - For zonal operations, use the zonalOperations resource.
#
# For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
"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.
"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.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
"message": "A String", # [Output Only] A human-readable description of the warning code.
"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.
"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"value": "A String", # [Output Only] A warning data value corresponding to the key.
"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).
},
],
},
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"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.
}
list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)
Retrieves the list of interconnect available to the specified project.
Args:
project: string, Project ID for this request. (required)
orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
Currently, only sorting by name or creationTimestamp desc is supported.
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)
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.
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 <.
For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
Returns:
An object of the form:
{ # Response to the list request, and contains a list of interconnects.
"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.
"kind": "compute#interconnectList", # [Output Only] Type of resource. Always compute#interconnectList for lists of interconnects.
"items": [ # A list of Interconnect resources.
{ # Represents an Interconnect resource.
#
# An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==)
"linkType": "A String", # Type of link requested, which can take one of the following values:
# - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
# - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.
"customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
"circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
{ # 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
"customerDemarcId": "A String", # Customer-side demarc ID for this circuit.
"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.
"googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
},
],
"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.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
"A String",
],
"googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
"expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect.
{ # Description of a planned outage on this Interconnect. Next id: 9
"description": "A String", # A description about the purpose of the outage.
"affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.
"A String",
],
"source": "A String", # The party that generated this notification, which can take the following value:
# - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.
"state": "A String", # State of this notification, which can take one of the following values:
# - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling.
# - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values.
"startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch).
"issueType": "A String", # Form this outage is expected to take, which can take one of the following values:
# - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.
# - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values.
"endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch).
"name": "A String", # Unique identifier for this outage notification.
},
],
"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.
"state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values:
# - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect.
# - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect.
# - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
"location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"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.
"operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values:
# - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
# - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
# - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
"interconnectType": "A String", # Type of interconnect, which can take one of the following values:
# - PARTNER: A partner-managed interconnection shared between customers though a partner.
# - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
"kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects.
"provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect.
"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.
"googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer.
},
],
"warning": { # [Output Only] Informational warning message.
"message": "A String", # [Output Only] A human-readable description of the warning code.
"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.
"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"value": "A String", # [Output Only] A warning data value corresponding to the key.
"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).
},
],
},
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}
list_next(previous_request, previous_response)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(project, interconnect, body, requestId=None)
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.
Args:
project: string, Project ID for this request. (required)
interconnect: string, Name of the interconnect to update. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Represents an Interconnect resource.
#
# An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==)
"linkType": "A String", # Type of link requested, which can take one of the following values:
# - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
# - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.
"customerName": "A String", # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
"circuitInfos": [ # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
{ # 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
"customerDemarcId": "A String", # Customer-side demarc ID for this circuit.
"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.
"googleCircuitId": "A String", # Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
},
],
"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.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"interconnectAttachments": [ # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
"A String",
],
"googleIpAddress": "A String", # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
"expectedOutages": [ # [Output Only] A list of outages expected for this Interconnect.
{ # Description of a planned outage on this Interconnect. Next id: 9
"description": "A String", # A description about the purpose of the outage.
"affectedCircuits": [ # If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.
"A String",
],
"source": "A String", # The party that generated this notification, which can take the following value:
# - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.
"state": "A String", # State of this notification, which can take one of the following values:
# - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling.
# - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values.
"startTime": "A String", # Scheduled start time for the outage (milliseconds since Unix epoch).
"issueType": "A String", # Form this outage is expected to take, which can take one of the following values:
# - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.
# - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values.
"endTime": "A String", # Scheduled end time for the outage (milliseconds since Unix epoch).
"name": "A String", # Unique identifier for this outage notification.
},
],
"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.
"state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values:
# - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect.
# - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect.
# - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
"location": "A String", # URL of the InterconnectLocation object that represents where this connection is to be provisioned.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"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.
"operationalStatus": "A String", # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values:
# - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
# - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
# - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
"interconnectType": "A String", # Type of interconnect, which can take one of the following values:
# - PARTNER: A partner-managed interconnection shared between customers though a partner.
# - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
"kind": "compute#interconnect", # [Output Only] Type of the resource. Always compute#interconnect for interconnects.
"provisionedLinkCount": 42, # [Output Only] Number of links actually provisioned in this interconnect.
"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.
"googleReferenceId": "A String", # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"requestedLinkCount": 42, # Target number of physical links in the link bundle, as requested by the customer.
}
requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Returns:
An object of the form:
{ # Represents an Operation resource.
#
# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
#
# Operations can be global, regional or zonal.
# - For global operations, use the globalOperations resource.
# - For regional operations, use the regionOperations resource.
# - For zonal operations, use the zonalOperations resource.
#
# For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
"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.
"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.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
"message": "A String", # [Output Only] A human-readable description of the warning code.
"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.
"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"value": "A String", # [Output Only] A warning data value corresponding to the key.
"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).
},
],
},
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"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.
}