| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.networks.html">networks</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#addPeering">addPeering(project, network, body=None, requestId=None)</a></code></p> |
| <p class="firstline">Adds a peering to the specified network.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(project, network, requestId=None)</a></code></p> |
| <p class="firstline">Deletes the specified network.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(project, network)</a></code></p> |
| <p class="firstline">Returns the specified network. Gets a list of available networks by making a list() request.</p> |
| <p class="toc_element"> |
| <code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p> |
| <p class="firstline">Creates a network in the specified project using the data included in the request.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p> |
| <p class="firstline">Retrieves the list of networks available to the specified project.</p> |
| <p class="toc_element"> |
| <code><a href="#listPeeringRoutes">listPeeringRoutes(project, network, direction=None, filter=None, maxResults=None, orderBy=None, pageToken=None, peeringName=None, region=None)</a></code></p> |
| <p class="firstline">Lists the peering routes exchanged over peering connection.</p> |
| <p class="toc_element"> |
| <code><a href="#listPeeringRoutes_next">listPeeringRoutes_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(project, network, body=None, requestId=None)</a></code></p> |
| <p class="firstline">Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode.</p> |
| <p class="toc_element"> |
| <code><a href="#removePeering">removePeering(project, network, body=None, requestId=None)</a></code></p> |
| <p class="firstline">Removes a peering from the specified network.</p> |
| <p class="toc_element"> |
| <code><a href="#switchToCustomMode">switchToCustomMode(project, network, requestId=None)</a></code></p> |
| <p class="firstline">Switches the network mode from auto subnet mode to custom subnet mode.</p> |
| <p class="toc_element"> |
| <code><a href="#updatePeering">updatePeering(project, network, body=None, requestId=None)</a></code></p> |
| <p class="firstline">Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="addPeering">addPeering(project, network, body=None, requestId=None)</code> |
| <pre>Adds a peering to the specified network. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| network: string, Name of the network resource to add peering to. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "autoCreateRoutes": True or False, # This field will be deprecated soon. Use exchange_subnet_routes in network_peering instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. |
| "name": "A String", # Name of the peering, which should conform to RFC1035. |
| "networkPeering": { # A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering. # Network peering parameters. In order to specify route policies for peering using import and export custom routes, you must specify all peering related parameters (name, peer network, exchange_subnet_routes) in the network_peering field. The corresponding fields in NetworksAddPeeringRequest will be deprecated soon. |
| "autoCreateRoutes": True or False, # This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. |
| "exchangeSubnetRoutes": True or False, # Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. |
| "exportCustomRoutes": True or False, # Whether to export the custom routes to peer network. |
| "exportSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field. |
| "importCustomRoutes": True or False, # Whether to import the custom routes from peer network. |
| "importSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are imported. The default value is false. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported from peers and are not controlled by this field. |
| "name": "A String", # Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. |
| "network": "A String", # The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. |
| "state": "A String", # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network. |
| "stateDetails": "A String", # [Output Only] Details about the current state of the peering. |
| }, |
| "peerNetwork": "A String", # URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. |
| } |
| |
| 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. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # - For global operations, use the `globalOperations` resource. |
| # - For regional operations, use the `regionOperations` resource. |
| # - For zonal operations, use the `zonalOperations` resource. |
| # |
| # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| "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. |
| "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| "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. |
| { |
| "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. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. 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 operation. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target 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. |
| "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| { |
| "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" } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(project, network, requestId=None)</code> |
| <pre>Deletes the specified network. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| network: string, Name of the network 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. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # - For global operations, use the `globalOperations` resource. |
| # - For regional operations, use the `regionOperations` resource. |
| # - For zonal operations, use the `zonalOperations` resource. |
| # |
| # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| "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. |
| "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| "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. |
| { |
| "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. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. 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 operation. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target 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. |
| "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| { |
| "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" } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(project, network)</code> |
| <pre>Returns the specified network. Gets a list of available networks by making a list() request. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| network: string, Name of the network to return. (required) |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents a VPC Network resource. |
| # |
| # Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for {$api_version}.networks ==) |
| "IPv4Range": "A String", # Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created. |
| "autoCreateSubnetworks": True or False, # When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. |
| # |
| # An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. |
| # |
| # For custom mode VPC networks, you can add subnets using the subnetworks insert method. |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "description": "A String", # An optional description of this resource. Provide this field when you create the resource. |
| "gatewayIPv4": "A String", # [Output Only] The gateway address for default routing out of the network, selected by GCP. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks. |
| "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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. |
| "peerings": [ # [Output Only] A list of network peerings for the resource. |
| { # A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering. |
| "autoCreateRoutes": True or False, # This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. |
| "exchangeSubnetRoutes": True or False, # Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. |
| "exportCustomRoutes": True or False, # Whether to export the custom routes to peer network. |
| "exportSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field. |
| "importCustomRoutes": True or False, # Whether to import the custom routes from peer network. |
| "importSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are imported. The default value is false. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported from peers and are not controlled by this field. |
| "name": "A String", # Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. |
| "network": "A String", # The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. |
| "state": "A String", # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network. |
| "stateDetails": "A String", # [Output Only] Details about the current state of the peering. |
| }, |
| ], |
| "routingConfig": { # A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide. # The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce. |
| "routingMode": "A String", # The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions. |
| }, |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="insert">insert(project, body=None, requestId=None)</code> |
| <pre>Creates a network 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. |
| The object takes the form of: |
| |
| { # Represents a VPC Network resource. |
| # |
| # Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for {$api_version}.networks ==) |
| "IPv4Range": "A String", # Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created. |
| "autoCreateSubnetworks": True or False, # When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. |
| # |
| # An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. |
| # |
| # For custom mode VPC networks, you can add subnets using the subnetworks insert method. |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "description": "A String", # An optional description of this resource. Provide this field when you create the resource. |
| "gatewayIPv4": "A String", # [Output Only] The gateway address for default routing out of the network, selected by GCP. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks. |
| "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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. |
| "peerings": [ # [Output Only] A list of network peerings for the resource. |
| { # A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering. |
| "autoCreateRoutes": True or False, # This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. |
| "exchangeSubnetRoutes": True or False, # Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. |
| "exportCustomRoutes": True or False, # Whether to export the custom routes to peer network. |
| "exportSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field. |
| "importCustomRoutes": True or False, # Whether to import the custom routes from peer network. |
| "importSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are imported. The default value is false. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported from peers and are not controlled by this field. |
| "name": "A String", # Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. |
| "network": "A String", # The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. |
| "state": "A String", # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network. |
| "stateDetails": "A String", # [Output Only] Details about the current state of the peering. |
| }, |
| ], |
| "routingConfig": { # A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide. # The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce. |
| "routingMode": "A String", # The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions. |
| }, |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. |
| "A String", |
| ], |
| } |
| |
| 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. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # - For global operations, use the `globalOperations` resource. |
| # - For regional operations, use the `regionOperations` resource. |
| # - For zonal operations, use the `zonalOperations` resource. |
| # |
| # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| "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. |
| "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| "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. |
| { |
| "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. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. 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 operation. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target 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. |
| "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| { |
| "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" } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</code> |
| <pre>Retrieves the list of networks available to the specified project. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| 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) ``` |
| 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`) |
| 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. |
| 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. |
| |
| Returns: |
| An object of the form: |
| |
| { # Contains a list of networks. |
| "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| "items": [ # A list of Network resources. |
| { # Represents a VPC Network resource. |
| # |
| # Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for {$api_version}.networks ==) |
| "IPv4Range": "A String", # Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created. |
| "autoCreateSubnetworks": True or False, # When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. |
| # |
| # An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. |
| # |
| # For custom mode VPC networks, you can add subnets using the subnetworks insert method. |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "description": "A String", # An optional description of this resource. Provide this field when you create the resource. |
| "gatewayIPv4": "A String", # [Output Only] The gateway address for default routing out of the network, selected by GCP. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks. |
| "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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. |
| "peerings": [ # [Output Only] A list of network peerings for the resource. |
| { # A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering. |
| "autoCreateRoutes": True or False, # This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. |
| "exchangeSubnetRoutes": True or False, # Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. |
| "exportCustomRoutes": True or False, # Whether to export the custom routes to peer network. |
| "exportSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field. |
| "importCustomRoutes": True or False, # Whether to import the custom routes from peer network. |
| "importSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are imported. The default value is false. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported from peers and are not controlled by this field. |
| "name": "A String", # Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. |
| "network": "A String", # The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. |
| "state": "A String", # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network. |
| "stateDetails": "A String", # [Output Only] Details about the current state of the peering. |
| }, |
| ], |
| "routingConfig": { # A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide. # The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce. |
| "routingMode": "A String", # The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions. |
| }, |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. |
| "A String", |
| ], |
| }, |
| ], |
| "kind": "compute#networkList", # [Output Only] Type of resource. Always compute#networkList for lists of networks. |
| "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. |
| "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| "warning": { # [Output Only] Informational warning message. |
| "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" } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listPeeringRoutes">listPeeringRoutes(project, network, direction=None, filter=None, maxResults=None, orderBy=None, pageToken=None, peeringName=None, region=None)</code> |
| <pre>Lists the peering routes exchanged over peering connection. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| network: string, Name of the network for this request. (required) |
| direction: string, The direction of the exchanged routes. |
| Allowed values |
| INCOMING - |
| OUTGOING - |
| 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) ``` |
| 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`) |
| 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. |
| 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. |
| peeringName: string, The response will show routes exchanged over the given peering connection. |
| region: string, The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region. |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| "items": [ # A list of ExchangedPeeringRoute resources. |
| { |
| "destRange": "A String", # The destination range of the route. |
| "imported": True or False, # True if the peering route has been imported from a peer. The actual import happens if the field networkPeering.importCustomRoutes is true for this network, and networkPeering.exportCustomRoutes is true for the peer network, and the import does not result in a route conflict. |
| "nextHopRegion": "A String", # The region of peering route next hop, only applies to dynamic routes. |
| "priority": 42, # The priority of the peering route. |
| "type": "A String", # The type of the peering route. |
| }, |
| ], |
| "kind": "compute#exchangedPeeringRoutesList", # [Output Only] Type of resource. Always compute#exchangedPeeringRoutesList for exchanged peering routes lists. |
| "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. |
| "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| "warning": { # [Output Only] Informational warning message. |
| "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" } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listPeeringRoutes_next">listPeeringRoutes_next(previous_request, previous_response)</code> |
| <pre>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. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>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. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(project, network, body=None, requestId=None)</code> |
| <pre>Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| network: string, Name of the network to update. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Represents a VPC Network resource. |
| # |
| # Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for {$api_version}.networks ==) |
| "IPv4Range": "A String", # Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created. |
| "autoCreateSubnetworks": True or False, # When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. |
| # |
| # An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. |
| # |
| # For custom mode VPC networks, you can add subnets using the subnetworks insert method. |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "description": "A String", # An optional description of this resource. Provide this field when you create the resource. |
| "gatewayIPv4": "A String", # [Output Only] The gateway address for default routing out of the network, selected by GCP. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks. |
| "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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. |
| "peerings": [ # [Output Only] A list of network peerings for the resource. |
| { # A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering. |
| "autoCreateRoutes": True or False, # This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. |
| "exchangeSubnetRoutes": True or False, # Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. |
| "exportCustomRoutes": True or False, # Whether to export the custom routes to peer network. |
| "exportSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field. |
| "importCustomRoutes": True or False, # Whether to import the custom routes from peer network. |
| "importSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are imported. The default value is false. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported from peers and are not controlled by this field. |
| "name": "A String", # Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. |
| "network": "A String", # The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. |
| "state": "A String", # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network. |
| "stateDetails": "A String", # [Output Only] Details about the current state of the peering. |
| }, |
| ], |
| "routingConfig": { # A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide. # The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce. |
| "routingMode": "A String", # The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions. |
| }, |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. |
| "A String", |
| ], |
| } |
| |
| 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. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # - For global operations, use the `globalOperations` resource. |
| # - For regional operations, use the `regionOperations` resource. |
| # - For zonal operations, use the `zonalOperations` resource. |
| # |
| # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| "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. |
| "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| "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. |
| { |
| "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. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. 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 operation. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target 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. |
| "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| { |
| "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" } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="removePeering">removePeering(project, network, body=None, requestId=None)</code> |
| <pre>Removes a peering from the specified network. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| network: string, Name of the network resource to remove peering from. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "name": "A String", # Name of the peering, which should conform to RFC1035. |
| } |
| |
| 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. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # - For global operations, use the `globalOperations` resource. |
| # - For regional operations, use the `regionOperations` resource. |
| # - For zonal operations, use the `zonalOperations` resource. |
| # |
| # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| "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. |
| "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| "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. |
| { |
| "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. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. 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 operation. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target 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. |
| "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| { |
| "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" } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="switchToCustomMode">switchToCustomMode(project, network, requestId=None)</code> |
| <pre>Switches the network mode from auto subnet mode to custom subnet mode. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| network: string, Name of the network to be updated. (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. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # - For global operations, use the `globalOperations` resource. |
| # - For regional operations, use the `regionOperations` resource. |
| # - For zonal operations, use the `zonalOperations` resource. |
| # |
| # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| "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. |
| "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| "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. |
| { |
| "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. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. 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 operation. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target 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. |
| "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| { |
| "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" } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="updatePeering">updatePeering(project, network, body=None, requestId=None)</code> |
| <pre>Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| network: string, Name of the network resource which the updated peering is belonging to. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "networkPeering": { # A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering. |
| "autoCreateRoutes": True or False, # This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. |
| "exchangeSubnetRoutes": True or False, # Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE. |
| "exportCustomRoutes": True or False, # Whether to export the custom routes to peer network. |
| "exportSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field. |
| "importCustomRoutes": True or False, # Whether to import the custom routes from peer network. |
| "importSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are imported. The default value is false. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported from peers and are not controlled by this field. |
| "name": "A String", # Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. |
| "network": "A String", # The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. |
| "state": "A String", # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network. |
| "stateDetails": "A String", # [Output Only] Details about the current state of the peering. |
| }, |
| } |
| |
| 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. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| # |
| # Operations can be global, regional or zonal. |
| # - For global operations, use the `globalOperations` resource. |
| # - For regional operations, use the `regionOperations` resource. |
| # - For zonal operations, use the `zonalOperations` resource. |
| # |
| # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| "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. |
| "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| "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. |
| { |
| "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. |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| }, |
| ], |
| }, |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| "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. |
| "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. 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 operation. |
| "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| "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. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target 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. |
| "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| { |
| "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" } |
| { |
| "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). |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| }, |
| ], |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| }, |
| ], |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| }</pre> |
| </div> |
| |
| </body></html> |
