| <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_beta.html">Compute Engine API</a> . <a href="compute_beta.networks.html">networks</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#addPeering">addPeering(project, network, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Adds a peering to the specified network.</p> |
| <p class="toc_element"> |
| <code><a href="#cancelRequestRemovePeering">cancelRequestRemovePeering(project, network, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Cancel requests to remove a peering from the specified network. Applicable</p> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(project, network, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes the specified network.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(project, network, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns the specified network.</p> |
| <p class="toc_element"> |
| <code><a href="#getEffectiveFirewalls">getEffectiveFirewalls(project, network, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns the effective firewalls on a given network.</p> |
| <p class="toc_element"> |
| <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a network in the specified project using the data included</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=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, returnPartialSuccess=None, x__xgafv=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()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</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, x__xgafv=None)</a></code></p> |
| <p class="firstline">Patches the specified network with the data included in the request.</p> |
| <p class="toc_element"> |
| <code><a href="#removePeering">removePeering(project, network, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Removes a peering from the specified network.</p> |
| <p class="toc_element"> |
| <code><a href="#requestRemovePeering">requestRemovePeering(project, network, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Requests to remove a peering from the specified network. Applicable only</p> |
| <p class="toc_element"> |
| <code><a href="#switchToCustomMode">switchToCustomMode(project, network, requestId=None, x__xgafv=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="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns permissions that a caller has on the specified resource.</p> |
| <p class="toc_element"> |
| <code><a href="#updatePeering">updatePeering(project, network, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates the specified network peering with the data included in the</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="addPeering">addPeering(project, network, body=None, requestId=None, x__xgafv=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. Useexchange_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 isACTIVE. |
| "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 # 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. |
| # 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 theexchange_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 isACTIVE. |
| "connectionStatus": { # [Output Only] Describes the state of a peering connection, not just the # Output only. [Output Only] The effective state of the peering connection |
| # as a whole. |
| # local peering. This field provides information about the effective settings |
| # for the connection as a whole, including pending delete/update requests for |
| # CONSENSUS peerings. |
| "consensusState": { # The status of update/delete for a consensus peering connection. Only set # The consensus state contains information about the status of update |
| # and delete for a consensus peering connection. |
| # when connection_status.update_strategy isCONSENSUS or a network peering is proposing to update the |
| # strategy to CONSENSUS. |
| "deleteStatus": "A String", # The status of the delete request. |
| "updateStatus": "A String", # The status of the update request. |
| }, |
| "trafficConfiguration": { # The active connectivity settings for the peering connection based on the |
| # settings of the network peerings. |
| "exportCustomRoutesToPeer": True or False, # Whether custom routes are being exported to the peer network. |
| "exportSubnetRoutesWithPublicIpToPeer": True or False, # Whether subnet routes with public IP ranges are being exported to the |
| # peer network. |
| "importCustomRoutesFromPeer": True or False, # Whether custom routes are being imported from the peer network. |
| "importSubnetRoutesWithPublicIpFromPeer": True or False, # Whether subnet routes with public IP ranges are being imported |
| # from the peer network. |
| "stackType": "A String", # Which IP version(s) of traffic and routes are being imported or |
| # exported between peer networks. |
| }, |
| "updateStrategy": "A String", # The update strategy determines the update/delete semantics for this |
| # peering connection. |
| }, |
| "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 isACTIVE. |
| "exportCustomRoutes": True or False, # Whether to export the custom routes to peer network. The default value is |
| # false. |
| "exportSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are exported. The default value |
| # is true, all subnet routes are exported.IPv4 |
| # special-use ranges 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. The default value is |
| # false. |
| "importSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are imported. The default value |
| # is false.IPv4 |
| # special-use ranges 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 withRFC1035. |
| # 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. |
| "peerMtu": 42, # Output only. [Output Only] Maximum Transmission Unit in bytes of the peer network. |
| "stackType": "A String", # Which IP version(s) of traffic and routes are allowed to be imported or |
| # exported between peer networks. The default value is IPV4_ONLY. |
| "state": "A String", # Output only. [Output Only] State for the peering. |
| "stateDetails": "A String", # Output only. [Output Only] Details about the current state of the peering. |
| "updateStrategy": "A String", # The update strategy determines the semantics for updates and deletes to the |
| # peering connection configuration. |
| }, |
| "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). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # 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 `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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 inRFC3339 |
| # 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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "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. |
| }, |
| ], |
| }, |
| "getVersionOperationMetadata": { |
| "inlineSbomInfo": { |
| "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component |
| # name and the value is the version. |
| "a_key": "A String", |
| }, |
| "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the |
| # component name and the value is the version. |
| "a_key": "A String", |
| }, |
| }, |
| }, |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `user@example.com` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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="cancelRequestRemovePeering">cancelRequestRemovePeering(project, network, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Cancel requests to remove a peering from the specified network. Applicable |
| only for PeeringConnection with update_strategy=CONSENSUS. Cancels a |
| request to remove 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). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # 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 `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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 inRFC3339 |
| # 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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "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. |
| }, |
| ], |
| }, |
| "getVersionOperationMetadata": { |
| "inlineSbomInfo": { |
| "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component |
| # name and the value is the version. |
| "a_key": "A String", |
| }, |
| "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the |
| # component name and the value is the version. |
| "a_key": "A String", |
| }, |
| }, |
| }, |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `user@example.com` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(project, network, requestId=None, x__xgafv=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). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # 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 `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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 inRFC3339 |
| # 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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "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. |
| }, |
| ], |
| }, |
| "getVersionOperationMetadata": { |
| "inlineSbomInfo": { |
| "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component |
| # name and the value is the version. |
| "a_key": "A String", |
| }, |
| "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the |
| # component name and the value is the version. |
| "a_key": "A String", |
| }, |
| }, |
| }, |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `user@example.com` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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, x__xgafv=None)</code> |
| <pre>Returns the specified network. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| network: string, Name of the network to return. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents a VPC Network resource. |
| # |
| # Networks connect resources to each other and to the internet. For more |
| # information, readVirtual Private Cloud (VPC) Network. |
| "IPv4Range": "A String", # Deprecated in favor of subnet mode networks. |
| # The range of internal addresses that are legal on this network. This |
| # range is aCIDR specification, for example:192.168.0.0/16. Provided by the client when the network is |
| # created. |
| "autoCreateSubnetworks": True or False, # Must be set to create a VPC network. If not set, a legacy network is |
| # created. |
| # |
| # 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 inAuto mode VPC network IP ranges. |
| # |
| # For custom mode VPC networks, you can add subnets using the subnetworksinsert |
| # method. |
| "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 |
| # text format. |
| "description": "A String", # An optional description of this resource. Provide this field when you |
| # create the resource. |
| "enableUlaInternalIpv6": True or False, # Enable ULA internal ipv6 on this network. Enabling this feature will assign |
| # a /48 from google defined ULA prefix fd20::/20. |
| # . |
| "firewallPolicy": "A String", # Output only. [Output Only] URL of the firewall policy the network is associated with. |
| "gatewayIPv4": "A String", # [Output Only] The gateway address for default routing out of the network, |
| # selected by Google Cloud. |
| "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is |
| # defined by the server. |
| "internalIpv6Range": "A String", # When enabling ula internal ipv6, caller optionally can specify the /48 |
| # range they want from the google defined ULA prefix fd20::/20. The input |
| # must be a valid /48 ULA IPv6 address and must be within the fd20::/20. |
| # Operation will fail if the speficied /48 is already in used by another |
| # resource. If the field is not speficied, then a /48 range will be randomly |
| # allocated from fd20::/20 and returned via this field. |
| # . |
| "kind": "compute#network", # Output only. [Output Only] Type of the resource. Always compute#network for |
| # networks. |
| "mtu": 42, # Maximum Transmission Unit in bytes. |
| # The minimum value for this field is 1300 and the maximum value is 8896. |
| # The suggested value is 1500, which is the default MTU used on the |
| # Internet, or 8896 if you want to use Jumbo frames. If unspecified, the |
| # value defaults to 1460. |
| "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 withRFC1035. |
| # 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. |
| "networkFirewallPolicyEnforcementOrder": "A String", # The network firewall policy enforcement order. Can be either |
| # AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to |
| # AFTER_CLASSIC_FIREWALL if the field is not specified. |
| "networkProfile": "A String", # A full or partial URL of the network profile to apply to this network. |
| # This field can be set only at resource creation time. For example, the |
| # following are valid URLs: |
| # |
| # - https://www.googleapis.com/compute/{api_version}/projects/{project_id}/global/networkProfiles/{network_profile_name} |
| # - projects/{project_id}/global/networkProfiles/{network_profile_name} |
| "params": { # Additional network parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted |
| # as part of resource payload. |
| "resourceManagerTags": { # Tag keys/values directly bound to this resource. |
| # Tag keys and values have the same definition as resource |
| # manager tags. The field is allowed for INSERT |
| # only. The keys/values to set on the resource should be specified in |
| # either ID { : } or Namespaced format |
| # { : }. |
| # For example the following are valid inputs: |
| # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} |
| # * {"123/environment" : "production", "345/abc" : "xyz"} |
| # Note: |
| # * Invalid combinations of ID & namespaced format is not supported. For |
| # instance: {"123/environment" : "tagValues/444"} is invalid. |
| "a_key": "A String", |
| }, |
| }, |
| "peerings": [ # Output only. [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 theexchange_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 isACTIVE. |
| "connectionStatus": { # [Output Only] Describes the state of a peering connection, not just the # Output only. [Output Only] The effective state of the peering connection |
| # as a whole. |
| # local peering. This field provides information about the effective settings |
| # for the connection as a whole, including pending delete/update requests for |
| # CONSENSUS peerings. |
| "consensusState": { # The status of update/delete for a consensus peering connection. Only set # The consensus state contains information about the status of update |
| # and delete for a consensus peering connection. |
| # when connection_status.update_strategy isCONSENSUS or a network peering is proposing to update the |
| # strategy to CONSENSUS. |
| "deleteStatus": "A String", # The status of the delete request. |
| "updateStatus": "A String", # The status of the update request. |
| }, |
| "trafficConfiguration": { # The active connectivity settings for the peering connection based on the |
| # settings of the network peerings. |
| "exportCustomRoutesToPeer": True or False, # Whether custom routes are being exported to the peer network. |
| "exportSubnetRoutesWithPublicIpToPeer": True or False, # Whether subnet routes with public IP ranges are being exported to the |
| # peer network. |
| "importCustomRoutesFromPeer": True or False, # Whether custom routes are being imported from the peer network. |
| "importSubnetRoutesWithPublicIpFromPeer": True or False, # Whether subnet routes with public IP ranges are being imported |
| # from the peer network. |
| "stackType": "A String", # Which IP version(s) of traffic and routes are being imported or |
| # exported between peer networks. |
| }, |
| "updateStrategy": "A String", # The update strategy determines the update/delete semantics for this |
| # peering connection. |
| }, |
| "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 isACTIVE. |
| "exportCustomRoutes": True or False, # Whether to export the custom routes to peer network. The default value is |
| # false. |
| "exportSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are exported. The default value |
| # is true, all subnet routes are exported.IPv4 |
| # special-use ranges 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. The default value is |
| # false. |
| "importSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are imported. The default value |
| # is false.IPv4 |
| # special-use ranges 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 withRFC1035. |
| # 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. |
| "peerMtu": 42, # Output only. [Output Only] Maximum Transmission Unit in bytes of the peer network. |
| "stackType": "A String", # Which IP version(s) of traffic and routes are allowed to be imported or |
| # exported between peer networks. The default value is IPV4_ONLY. |
| "state": "A String", # Output only. [Output Only] State for the peering. |
| "stateDetails": "A String", # Output only. [Output Only] Details about the current state of the peering. |
| "updateStrategy": "A String", # The update strategy determines the semantics for updates and deletes to the |
| # peering connection configuration. |
| }, |
| ], |
| "routingConfig": { # A routing configuration attached to a network resource. The message # The network-level routing configuration for this network. Used by Cloud |
| # Router to determine what type of network-wide routing behavior to enforce. |
| # includes the list of routers associated with the network, and a flag |
| # indicating the type of routing behavior to enforce network-wide. |
| "bgpAlwaysCompareMed": True or False, # Enable comparison of Multi-Exit Discriminators (MED) across routes with |
| # different neighbor ASNs when using the STANDARD BGP best path selection |
| # algorithm. |
| "bgpBestPathSelectionMode": "A String", # The BGP best path selection algorithm to be employed within this network |
| # for dynamic routes learned by Cloud Routers. Can be LEGACY |
| # (default) or STANDARD. |
| "bgpInterRegionCost": "A String", # Allows to define a preferred approach for handling inter-region cost in |
| # the selection process when using the STANDARD BGP best path |
| # selection algorithm. Can be DEFAULT orADD_COST_TO_MED. |
| "effectiveBgpAlwaysCompareMed": True or False, # Output only. [Output Only] Effective value of the bgp_always_compare_med |
| # field. |
| "effectiveBgpInterRegionCost": "A String", # Output only. [Output Only] Effective value of the bgp_inter_region_cost |
| # field. |
| "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 toGLOBAL, 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. |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. |
| "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="getEffectiveFirewalls">getEffectiveFirewalls(project, network, x__xgafv=None)</code> |
| <pre>Returns the effective firewalls on a given network. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| network: string, Name of the network for this request. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "firewallPolicys": [ # [Output Only] Effective firewalls from firewall policy. It returns Global |
| # Network Firewall Policies and Hierarchical Firewall Policies. UseregionNetworkFirewallPolicies.getEffectiveFirewalls to get |
| # Regional Network Firewall Policies as well. |
| { |
| "displayName": "A String", # Output only. [Output Only] Deprecated, please use short name instead. The display name |
| # of the firewall policy. |
| "name": "A String", # Output only. [Output Only] The name of the firewall policy. |
| "packetMirroringRules": [ # Output only. [Output Only] The packet mirroring rules that apply to the network. |
| { # Represents a rule that describes one or more match conditions along with |
| # the action to be taken when traffic matches this condition (allow or deny). |
| "action": "A String", # The Action to perform when the client connection triggers the rule. |
| # Valid actions for firewall rules are: "allow", "deny", |
| # "apply_security_profile_group" and "goto_next". |
| # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" |
| # and "goto_next". |
| "description": "A String", # An optional description for this resource. |
| "direction": "A String", # The direction in which this rule applies. |
| "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, |
| # the firewall policy rule is not enforced and traffic behaves as if it did |
| # not exist. If this is unspecified, the firewall policy rule will be |
| # enabled. |
| "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is |
| # enabled, logs will be exported to the configured export destination in |
| # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you |
| # cannot enable logging on "goto_next" rules. |
| "kind": "compute#firewallPolicyRule", # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules. |
| "match": { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against. |
| # If it evaluates to true, the corresponding 'action' is enforced. |
| # Exactly one field must be specified. |
| "destAddressGroups": [ # Address groups which should be matched against the traffic destination. |
| # Maximum number of destination address groups is 10. |
| "A String", |
| ], |
| "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against |
| # traffic destination. |
| # Maximum number of destination fqdn allowed is 100. |
| "A String", |
| ], |
| "destIpRanges": [ # CIDR IP address range. |
| # Maximum number of destination CIDR IP ranges allowed is 5000. |
| "A String", |
| ], |
| "destNetworkContext": "A String", # Network context of the traffic destination. Allowed values are: |
| # |
| # |
| # - UNSPECIFIED |
| # - INTERNET |
| # - NON_INTERNET |
| "destNetworkScope": "A String", # Network scope of the traffic destination. |
| "destNetworkType": "A String", # Network type of the traffic destination. Allowed values are: |
| # |
| # |
| # - UNSPECIFIED |
| # - INTERNET |
| # - NON_INTERNET |
| "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination |
| # of traffic. Should be specified as 2 letter country code defined as per |
| # ISO 3166 alpha-2 country codes. ex."US" |
| # Maximum number of dest region codes allowed is 5000. |
| "A String", |
| ], |
| "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. |
| # The IPs in these lists will be matched against traffic destination. |
| "A String", |
| ], |
| "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. |
| { |
| "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is |
| # required when creating a firewall rule. This value can either be |
| # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP |
| # protocol number. |
| "ports": [ # An optional list of ports to which this rule applies. This field is |
| # only applicable for UDP or TCP protocol. Each entry must be either |
| # an integer or a range. If not specified, this rule applies to |
| # connections through any port. |
| # |
| # Example inputs include: ["22"],["80","443"], and ["12345-12349"]. |
| "A String", |
| ], |
| }, |
| ], |
| "srcAddressGroups": [ # Address groups which should be matched against the traffic source. |
| # Maximum number of source address groups is 10. |
| "A String", |
| ], |
| "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against |
| # traffic source. |
| # Maximum number of source fqdn allowed is 100. |
| "A String", |
| ], |
| "srcIpRanges": [ # CIDR IP address range. |
| # Maximum number of source CIDR IP ranges allowed is 5000. |
| "A String", |
| ], |
| "srcNetworkContext": "A String", # Network context of the traffic source. Allowed values are: |
| # |
| # |
| # - UNSPECIFIED |
| # - INTERNET |
| # - INTRA_VPC |
| # - NON_INTERNET |
| # - VPC_NETWORKS |
| "srcNetworkScope": "A String", # Network scope of the traffic source. |
| "srcNetworkType": "A String", # Network type of the traffic source. Allowed values are: |
| # |
| # |
| # - UNSPECIFIED |
| # - INTERNET |
| # - INTRA_VPC |
| # - NON_INTERNET |
| # - VPC_NETWORKS |
| "srcNetworks": [ # Networks of the traffic source. It can be either a full or partial url. |
| "A String", |
| ], |
| "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source |
| # of traffic. Should be specified as 2 letter country code defined as per |
| # ISO 3166 alpha-2 country codes. ex."US" |
| # Maximum number of source region codes allowed is 5000. |
| "A String", |
| ], |
| "srcSecureTags": [ # List of secure tag values, which should be matched at the source |
| # of the traffic. |
| # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, |
| # and there is no srcIpRange, this rule will be ignored. |
| # Maximum number of source tag values allowed is 256. |
| { |
| "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. |
| "state": "A String", # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or |
| # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted |
| # or its network is deleted. |
| }, |
| ], |
| "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. |
| # The IPs in these lists will be matched against traffic source. |
| "A String", |
| ], |
| }, |
| "priority": 42, # An integer indicating the priority of a rule in the list. The priority |
| # must be a positive value between 0 and 2147483647. |
| # Rules are evaluated from highest to lowest priority where 0 is the |
| # highest priority and 2147483647 is the lowest priority. |
| "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier |
| # and can be updated. |
| "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy |
| # rule. |
| "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. |
| # Example: |
| # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group |
| # Must be specified if action is one of 'apply_security_profile_group' or |
| # 'mirror'. Cannot be specified for other actions. |
| "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. |
| # This field allows you to control which load balancers get this rule. |
| # For example, the following are valid values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule |
| # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule |
| # - projects/project/global/ |
| # forwardingRules/forwardingRule |
| # - projects/project/regions/region/forwardingRules/ |
| # forwardingRule |
| "A String", |
| ], |
| "targetResources": [ # A list of network resource URLs to which this rule applies. This field |
| # allows you to control which network's VMs get this rule. If this field |
| # is left blank, all VMs within the organization will receive the rule. |
| "A String", |
| ], |
| "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule |
| # applies to. If targetSecureTag are specified, then the |
| # firewall rule applies only to instances in the VPC network that have one |
| # of those EFFECTIVE secure tags, if all the target_secure_tag are in |
| # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts. |
| # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies |
| # to all instances on the specified network. |
| # Maximum number of target label tags allowed is 256. |
| { |
| "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. |
| "state": "A String", # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or |
| # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted |
| # or its network is deleted. |
| }, |
| ], |
| "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are |
| # applied with this rule. |
| "A String", |
| ], |
| "targetType": "A String", # Target types of the firewall policy rule. |
| # Default value is INSTANCES. |
| "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. |
| # Can be set only if action = 'apply_security_profile_group' and cannot |
| # be set for other actions. |
| }, |
| ], |
| "priority": 42, # Output only. [Output only] Priority of firewall policy association. Not applicable for |
| # type=HIERARCHY. |
| "rules": [ # [Output Only] The rules that apply to the network. |
| { # Represents a rule that describes one or more match conditions along with |
| # the action to be taken when traffic matches this condition (allow or deny). |
| "action": "A String", # The Action to perform when the client connection triggers the rule. |
| # Valid actions for firewall rules are: "allow", "deny", |
| # "apply_security_profile_group" and "goto_next". |
| # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" |
| # and "goto_next". |
| "description": "A String", # An optional description for this resource. |
| "direction": "A String", # The direction in which this rule applies. |
| "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, |
| # the firewall policy rule is not enforced and traffic behaves as if it did |
| # not exist. If this is unspecified, the firewall policy rule will be |
| # enabled. |
| "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is |
| # enabled, logs will be exported to the configured export destination in |
| # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you |
| # cannot enable logging on "goto_next" rules. |
| "kind": "compute#firewallPolicyRule", # Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules. |
| "match": { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against. |
| # If it evaluates to true, the corresponding 'action' is enforced. |
| # Exactly one field must be specified. |
| "destAddressGroups": [ # Address groups which should be matched against the traffic destination. |
| # Maximum number of destination address groups is 10. |
| "A String", |
| ], |
| "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against |
| # traffic destination. |
| # Maximum number of destination fqdn allowed is 100. |
| "A String", |
| ], |
| "destIpRanges": [ # CIDR IP address range. |
| # Maximum number of destination CIDR IP ranges allowed is 5000. |
| "A String", |
| ], |
| "destNetworkContext": "A String", # Network context of the traffic destination. Allowed values are: |
| # |
| # |
| # - UNSPECIFIED |
| # - INTERNET |
| # - NON_INTERNET |
| "destNetworkScope": "A String", # Network scope of the traffic destination. |
| "destNetworkType": "A String", # Network type of the traffic destination. Allowed values are: |
| # |
| # |
| # - UNSPECIFIED |
| # - INTERNET |
| # - NON_INTERNET |
| "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination |
| # of traffic. Should be specified as 2 letter country code defined as per |
| # ISO 3166 alpha-2 country codes. ex."US" |
| # Maximum number of dest region codes allowed is 5000. |
| "A String", |
| ], |
| "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. |
| # The IPs in these lists will be matched against traffic destination. |
| "A String", |
| ], |
| "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. |
| { |
| "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is |
| # required when creating a firewall rule. This value can either be |
| # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP |
| # protocol number. |
| "ports": [ # An optional list of ports to which this rule applies. This field is |
| # only applicable for UDP or TCP protocol. Each entry must be either |
| # an integer or a range. If not specified, this rule applies to |
| # connections through any port. |
| # |
| # Example inputs include: ["22"],["80","443"], and ["12345-12349"]. |
| "A String", |
| ], |
| }, |
| ], |
| "srcAddressGroups": [ # Address groups which should be matched against the traffic source. |
| # Maximum number of source address groups is 10. |
| "A String", |
| ], |
| "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against |
| # traffic source. |
| # Maximum number of source fqdn allowed is 100. |
| "A String", |
| ], |
| "srcIpRanges": [ # CIDR IP address range. |
| # Maximum number of source CIDR IP ranges allowed is 5000. |
| "A String", |
| ], |
| "srcNetworkContext": "A String", # Network context of the traffic source. Allowed values are: |
| # |
| # |
| # - UNSPECIFIED |
| # - INTERNET |
| # - INTRA_VPC |
| # - NON_INTERNET |
| # - VPC_NETWORKS |
| "srcNetworkScope": "A String", # Network scope of the traffic source. |
| "srcNetworkType": "A String", # Network type of the traffic source. Allowed values are: |
| # |
| # |
| # - UNSPECIFIED |
| # - INTERNET |
| # - INTRA_VPC |
| # - NON_INTERNET |
| # - VPC_NETWORKS |
| "srcNetworks": [ # Networks of the traffic source. It can be either a full or partial url. |
| "A String", |
| ], |
| "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source |
| # of traffic. Should be specified as 2 letter country code defined as per |
| # ISO 3166 alpha-2 country codes. ex."US" |
| # Maximum number of source region codes allowed is 5000. |
| "A String", |
| ], |
| "srcSecureTags": [ # List of secure tag values, which should be matched at the source |
| # of the traffic. |
| # For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, |
| # and there is no srcIpRange, this rule will be ignored. |
| # Maximum number of source tag values allowed is 256. |
| { |
| "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. |
| "state": "A String", # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or |
| # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted |
| # or its network is deleted. |
| }, |
| ], |
| "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. |
| # The IPs in these lists will be matched against traffic source. |
| "A String", |
| ], |
| }, |
| "priority": 42, # An integer indicating the priority of a rule in the list. The priority |
| # must be a positive value between 0 and 2147483647. |
| # Rules are evaluated from highest to lowest priority where 0 is the |
| # highest priority and 2147483647 is the lowest priority. |
| "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier |
| # and can be updated. |
| "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy |
| # rule. |
| "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. |
| # Example: |
| # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group |
| # Must be specified if action is one of 'apply_security_profile_group' or |
| # 'mirror'. Cannot be specified for other actions. |
| "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. |
| # This field allows you to control which load balancers get this rule. |
| # For example, the following are valid values: |
| # |
| # |
| # - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule |
| # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule |
| # - projects/project/global/ |
| # forwardingRules/forwardingRule |
| # - projects/project/regions/region/forwardingRules/ |
| # forwardingRule |
| "A String", |
| ], |
| "targetResources": [ # A list of network resource URLs to which this rule applies. This field |
| # allows you to control which network's VMs get this rule. If this field |
| # is left blank, all VMs within the organization will receive the rule. |
| "A String", |
| ], |
| "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule |
| # applies to. If targetSecureTag are specified, then the |
| # firewall rule applies only to instances in the VPC network that have one |
| # of those EFFECTIVE secure tags, if all the target_secure_tag are in |
| # INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts. |
| # If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies |
| # to all instances on the specified network. |
| # Maximum number of target label tags allowed is 256. |
| { |
| "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. |
| "state": "A String", # Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or |
| # `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted |
| # or its network is deleted. |
| }, |
| ], |
| "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are |
| # applied with this rule. |
| "A String", |
| ], |
| "targetType": "A String", # Target types of the firewall policy rule. |
| # Default value is INSTANCES. |
| "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. |
| # Can be set only if action = 'apply_security_profile_group' and cannot |
| # be set for other actions. |
| }, |
| ], |
| "shortName": "A String", # Output only. [Output Only] The short name of the firewall policy. |
| "type": "A String", # Output only. [Output Only] The type of the firewall policy. |
| }, |
| ], |
| "firewalls": [ # Effective firewalls on the network. |
| { # Represents a Firewall Rule resource. |
| # |
| # Firewall rules allow or deny ingress traffic to, and egress traffic from your |
| # instances. For more information, readFirewall rules. |
| "allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a |
| # protocol and port-range tuple that describes a permitted connection. |
| { |
| "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is |
| # required when creating a firewall rule. This value can either be one of the |
| # following well known protocol strings (tcp, udp,icmp, esp, ah, ipip,sctp) or the IP protocol number. |
| "ports": [ # An optional list of ports to which this rule applies. |
| # This field is only applicable for the UDP or TCP protocol. |
| # Each entry must be either an integer or a range. |
| # If not specified, this rule applies to connections through any port. |
| # |
| # Example inputs include: ["22"], ["80","443"], |
| # and ["12345-12349"]. |
| "A String", |
| ], |
| }, |
| ], |
| "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 |
| # text format. |
| "denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a |
| # protocol and port-range tuple that describes a denied connection. |
| { |
| "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is |
| # required when creating a firewall rule. This value can either be one of the |
| # following well known protocol strings (tcp, udp,icmp, esp, ah, ipip,sctp) or the IP protocol number. |
| "ports": [ # An optional list of ports to which this rule applies. |
| # This field is only applicable for the UDP or TCP protocol. |
| # Each entry must be either an integer or a range. |
| # If not specified, this rule applies to connections through any port. |
| # |
| # Example inputs include: ["22"], ["80","443"], |
| # and ["12345-12349"]. |
| "A String", |
| ], |
| }, |
| ], |
| "description": "A String", # An optional description of this resource. Provide this field when you |
| # create the resource. |
| "destinationRanges": [ # If destination ranges are specified, the firewall rule applies only to |
| # traffic that has destination IP address in these ranges. These ranges must |
| # be expressed inCIDR format. Both IPv4 and IPv6 are supported. |
| "A String", |
| ], |
| "direction": "A String", # Direction of traffic to which this firewall applies, either `INGRESS` or |
| # `EGRESS`. The default is `INGRESS`. For `EGRESS` traffic, you cannot |
| # specify the sourceTags fields. |
| "disabled": True or False, # Denotes whether the firewall rule is disabled. When set to true, the |
| # firewall rule is not enforced and the network behaves as if it did not |
| # exist. If this is unspecified, the firewall rule will be enabled. |
| "enableLogging": True or False, # Deprecated in favor of enable in LogConfig. |
| # This field denotes whether to enable logging for a particular |
| # firewall rule. If logging is enabled, logs will be exported t |
| # Cloud Logging. |
| "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is |
| # defined by the server. |
| "kind": "compute#firewall", # Output only. [Output Only] Type of the resource. Always compute#firewall |
| # for firewall rules. |
| "logConfig": { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If |
| # logging is enabled, logs will be exported to Cloud Logging. |
| "enable": True or False, # This field denotes whether to enable logging for a particular firewall |
| # rule. |
| "metadata": "A String", # This field can only be specified for a particular firewall rule if |
| # logging is enabled for that rule. This field denotes whether to include |
| # or exclude metadata for firewall logs. |
| }, |
| "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 withRFC1035. |
| # 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. |
| "network": "A String", # URL of the network resource for this firewall rule. If not |
| # specified when creating a firewall rule, the default network |
| # is used: |
| # |
| # global/networks/default |
| # |
| # If you choose to specify this field, you can specify the network as a full |
| # or partial URL. For example, the following are all valid URLs: |
| # |
| # - |
| # https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network |
| # - projects/myproject/global/networks/my-network |
| # - global/networks/default |
| "params": { # Additional firewall parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted |
| # as part of resource payload. |
| "resourceManagerTags": { # Tag keys/values directly bound to this resource. |
| # Tag keys and values have the same definition as resource |
| # manager tags. The field is allowed for INSERT |
| # only. The keys/values to set on the resource should be specified in |
| # either ID { : } or Namespaced format |
| # { : }. |
| # For example the following are valid inputs: |
| # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} |
| # * {"123/environment" : "production", "345/abc" : "xyz"} |
| # Note: |
| # * Invalid combinations of ID & namespaced format is not supported. For |
| # instance: {"123/environment" : "tagValues/444"} is invalid. |
| "a_key": "A String", |
| }, |
| }, |
| "priority": 42, # Priority for this rule. |
| # This is an integer between `0` and `65535`, both inclusive. |
| # The default value is `1000`. |
| # Relative priorities determine which rule takes effect if multiple rules |
| # apply. Lower values indicate higher priority. For example, a rule with |
| # priority `0` has higher precedence than a rule with priority `1`. |
| # DENY rules take precedence over ALLOW rules if they have equal priority. |
| # Note that VPC networks have implied |
| # rules with a priority of `65535`. To avoid conflicts with the implied |
| # rules, use a priority number less than `65535`. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "sourceRanges": [ # If source ranges are specified, the firewall rule applies only to traffic |
| # that has a source IP address in these ranges. These ranges must be |
| # expressed inCIDR format. One or both of sourceRanges |
| # and sourceTags may be set. |
| # If both fields are set, the rule applies to traffic that has a |
| # source IP address within sourceRanges OR a source IP |
| # from a resource with a matching tag listed in thesourceTags field. The connection does not need to match |
| # both fields for the rule to |
| # apply. Both IPv4 and IPv6 are supported. |
| "A String", |
| ], |
| "sourceServiceAccounts": [ # If source service accounts are specified, the firewall rules apply only to |
| # traffic originating from an instance with a service account in this list. |
| # Source service accounts cannot be used to control traffic to an instance's |
| # external IP address because service accounts are associated with an |
| # instance, not an IP address.sourceRanges can be set at the same time assourceServiceAccounts. |
| # If both are set, the firewall applies to traffic that |
| # has a source IP address within the sourceRanges OR a source |
| # IP that belongs to an instance with service account listed insourceServiceAccount. The connection does not need to match |
| # both fields for the firewall to apply.sourceServiceAccounts cannot be used at the same time assourceTags or targetTags. |
| "A String", |
| ], |
| "sourceTags": [ # If source tags are specified, the firewall rule applies only to traffic |
| # with source IPs that match the primary network interfaces of VM instances |
| # that have the tag and are in the same VPC network. |
| # Source tags cannot be used to control traffic to an instance's external IP |
| # address, it only applies to traffic between instances in the same virtual |
| # network. Because tags are associated with instances, not IP addresses. |
| # One or both of sourceRanges and sourceTags may be |
| # set. If both fields are set, the firewall applies to traffic that has a |
| # source IP address within sourceRanges OR a source IP from a |
| # resource with a matching tag listed in the sourceTags |
| # field. The connection does not need to match both fields for the |
| # firewall to apply. |
| "A String", |
| ], |
| "targetServiceAccounts": [ # A list of service accounts indicating sets of instances located in the |
| # network that may make network connections as specified inallowed[].targetServiceAccounts cannot be used at the same time astargetTags or sourceTags. |
| # If neither targetServiceAccounts nor targetTags |
| # are specified, the firewall rule applies to all instances on the specified |
| # network. |
| "A String", |
| ], |
| "targetTags": [ # A list of tags that controls which instances the firewall rule |
| # applies to. If targetTags are specified, then the firewall |
| # rule applies only to instances in the VPC network that have one of those |
| # tags. If no targetTags are specified, the firewall rule |
| # applies to all instances on the specified network. |
| "A String", |
| ], |
| }, |
| ], |
| "organizationFirewalls": [ # Effective firewalls from organization policies. |
| { # A pruned SecurityPolicy containing ID and any applicable firewall rules. |
| "id": "A String", # Output only. [Output Only] The unique identifier for the security policy. This |
| # identifier is defined by the server. |
| "rules": [ # The rules that apply to the network. |
| { # Represents a rule that describes one or more match conditions along with |
| # the action to be taken when traffic matches this condition (allow or deny). |
| "action": "A String", # The Action to perform when the rule is matched. |
| # The following are the valid actions: |
| # |
| # - allow: allow access to target. |
| # - deny(STATUS): deny access to target, returns the |
| # HTTP response code specified. Valid values for `STATUS` |
| # are 403, 404, and 502. |
| # - rate_based_ban: limit client traffic to the configured |
| # threshold and ban the client if the traffic exceeds the threshold. |
| # Configure parameters for this action in RateLimitOptions. Requires |
| # rate_limit_options to be set. |
| # - redirect: redirect to a different target. This can |
| # either be an internal reCAPTCHA redirect, or an external URL-based |
| # redirect via a 302 response. Parameters for this action can be configured |
| # via redirectOptions. This action is only supported in Global Security |
| # Policies of type CLOUD_ARMOR. |
| # - throttle: limit |
| # client traffic to the configured threshold. Configure parameters for this |
| # action in rateLimitOptions. Requires rate_limit_options to be set for |
| # this. |
| # - fairshare (preview only): when traffic reaches the |
| # threshold limit, requests from the clients matching this rule begin to be |
| # rate-limited using the Fair Share algorithm. This action is only allowed |
| # in security policies of type `CLOUD_ARMOR_INTERNAL_SERVICE`. |
| "description": "A String", # An optional description of this resource. Provide this property when you |
| # create the resource. |
| "direction": "A String", # The direction in which this rule applies. This field may only be |
| # specified when versioned_expr is set to FIREWALL. |
| "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is |
| # enabled, logs will be exported to the configured export destination in |
| # Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you |
| # cannot enable logging on "goto_next" rules. |
| # |
| # This field may only be specified when the versioned_expr is set to |
| # FIREWALL. |
| "headerAction": { # Optional, additional actions that are performed on headers. |
| # This field is only supported in Global Security Policies of type |
| # CLOUD_ARMOR. |
| "requestHeadersToAdds": [ # The list of request headers to add or overwrite if they're already |
| # present. |
| { |
| "headerName": "A String", # The name of the header to set. |
| "headerValue": "A String", # The value to set the named header to. |
| }, |
| ], |
| }, |
| "kind": "compute#securityPolicyRule", # Output only. [Output only] Type of the resource. Alwayscompute#securityPolicyRule for security policy rules |
| "match": { # Represents a match condition that incoming traffic is evaluated against. # A match condition that incoming traffic is evaluated against. |
| # If it evaluates to true, the corresponding 'action' is enforced. |
| # Exactly one field must be specified. |
| "config": { # The configuration options available when specifying versioned_expr. |
| # This field must be specified if versioned_expr is specified and cannot |
| # be specified if versioned_expr is not specified. |
| "destIpRanges": [ # CIDR IP address range. |
| # |
| # This field may only be specified when versioned_expr is set to |
| # FIREWALL. |
| "A String", |
| ], |
| "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. |
| # |
| # This field may only be specified when versioned_expr is set to |
| # FIREWALL. |
| { |
| "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is |
| # required when creating a firewall rule. This value can either be |
| # one of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP |
| # protocol number. |
| "ports": [ # An optional list of ports to which this rule applies. This field is |
| # only applicable for UDP or TCP protocol. Each entry must be either |
| # an integer or a range. If not specified, this rule applies to |
| # connections through any port. |
| # |
| # Example inputs include: ["22"],["80","443"], and ["12345-12349"]. |
| # |
| # This field may only be specified when versioned_expr is set to |
| # FIREWALL. |
| "A String", |
| ], |
| }, |
| ], |
| "srcIpRanges": [ # CIDR IP address range. |
| # Maximum number of src_ip_ranges allowed is 10. |
| "A String", |
| ], |
| }, |
| "expr": { # Represents a textual expression in the Common Expression Language (CEL) # User defined CEVAL expression. |
| # A CEVAL expression is used to specify match criteria such as origin.ip, |
| # source.region_code and contents in the request header. |
| # Expressions containing `evaluateThreatIntelligence` require a Cloud |
| # Armor Enterprise subscription and are not supported in Edge Policies |
| # nor in Regional Policies. Expressions containing |
| # `evaluatePreconfiguredExpr('sourceiplist-*')` require a Cloud Armor |
| # Enterprise subscription and are only supported in Global Security |
| # Policies. |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| # are documented at https://github.com/google/cel-spec. |
| # |
| # Example (Comparison): |
| # |
| # title: "Summary size limit" |
| # description: "Determines if a summary is less than 100 chars" |
| # expression: "document.summary.size() < 100" |
| # |
| # Example (Equality): |
| # |
| # title: "Requestor is owner" |
| # description: "Determines if requestor is the document owner" |
| # expression: "document.owner == request.auth.claims.email" |
| # |
| # Example (Logic): |
| # |
| # title: "Public documents" |
| # description: "Determine whether the document should be publicly visible" |
| # expression: "document.type != 'private' && document.type != 'internal'" |
| # |
| # Example (Data Manipulation): |
| # |
| # title: "Notification string" |
| # description: "Create a notification string with a timestamp." |
| # expression: "'New message received at ' + string(document.create_time)" |
| # |
| # The exact variables and functions that may be referenced within an expression |
| # are determined by the service that evaluates it. See the service |
| # documentation for additional information. |
| "description": "A String", # Optional. Description of the expression. This is a longer text which |
| # describes the expression, e.g. when hovered over it in a UI. |
| "expression": "A String", # Textual representation of an expression in Common Expression Language |
| # syntax. |
| "location": "A String", # Optional. String indicating the location of the expression for error |
| # reporting, e.g. a file name and a position in the file. |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| # its purpose. This can be used e.g. in UIs which allow to enter the |
| # expression. |
| }, |
| "exprOptions": { # The configuration options available when specifying a user defined |
| # CEVAL expression (i.e., 'expr'). |
| "recaptchaOptions": { # reCAPTCHA configuration options to be applied for the rule. If the |
| # rule does not evaluate reCAPTCHA tokens, this field has no effect. |
| "actionTokenSiteKeys": [ # A list of site keys to be used during the validation of reCAPTCHA |
| # action-tokens. The provided site keys need to be created from |
| # reCAPTCHA API under the same project where the security policy is |
| # created. |
| "A String", |
| ], |
| "sessionTokenSiteKeys": [ # A list of site keys to be used during the validation of reCAPTCHA |
| # session-tokens. The provided site keys need to be created from |
| # reCAPTCHA API under the same project where the security policy is |
| # created. |
| "A String", |
| ], |
| }, |
| }, |
| "versionedExpr": "A String", # Preconfigured versioned expression. |
| # If this field is specified, config must also be specified. |
| # Available preconfigured expressions along with their requirements are: |
| # SRC_IPS_V1 - must specify the corresponding src_ip_range field in |
| # config. |
| }, |
| "networkMatch": { # Represents a match condition that incoming network traffic is evaluated # A match condition that incoming packets are evaluated against for |
| # CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding |
| # 'action' is enforced. |
| # |
| # The match criteria for a rule consists of built-in match fields (like |
| # 'srcIpRanges') and potentially multiple user-defined match fields |
| # ('userDefinedFields'). |
| # |
| # Field values may be extracted directly from the packet or derived from it |
| # (e.g. 'srcRegionCodes'). Some fields may not be present in every packet |
| # (e.g. 'srcPorts'). A user-defined field is only present if the base |
| # header is found in the packet and the entire field is in bounds. |
| # |
| # Each match field may specify which values can match it, listing one or |
| # more ranges, prefixes, or exact values that are considered a match for |
| # the field. A field value must be present in order to match a specified |
| # match field. If no match values are specified for a match field, then any |
| # field value is considered to match it, and it's not required to be |
| # present. For strings specifying '*' is also equivalent to match all. |
| # |
| # For a packet to match a rule, all specified match fields must match the |
| # corresponding field values derived from the packet. |
| # |
| # Example: |
| # |
| # networkMatch: |
| # srcIpRanges: |
| # - "192.0.2.0/24" |
| # - "198.51.100.0/24" |
| # userDefinedFields: |
| # - name: "ipv4_fragment_offset" |
| # values: |
| # - "1-0x1fff" |
| # |
| # The above match condition matches packets with a source IP in |
| # 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named |
| # "ipv4_fragment_offset" with a value between 1 and 0x1fff inclusive. |
| # against. |
| "destIpRanges": [ # Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text |
| # format. |
| "A String", |
| ], |
| "destPorts": [ # Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit |
| # unsigned decimal number (e.g. "80") or range (e.g. "0-1023"). |
| "A String", |
| ], |
| "ipProtocols": [ # IPv4 protocol / IPv6 next header (after extension headers). Each |
| # element can be an 8-bit unsigned decimal number (e.g. "6"), range (e.g. |
| # "253-254"), or one of the following protocol names: "tcp", "udp", |
| # "icmp", "esp", "ah", "ipip", or "sctp". |
| "A String", |
| ], |
| "srcAsns": [ # BGP Autonomous System Number associated with the source IP address. |
| 42, |
| ], |
| "srcIpRanges": [ # Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format. |
| "A String", |
| ], |
| "srcPorts": [ # Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit |
| # unsigned decimal number (e.g. "80") or range (e.g. "0-1023"). |
| "A String", |
| ], |
| "srcRegionCodes": [ # Two-letter ISO 3166-1 alpha-2 country code associated with the source |
| # IP address. |
| "A String", |
| ], |
| "userDefinedFields": [ # User-defined fields. Each element names a defined field and lists the |
| # matching values for that field. |
| { |
| "name": "A String", # Name of the user-defined field, as given in the definition. |
| "values": [ # Matching values of the field. Each element can be a 32-bit unsigned |
| # decimal or hexadecimal (starting with "0x") number (e.g. "64") or |
| # range (e.g. "0x400-0x7ff"). |
| "A String", |
| ], |
| }, |
| ], |
| }, |
| "preconfiguredWafConfig": { # Preconfigured WAF configuration to be applied for the rule. If the rule |
| # does not evaluate preconfigured WAF rules, i.e., if |
| # evaluatePreconfiguredWaf() is not used, this field will have no effect. |
| "exclusions": [ # A list of exclusions to apply during preconfigured WAF evaluation. |
| { |
| "requestBodiesToExclude": [ # A list of request body fields to be excluded from inspection during |
| # preconfigured WAF evaluation. |
| { |
| "op": "A String", # The match operator for the field. |
| "val": "A String", # The value of the field. |
| }, |
| ], |
| "requestCookiesToExclude": [ # A list of request cookie names whose value will be excluded from |
| # inspection during preconfigured WAF evaluation. |
| { |
| "op": "A String", # The match operator for the field. |
| "val": "A String", # The value of the field. |
| }, |
| ], |
| "requestHeadersToExclude": [ # A list of request header names whose value will be excluded from |
| # inspection during preconfigured WAF evaluation. |
| { |
| "op": "A String", # The match operator for the field. |
| "val": "A String", # The value of the field. |
| }, |
| ], |
| "requestQueryParamsToExclude": [ # A list of request query parameter names whose value will be excluded |
| # from inspection during preconfigured WAF evaluation. Note that the |
| # parameter can be in the query string or in the POST body. |
| { |
| "op": "A String", # The match operator for the field. |
| "val": "A String", # The value of the field. |
| }, |
| ], |
| "requestUrisToExclude": [ # A list of request URIs from the request line to be excluded from |
| # inspection during preconfigured WAF evaluation. When specifying this |
| # field, the query or fragment part should be excluded. |
| { |
| "op": "A String", # The match operator for the field. |
| "val": "A String", # The value of the field. |
| }, |
| ], |
| "targetRuleIds": [ # A list of target rule IDs under the WAF rule set to apply the |
| # preconfigured WAF exclusion. If omitted, it refers to all the rule |
| # IDs under the WAF rule set. |
| "A String", |
| ], |
| "targetRuleSet": "A String", # Target WAF rule set to apply the preconfigured WAF exclusion. |
| }, |
| ], |
| }, |
| "preview": True or False, # If set to true, the specified action is not enforced. |
| "priority": 42, # An integer indicating the priority of a rule in the list. The priority |
| # must be a positive value between 0 and 2147483647. |
| # Rules are evaluated from highest to lowest priority where 0 is the |
| # highest priority and 2147483647 is the lowest priority. |
| "rateLimitOptions": { # Must be specified if the action is "rate_based_ban" or "throttle" or |
| # "fairshare". Cannot be specified for any other actions. |
| "banDurationSec": 42, # Can only be specified if the action for the rule is |
| # "rate_based_ban". If specified, determines the time (in seconds) |
| # the traffic will continue to be banned by the rate limit after the |
| # rate falls below the threshold. |
| "banThreshold": { # Can only be specified if the action for the rule is |
| # "rate_based_ban". If specified, the key will be banned for the |
| # configured 'ban_duration_sec' when the number of requests that exceed |
| # the 'rate_limit_threshold' also exceed this 'ban_threshold'. |
| "count": 42, # Number of HTTP(S) requests for calculating the threshold. |
| "intervalSec": 42, # Interval over which the threshold is computed. |
| }, |
| "conformAction": "A String", # Action to take for requests that are under the configured rate limit |
| # threshold. Valid option is "allow" only. |
| "enforceOnKey": "A String", # Determines the key to enforce the rate_limit_threshold on. Possible |
| # values are: |
| # |
| # - ALL: A single rate limit threshold is applied to all |
| # the requests matching this rule. This is the default value if |
| # "enforceOnKey" is not configured. |
| # - IP: The source IP address of |
| # the request is the key. Each IP has this limit enforced |
| # separately. |
| # - HTTP_HEADER: The value of the HTTP |
| # header whose name is configured under "enforceOnKeyName". The key |
| # value is truncated to the first 128 bytes of the header value. If no |
| # such header is present in the request, the key type defaults toALL. |
| # - XFF_IP: The first IP address (i.e. the |
| # originating client IP address) specified in the list of IPs under |
| # X-Forwarded-For HTTP header. If no such header is present or the value |
| # is not a valid IP, the key defaults to the source IP address of |
| # the request i.e. key type IP. |
| # - HTTP_COOKIE: The value of the HTTP |
| # cookie whose name is configured under "enforceOnKeyName". The key |
| # value is truncated to the first 128 bytes of the cookie value. If no |
| # such cookie is present in the request, the key type defaults toALL. |
| # - HTTP_PATH: The URL path of the HTTP request. The key |
| # value is truncated to the first 128 bytes. |
| # - SNI: Server name indication in the TLS session of the |
| # HTTPS request. The key value is truncated to the first 128 bytes. The |
| # key type defaults to ALL on a HTTP session. |
| # - REGION_CODE: The country/region from which the request |
| # originates. |
| # - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the |
| # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the |
| # key type defaults to ALL. |
| # - USER_IP: The IP address of the originating client, |
| # which is resolved based on "userIpRequestHeaders" configured with the |
| # security policy. If there is no "userIpRequestHeaders" configuration or |
| # an IP address cannot be resolved from it, the key type defaults toIP. |
| # |
| # - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the |
| # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the |
| # key type defaults to ALL. |
| # For "fairshare" action, this value is limited to ALL i.e. a single rate |
| # limit threshold is enforced for all the requests matching the rule. |
| "enforceOnKeyConfigs": [ # If specified, any combination of values of |
| # enforce_on_key_type/enforce_on_key_name is treated as the key on which |
| # ratelimit threshold/action is enforced. You can specify up to 3 |
| # enforce_on_key_configs. If enforce_on_key_configs is specified, |
| # enforce_on_key must not be specified. |
| { |
| "enforceOnKeyName": "A String", # Rate limit key name applicable only for the following key types: |
| # HTTP_HEADER -- Name of the HTTP header whose value is taken as the |
| # key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is |
| # taken as the key value. |
| "enforceOnKeyType": "A String", # Determines the key to enforce the rate_limit_threshold on. Possible |
| # values are: |
| # |
| # - ALL: A single rate limit threshold is applied to all |
| # the requests matching this rule. This is the default value if |
| # "enforceOnKeyConfigs" is not configured. |
| # - IP: The source IP address of |
| # the request is the key. Each IP has this limit enforced |
| # separately. |
| # - HTTP_HEADER: The value of the HTTP |
| # header whose name is configured under "enforceOnKeyName". The key |
| # value is truncated to the first 128 bytes of the header value. If no |
| # such header is present in the request, the key type defaults toALL. |
| # - XFF_IP: The first IP address (i.e. the |
| # originating client IP address) specified in the list of IPs under |
| # X-Forwarded-For HTTP header. If no such header is present or the |
| # value is not a valid IP, the key defaults to the source IP address of |
| # the request i.e. key type IP. |
| # - HTTP_COOKIE: The value of the HTTP |
| # cookie whose name is configured under "enforceOnKeyName". The key |
| # value is truncated to the first 128 bytes of the cookie value. If no |
| # such cookie is present in the request, the key type defaults toALL. |
| # - HTTP_PATH: The URL path of the HTTP request. The key |
| # value is truncated to the first 128 bytes. |
| # - SNI: Server name indication in the TLS session of |
| # the HTTPS request. The key value is truncated to the first 128 bytes. |
| # The key type defaults to ALL on a HTTP session. |
| # - REGION_CODE: The country/region from which the |
| # request originates. |
| # - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the |
| # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the |
| # key type defaults to ALL. |
| # - USER_IP: The IP address of the originating client, |
| # which is resolved based on "userIpRequestHeaders" configured with the |
| # security policy. If there is no "userIpRequestHeaders" configuration |
| # or an IP address cannot be resolved from it, the key type defaults toIP. |
| # |
| # - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the |
| # client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the |
| # key type defaults to ALL. |
| }, |
| ], |
| "enforceOnKeyName": "A String", # Rate limit key name applicable only for the following key types: |
| # HTTP_HEADER -- Name of the HTTP header whose value is taken as the key |
| # value. |
| # HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key |
| # value. |
| "exceedAction": "A String", # Action to take for requests that are above the configured rate limit |
| # threshold, to either deny with a specified HTTP response code, or |
| # redirect to a different endpoint. |
| # Valid options are `deny(STATUS)`, where valid values for |
| # `STATUS` are 403, 404, 429, and 502, and |
| # `redirect`, where the redirect parameters come from |
| # `exceedRedirectOptions` below. |
| # The `redirect` action is only supported in Global Security Policies of |
| # type CLOUD_ARMOR. |
| "exceedRedirectOptions": { # Parameters defining the redirect action that is used as the exceed |
| # action. Cannot be specified if the exceed action is not redirect. |
| # This field is only supported in Global Security Policies of type |
| # CLOUD_ARMOR. |
| "target": "A String", # Target for the redirect action. This is required if the type is |
| # EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA. |
| "type": "A String", # Type of the redirect action. Possible values are: |
| # |
| # - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual |
| # challenge assessment. |
| # - EXTERNAL_302: redirect to a different URL via a 302 |
| # response. |
| }, |
| "rateLimitThreshold": { # Threshold at which to begin ratelimiting. |
| "count": 42, # Number of HTTP(S) requests for calculating the threshold. |
| "intervalSec": 42, # Interval over which the threshold is computed. |
| }, |
| }, |
| "redirectOptions": { # Parameters defining the redirect action. Cannot be specified for any |
| # other actions. |
| # This field is only supported in Global Security Policies of type |
| # CLOUD_ARMOR. |
| "target": "A String", # Target for the redirect action. This is required if the type is |
| # EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA. |
| "type": "A String", # Type of the redirect action. Possible values are: |
| # |
| # - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual |
| # challenge assessment. |
| # - EXTERNAL_302: redirect to a different URL via a 302 |
| # response. |
| }, |
| "ruleNumber": "A String", # Identifier for the rule. This is only unique within the given security |
| # policy. This can only be set during rule creation, if rule number is not |
| # specified it will be generated by the server. |
| "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall security |
| # policy rule. |
| "targetResources": [ # A list of network resource URLs to which this rule applies. This field |
| # allows you to control which network's VMs get this rule. If this field |
| # is left blank, all VMs within the organization will receive the rule. |
| # |
| # This field may only be specified when versioned_expr is set to FIREWALL. |
| "A String", |
| ], |
| "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are |
| # applied with this rule. |
| "A String", |
| ], |
| }, |
| ], |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=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, readVirtual Private Cloud (VPC) Network. |
| "IPv4Range": "A String", # Deprecated in favor of subnet mode networks. |
| # The range of internal addresses that are legal on this network. This |
| # range is aCIDR specification, for example:192.168.0.0/16. Provided by the client when the network is |
| # created. |
| "autoCreateSubnetworks": True or False, # Must be set to create a VPC network. If not set, a legacy network is |
| # created. |
| # |
| # 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 inAuto mode VPC network IP ranges. |
| # |
| # For custom mode VPC networks, you can add subnets using the subnetworksinsert |
| # method. |
| "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 |
| # text format. |
| "description": "A String", # An optional description of this resource. Provide this field when you |
| # create the resource. |
| "enableUlaInternalIpv6": True or False, # Enable ULA internal ipv6 on this network. Enabling this feature will assign |
| # a /48 from google defined ULA prefix fd20::/20. |
| # . |
| "firewallPolicy": "A String", # Output only. [Output Only] URL of the firewall policy the network is associated with. |
| "gatewayIPv4": "A String", # [Output Only] The gateway address for default routing out of the network, |
| # selected by Google Cloud. |
| "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is |
| # defined by the server. |
| "internalIpv6Range": "A String", # When enabling ula internal ipv6, caller optionally can specify the /48 |
| # range they want from the google defined ULA prefix fd20::/20. The input |
| # must be a valid /48 ULA IPv6 address and must be within the fd20::/20. |
| # Operation will fail if the speficied /48 is already in used by another |
| # resource. If the field is not speficied, then a /48 range will be randomly |
| # allocated from fd20::/20 and returned via this field. |
| # . |
| "kind": "compute#network", # Output only. [Output Only] Type of the resource. Always compute#network for |
| # networks. |
| "mtu": 42, # Maximum Transmission Unit in bytes. |
| # The minimum value for this field is 1300 and the maximum value is 8896. |
| # The suggested value is 1500, which is the default MTU used on the |
| # Internet, or 8896 if you want to use Jumbo frames. If unspecified, the |
| # value defaults to 1460. |
| "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 withRFC1035. |
| # 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. |
| "networkFirewallPolicyEnforcementOrder": "A String", # The network firewall policy enforcement order. Can be either |
| # AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to |
| # AFTER_CLASSIC_FIREWALL if the field is not specified. |
| "networkProfile": "A String", # A full or partial URL of the network profile to apply to this network. |
| # This field can be set only at resource creation time. For example, the |
| # following are valid URLs: |
| # |
| # - https://www.googleapis.com/compute/{api_version}/projects/{project_id}/global/networkProfiles/{network_profile_name} |
| # - projects/{project_id}/global/networkProfiles/{network_profile_name} |
| "params": { # Additional network parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted |
| # as part of resource payload. |
| "resourceManagerTags": { # Tag keys/values directly bound to this resource. |
| # Tag keys and values have the same definition as resource |
| # manager tags. The field is allowed for INSERT |
| # only. The keys/values to set on the resource should be specified in |
| # either ID { : } or Namespaced format |
| # { : }. |
| # For example the following are valid inputs: |
| # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} |
| # * {"123/environment" : "production", "345/abc" : "xyz"} |
| # Note: |
| # * Invalid combinations of ID & namespaced format is not supported. For |
| # instance: {"123/environment" : "tagValues/444"} is invalid. |
| "a_key": "A String", |
| }, |
| }, |
| "peerings": [ # Output only. [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 theexchange_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 isACTIVE. |
| "connectionStatus": { # [Output Only] Describes the state of a peering connection, not just the # Output only. [Output Only] The effective state of the peering connection |
| # as a whole. |
| # local peering. This field provides information about the effective settings |
| # for the connection as a whole, including pending delete/update requests for |
| # CONSENSUS peerings. |
| "consensusState": { # The status of update/delete for a consensus peering connection. Only set # The consensus state contains information about the status of update |
| # and delete for a consensus peering connection. |
| # when connection_status.update_strategy isCONSENSUS or a network peering is proposing to update the |
| # strategy to CONSENSUS. |
| "deleteStatus": "A String", # The status of the delete request. |
| "updateStatus": "A String", # The status of the update request. |
| }, |
| "trafficConfiguration": { # The active connectivity settings for the peering connection based on the |
| # settings of the network peerings. |
| "exportCustomRoutesToPeer": True or False, # Whether custom routes are being exported to the peer network. |
| "exportSubnetRoutesWithPublicIpToPeer": True or False, # Whether subnet routes with public IP ranges are being exported to the |
| # peer network. |
| "importCustomRoutesFromPeer": True or False, # Whether custom routes are being imported from the peer network. |
| "importSubnetRoutesWithPublicIpFromPeer": True or False, # Whether subnet routes with public IP ranges are being imported |
| # from the peer network. |
| "stackType": "A String", # Which IP version(s) of traffic and routes are being imported or |
| # exported between peer networks. |
| }, |
| "updateStrategy": "A String", # The update strategy determines the update/delete semantics for this |
| # peering connection. |
| }, |
| "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 isACTIVE. |
| "exportCustomRoutes": True or False, # Whether to export the custom routes to peer network. The default value is |
| # false. |
| "exportSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are exported. The default value |
| # is true, all subnet routes are exported.IPv4 |
| # special-use ranges 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. The default value is |
| # false. |
| "importSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are imported. The default value |
| # is false.IPv4 |
| # special-use ranges 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 withRFC1035. |
| # 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. |
| "peerMtu": 42, # Output only. [Output Only] Maximum Transmission Unit in bytes of the peer network. |
| "stackType": "A String", # Which IP version(s) of traffic and routes are allowed to be imported or |
| # exported between peer networks. The default value is IPV4_ONLY. |
| "state": "A String", # Output only. [Output Only] State for the peering. |
| "stateDetails": "A String", # Output only. [Output Only] Details about the current state of the peering. |
| "updateStrategy": "A String", # The update strategy determines the semantics for updates and deletes to the |
| # peering connection configuration. |
| }, |
| ], |
| "routingConfig": { # A routing configuration attached to a network resource. The message # The network-level routing configuration for this network. Used by Cloud |
| # Router to determine what type of network-wide routing behavior to enforce. |
| # includes the list of routers associated with the network, and a flag |
| # indicating the type of routing behavior to enforce network-wide. |
| "bgpAlwaysCompareMed": True or False, # Enable comparison of Multi-Exit Discriminators (MED) across routes with |
| # different neighbor ASNs when using the STANDARD BGP best path selection |
| # algorithm. |
| "bgpBestPathSelectionMode": "A String", # The BGP best path selection algorithm to be employed within this network |
| # for dynamic routes learned by Cloud Routers. Can be LEGACY |
| # (default) or STANDARD. |
| "bgpInterRegionCost": "A String", # Allows to define a preferred approach for handling inter-region cost in |
| # the selection process when using the STANDARD BGP best path |
| # selection algorithm. Can be DEFAULT orADD_COST_TO_MED. |
| "effectiveBgpAlwaysCompareMed": True or False, # Output only. [Output Only] Effective value of the bgp_always_compare_med |
| # field. |
| "effectiveBgpInterRegionCost": "A String", # Output only. [Output Only] Effective value of the bgp_inter_region_cost |
| # field. |
| "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 toGLOBAL, 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. |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. |
| "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). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # 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 `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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 inRFC3339 |
| # 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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "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. |
| }, |
| ], |
| }, |
| "getVersionOperationMetadata": { |
| "inlineSbomInfo": { |
| "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component |
| # name and the value is the version. |
| "a_key": "A String", |
| }, |
| "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the |
| # component name and the value is the version. |
| "a_key": "A String", |
| }, |
| }, |
| }, |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `user@example.com` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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, returnPartialSuccess=None, x__xgafv=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. Most |
| Compute resources support two types of filter expressions: |
| expressions that support regular expressions and expressions that follow |
| API improvement proposal AIP-160. |
| These two types of filter expressions cannot be mixed in one request. |
| |
| If you want to use AIP-160, your expression must specify the field name, an |
| operator, and the value that you want to use for filtering. The value |
| must be a string, a number, or a boolean. The operator |
| must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. |
| |
| For example, if you are filtering Compute Engine instances, you can |
| exclude instances named `example-instance` by specifying |
| `name != example-instance`. |
| |
| The `:*` comparison can be used to test whether a key has been defined. |
| For example, to find all objects with `owner` label use: |
| ``` |
| labels.owner:* |
| ``` |
| |
| You can also filter nested fields. For example, you could specify |
| `scheduling.automaticRestart = false` to include instances only |
| if they are not scheduled for automatic restarts. You can use filtering |
| on nested fields to filter based onresource 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) |
| ``` |
| |
| If you want to use a regular expression, use the `eq` (equal) or `ne` |
| (not equal) operator against a single un-parenthesized expression with or |
| without quotes or against multiple parenthesized expressions. Examples: |
| |
| `fieldname eq unquoted literal` |
| `fieldname eq 'single quoted literal'` |
| `fieldname eq "double quoted literal"` |
| `(fieldname1 eq literal) (fieldname2 ne "literal")` |
| |
| The literal value is interpreted as a regular expression using GoogleRE2 library syntax. |
| The literal value must match the entire field. |
| |
| For example, to filter for instances that do not end with name "instance", |
| you would use `name ne .*instance`. |
| |
| You cannot combine constraints on multiple fields using regular |
| expressions. |
| 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. |
| returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case |
| of failure. The default value is false. |
| |
| For example, when partial success behavior is enabled, aggregatedList for a |
| single zone scope either returns all resources in the zone or no resources, |
| with an error code. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| 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, readVirtual Private Cloud (VPC) Network. |
| "IPv4Range": "A String", # Deprecated in favor of subnet mode networks. |
| # The range of internal addresses that are legal on this network. This |
| # range is aCIDR specification, for example:192.168.0.0/16. Provided by the client when the network is |
| # created. |
| "autoCreateSubnetworks": True or False, # Must be set to create a VPC network. If not set, a legacy network is |
| # created. |
| # |
| # 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 inAuto mode VPC network IP ranges. |
| # |
| # For custom mode VPC networks, you can add subnets using the subnetworksinsert |
| # method. |
| "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 |
| # text format. |
| "description": "A String", # An optional description of this resource. Provide this field when you |
| # create the resource. |
| "enableUlaInternalIpv6": True or False, # Enable ULA internal ipv6 on this network. Enabling this feature will assign |
| # a /48 from google defined ULA prefix fd20::/20. |
| # . |
| "firewallPolicy": "A String", # Output only. [Output Only] URL of the firewall policy the network is associated with. |
| "gatewayIPv4": "A String", # [Output Only] The gateway address for default routing out of the network, |
| # selected by Google Cloud. |
| "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is |
| # defined by the server. |
| "internalIpv6Range": "A String", # When enabling ula internal ipv6, caller optionally can specify the /48 |
| # range they want from the google defined ULA prefix fd20::/20. The input |
| # must be a valid /48 ULA IPv6 address and must be within the fd20::/20. |
| # Operation will fail if the speficied /48 is already in used by another |
| # resource. If the field is not speficied, then a /48 range will be randomly |
| # allocated from fd20::/20 and returned via this field. |
| # . |
| "kind": "compute#network", # Output only. [Output Only] Type of the resource. Always compute#network for |
| # networks. |
| "mtu": 42, # Maximum Transmission Unit in bytes. |
| # The minimum value for this field is 1300 and the maximum value is 8896. |
| # The suggested value is 1500, which is the default MTU used on the |
| # Internet, or 8896 if you want to use Jumbo frames. If unspecified, the |
| # value defaults to 1460. |
| "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 withRFC1035. |
| # 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. |
| "networkFirewallPolicyEnforcementOrder": "A String", # The network firewall policy enforcement order. Can be either |
| # AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to |
| # AFTER_CLASSIC_FIREWALL if the field is not specified. |
| "networkProfile": "A String", # A full or partial URL of the network profile to apply to this network. |
| # This field can be set only at resource creation time. For example, the |
| # following are valid URLs: |
| # |
| # - https://www.googleapis.com/compute/{api_version}/projects/{project_id}/global/networkProfiles/{network_profile_name} |
| # - projects/{project_id}/global/networkProfiles/{network_profile_name} |
| "params": { # Additional network parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted |
| # as part of resource payload. |
| "resourceManagerTags": { # Tag keys/values directly bound to this resource. |
| # Tag keys and values have the same definition as resource |
| # manager tags. The field is allowed for INSERT |
| # only. The keys/values to set on the resource should be specified in |
| # either ID { : } or Namespaced format |
| # { : }. |
| # For example the following are valid inputs: |
| # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} |
| # * {"123/environment" : "production", "345/abc" : "xyz"} |
| # Note: |
| # * Invalid combinations of ID & namespaced format is not supported. For |
| # instance: {"123/environment" : "tagValues/444"} is invalid. |
| "a_key": "A String", |
| }, |
| }, |
| "peerings": [ # Output only. [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 theexchange_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 isACTIVE. |
| "connectionStatus": { # [Output Only] Describes the state of a peering connection, not just the # Output only. [Output Only] The effective state of the peering connection |
| # as a whole. |
| # local peering. This field provides information about the effective settings |
| # for the connection as a whole, including pending delete/update requests for |
| # CONSENSUS peerings. |
| "consensusState": { # The status of update/delete for a consensus peering connection. Only set # The consensus state contains information about the status of update |
| # and delete for a consensus peering connection. |
| # when connection_status.update_strategy isCONSENSUS or a network peering is proposing to update the |
| # strategy to CONSENSUS. |
| "deleteStatus": "A String", # The status of the delete request. |
| "updateStatus": "A String", # The status of the update request. |
| }, |
| "trafficConfiguration": { # The active connectivity settings for the peering connection based on the |
| # settings of the network peerings. |
| "exportCustomRoutesToPeer": True or False, # Whether custom routes are being exported to the peer network. |
| "exportSubnetRoutesWithPublicIpToPeer": True or False, # Whether subnet routes with public IP ranges are being exported to the |
| # peer network. |
| "importCustomRoutesFromPeer": True or False, # Whether custom routes are being imported from the peer network. |
| "importSubnetRoutesWithPublicIpFromPeer": True or False, # Whether subnet routes with public IP ranges are being imported |
| # from the peer network. |
| "stackType": "A String", # Which IP version(s) of traffic and routes are being imported or |
| # exported between peer networks. |
| }, |
| "updateStrategy": "A String", # The update strategy determines the update/delete semantics for this |
| # peering connection. |
| }, |
| "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 isACTIVE. |
| "exportCustomRoutes": True or False, # Whether to export the custom routes to peer network. The default value is |
| # false. |
| "exportSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are exported. The default value |
| # is true, all subnet routes are exported.IPv4 |
| # special-use ranges 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. The default value is |
| # false. |
| "importSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are imported. The default value |
| # is false.IPv4 |
| # special-use ranges 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 withRFC1035. |
| # 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. |
| "peerMtu": 42, # Output only. [Output Only] Maximum Transmission Unit in bytes of the peer network. |
| "stackType": "A String", # Which IP version(s) of traffic and routes are allowed to be imported or |
| # exported between peer networks. The default value is IPV4_ONLY. |
| "state": "A String", # Output only. [Output Only] State for the peering. |
| "stateDetails": "A String", # Output only. [Output Only] Details about the current state of the peering. |
| "updateStrategy": "A String", # The update strategy determines the semantics for updates and deletes to the |
| # peering connection configuration. |
| }, |
| ], |
| "routingConfig": { # A routing configuration attached to a network resource. The message # The network-level routing configuration for this network. Used by Cloud |
| # Router to determine what type of network-wide routing behavior to enforce. |
| # includes the list of routers associated with the network, and a flag |
| # indicating the type of routing behavior to enforce network-wide. |
| "bgpAlwaysCompareMed": True or False, # Enable comparison of Multi-Exit Discriminators (MED) across routes with |
| # different neighbor ASNs when using the STANDARD BGP best path selection |
| # algorithm. |
| "bgpBestPathSelectionMode": "A String", # The BGP best path selection algorithm to be employed within this network |
| # for dynamic routes learned by Cloud Routers. Can be LEGACY |
| # (default) or STANDARD. |
| "bgpInterRegionCost": "A String", # Allows to define a preferred approach for handling inter-region cost in |
| # the selection process when using the STANDARD BGP best path |
| # selection algorithm. Can be DEFAULT orADD_COST_TO_MED. |
| "effectiveBgpAlwaysCompareMed": True or False, # Output only. [Output Only] Effective value of the bgp_always_compare_med |
| # field. |
| "effectiveBgpInterRegionCost": "A String", # Output only. [Output Only] Effective value of the bgp_inter_region_cost |
| # field. |
| "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 toGLOBAL, 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. |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. |
| "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks |
| # in this VPC network. |
| "A String", |
| ], |
| }, |
| ], |
| "kind": "compute#networkList", # Output only. [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 thanmaxResults, 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. [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, returnPartialSuccess=None, x__xgafv=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 - For routes exported from peer network. |
| OUTGOING - For routes exported from local network. |
| filter: string, A filter expression that filters resources listed in the response. Most |
| Compute resources support two types of filter expressions: |
| expressions that support regular expressions and expressions that follow |
| API improvement proposal AIP-160. |
| These two types of filter expressions cannot be mixed in one request. |
| |
| If you want to use AIP-160, your expression must specify the field name, an |
| operator, and the value that you want to use for filtering. The value |
| must be a string, a number, or a boolean. The operator |
| must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. |
| |
| For example, if you are filtering Compute Engine instances, you can |
| exclude instances named `example-instance` by specifying |
| `name != example-instance`. |
| |
| The `:*` comparison can be used to test whether a key has been defined. |
| For example, to find all objects with `owner` label use: |
| ``` |
| labels.owner:* |
| ``` |
| |
| You can also filter nested fields. For example, you could specify |
| `scheduling.automaticRestart = false` to include instances only |
| if they are not scheduled for automatic restarts. You can use filtering |
| on nested fields to filter based onresource 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) |
| ``` |
| |
| If you want to use a regular expression, use the `eq` (equal) or `ne` |
| (not equal) operator against a single un-parenthesized expression with or |
| without quotes or against multiple parenthesized expressions. Examples: |
| |
| `fieldname eq unquoted literal` |
| `fieldname eq 'single quoted literal'` |
| `fieldname eq "double quoted literal"` |
| `(fieldname1 eq literal) (fieldname2 ne "literal")` |
| |
| The literal value is interpreted as a regular expression using GoogleRE2 library syntax. |
| The literal value must match the entire field. |
| |
| For example, to filter for instances that do not end with name "instance", |
| you would use `name ne .*instance`. |
| |
| You cannot combine constraints on multiple fields using regular |
| expressions. |
| 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. |
| returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case |
| of failure. The default value is false. |
| |
| For example, when partial success behavior is enabled, aggregatedList for a |
| single zone scope either returns all resources in the zone or no resources, |
| with an error code. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| 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. [Output Only] Type of resource. Alwayscompute#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 thanmaxResults, 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. [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()</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()</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, x__xgafv=None)</code> |
| <pre>Patches the specified network with the data included in the request. |
| Only routingConfig can be modified. |
| |
| 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, readVirtual Private Cloud (VPC) Network. |
| "IPv4Range": "A String", # Deprecated in favor of subnet mode networks. |
| # The range of internal addresses that are legal on this network. This |
| # range is aCIDR specification, for example:192.168.0.0/16. Provided by the client when the network is |
| # created. |
| "autoCreateSubnetworks": True or False, # Must be set to create a VPC network. If not set, a legacy network is |
| # created. |
| # |
| # 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 inAuto mode VPC network IP ranges. |
| # |
| # For custom mode VPC networks, you can add subnets using the subnetworksinsert |
| # method. |
| "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 |
| # text format. |
| "description": "A String", # An optional description of this resource. Provide this field when you |
| # create the resource. |
| "enableUlaInternalIpv6": True or False, # Enable ULA internal ipv6 on this network. Enabling this feature will assign |
| # a /48 from google defined ULA prefix fd20::/20. |
| # . |
| "firewallPolicy": "A String", # Output only. [Output Only] URL of the firewall policy the network is associated with. |
| "gatewayIPv4": "A String", # [Output Only] The gateway address for default routing out of the network, |
| # selected by Google Cloud. |
| "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is |
| # defined by the server. |
| "internalIpv6Range": "A String", # When enabling ula internal ipv6, caller optionally can specify the /48 |
| # range they want from the google defined ULA prefix fd20::/20. The input |
| # must be a valid /48 ULA IPv6 address and must be within the fd20::/20. |
| # Operation will fail if the speficied /48 is already in used by another |
| # resource. If the field is not speficied, then a /48 range will be randomly |
| # allocated from fd20::/20 and returned via this field. |
| # . |
| "kind": "compute#network", # Output only. [Output Only] Type of the resource. Always compute#network for |
| # networks. |
| "mtu": 42, # Maximum Transmission Unit in bytes. |
| # The minimum value for this field is 1300 and the maximum value is 8896. |
| # The suggested value is 1500, which is the default MTU used on the |
| # Internet, or 8896 if you want to use Jumbo frames. If unspecified, the |
| # value defaults to 1460. |
| "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 withRFC1035. |
| # 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. |
| "networkFirewallPolicyEnforcementOrder": "A String", # The network firewall policy enforcement order. Can be either |
| # AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to |
| # AFTER_CLASSIC_FIREWALL if the field is not specified. |
| "networkProfile": "A String", # A full or partial URL of the network profile to apply to this network. |
| # This field can be set only at resource creation time. For example, the |
| # following are valid URLs: |
| # |
| # - https://www.googleapis.com/compute/{api_version}/projects/{project_id}/global/networkProfiles/{network_profile_name} |
| # - projects/{project_id}/global/networkProfiles/{network_profile_name} |
| "params": { # Additional network parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted |
| # as part of resource payload. |
| "resourceManagerTags": { # Tag keys/values directly bound to this resource. |
| # Tag keys and values have the same definition as resource |
| # manager tags. The field is allowed for INSERT |
| # only. The keys/values to set on the resource should be specified in |
| # either ID { : } or Namespaced format |
| # { : }. |
| # For example the following are valid inputs: |
| # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} |
| # * {"123/environment" : "production", "345/abc" : "xyz"} |
| # Note: |
| # * Invalid combinations of ID & namespaced format is not supported. For |
| # instance: {"123/environment" : "tagValues/444"} is invalid. |
| "a_key": "A String", |
| }, |
| }, |
| "peerings": [ # Output only. [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 theexchange_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 isACTIVE. |
| "connectionStatus": { # [Output Only] Describes the state of a peering connection, not just the # Output only. [Output Only] The effective state of the peering connection |
| # as a whole. |
| # local peering. This field provides information about the effective settings |
| # for the connection as a whole, including pending delete/update requests for |
| # CONSENSUS peerings. |
| "consensusState": { # The status of update/delete for a consensus peering connection. Only set # The consensus state contains information about the status of update |
| # and delete for a consensus peering connection. |
| # when connection_status.update_strategy isCONSENSUS or a network peering is proposing to update the |
| # strategy to CONSENSUS. |
| "deleteStatus": "A String", # The status of the delete request. |
| "updateStatus": "A String", # The status of the update request. |
| }, |
| "trafficConfiguration": { # The active connectivity settings for the peering connection based on the |
| # settings of the network peerings. |
| "exportCustomRoutesToPeer": True or False, # Whether custom routes are being exported to the peer network. |
| "exportSubnetRoutesWithPublicIpToPeer": True or False, # Whether subnet routes with public IP ranges are being exported to the |
| # peer network. |
| "importCustomRoutesFromPeer": True or False, # Whether custom routes are being imported from the peer network. |
| "importSubnetRoutesWithPublicIpFromPeer": True or False, # Whether subnet routes with public IP ranges are being imported |
| # from the peer network. |
| "stackType": "A String", # Which IP version(s) of traffic and routes are being imported or |
| # exported between peer networks. |
| }, |
| "updateStrategy": "A String", # The update strategy determines the update/delete semantics for this |
| # peering connection. |
| }, |
| "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 isACTIVE. |
| "exportCustomRoutes": True or False, # Whether to export the custom routes to peer network. The default value is |
| # false. |
| "exportSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are exported. The default value |
| # is true, all subnet routes are exported.IPv4 |
| # special-use ranges 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. The default value is |
| # false. |
| "importSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are imported. The default value |
| # is false.IPv4 |
| # special-use ranges 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 withRFC1035. |
| # 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. |
| "peerMtu": 42, # Output only. [Output Only] Maximum Transmission Unit in bytes of the peer network. |
| "stackType": "A String", # Which IP version(s) of traffic and routes are allowed to be imported or |
| # exported between peer networks. The default value is IPV4_ONLY. |
| "state": "A String", # Output only. [Output Only] State for the peering. |
| "stateDetails": "A String", # Output only. [Output Only] Details about the current state of the peering. |
| "updateStrategy": "A String", # The update strategy determines the semantics for updates and deletes to the |
| # peering connection configuration. |
| }, |
| ], |
| "routingConfig": { # A routing configuration attached to a network resource. The message # The network-level routing configuration for this network. Used by Cloud |
| # Router to determine what type of network-wide routing behavior to enforce. |
| # includes the list of routers associated with the network, and a flag |
| # indicating the type of routing behavior to enforce network-wide. |
| "bgpAlwaysCompareMed": True or False, # Enable comparison of Multi-Exit Discriminators (MED) across routes with |
| # different neighbor ASNs when using the STANDARD BGP best path selection |
| # algorithm. |
| "bgpBestPathSelectionMode": "A String", # The BGP best path selection algorithm to be employed within this network |
| # for dynamic routes learned by Cloud Routers. Can be LEGACY |
| # (default) or STANDARD. |
| "bgpInterRegionCost": "A String", # Allows to define a preferred approach for handling inter-region cost in |
| # the selection process when using the STANDARD BGP best path |
| # selection algorithm. Can be DEFAULT orADD_COST_TO_MED. |
| "effectiveBgpAlwaysCompareMed": True or False, # Output only. [Output Only] Effective value of the bgp_always_compare_med |
| # field. |
| "effectiveBgpInterRegionCost": "A String", # Output only. [Output Only] Effective value of the bgp_inter_region_cost |
| # field. |
| "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 toGLOBAL, 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. |
| "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. |
| "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). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # 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 `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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 inRFC3339 |
| # 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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "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. |
| }, |
| ], |
| }, |
| "getVersionOperationMetadata": { |
| "inlineSbomInfo": { |
| "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component |
| # name and the value is the version. |
| "a_key": "A String", |
| }, |
| "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the |
| # component name and the value is the version. |
| "a_key": "A String", |
| }, |
| }, |
| }, |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `user@example.com` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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, x__xgafv=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). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # 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 `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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 inRFC3339 |
| # 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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "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. |
| }, |
| ], |
| }, |
| "getVersionOperationMetadata": { |
| "inlineSbomInfo": { |
| "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component |
| # name and the value is the version. |
| "a_key": "A String", |
| }, |
| "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the |
| # component name and the value is the version. |
| "a_key": "A String", |
| }, |
| }, |
| }, |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `user@example.com` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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="requestRemovePeering">requestRemovePeering(project, network, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Requests to remove a peering from the specified network. Applicable only |
| for PeeringConnection with update_strategy=CONSENSUS. |
| |
| 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). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # 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 `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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 inRFC3339 |
| # 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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "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. |
| }, |
| ], |
| }, |
| "getVersionOperationMetadata": { |
| "inlineSbomInfo": { |
| "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component |
| # name and the value is the version. |
| "a_key": "A String", |
| }, |
| "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the |
| # component name and the value is the version. |
| "a_key": "A String", |
| }, |
| }, |
| }, |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `user@example.com` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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, x__xgafv=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). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # 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 `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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 inRFC3339 |
| # 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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "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. |
| }, |
| ], |
| }, |
| "getVersionOperationMetadata": { |
| "inlineSbomInfo": { |
| "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component |
| # name and the value is the version. |
| "a_key": "A String", |
| }, |
| "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the |
| # component name and the value is the version. |
| "a_key": "A String", |
| }, |
| }, |
| }, |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `user@example.com` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code> |
| <pre>Returns permissions that a caller has on the specified resource. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| resource: string, Name or id of the resource for this request. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "permissions": [ # The set of permissions to check for the 'resource'. Permissions with |
| # wildcards (such as '*' or 'storage.*') are not allowed. |
| "A String", |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is |
| # allowed. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="updatePeering">updatePeering(project, network, body=None, requestId=None, x__xgafv=None)</code> |
| <pre>Updates the specified network peering with the data included in the |
| request. You can only modify the NetworkPeering.export_custom_routes field |
| and the NetworkPeering.import_custom_routes field. |
| |
| 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 theexchange_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 isACTIVE. |
| "connectionStatus": { # [Output Only] Describes the state of a peering connection, not just the # Output only. [Output Only] The effective state of the peering connection |
| # as a whole. |
| # local peering. This field provides information about the effective settings |
| # for the connection as a whole, including pending delete/update requests for |
| # CONSENSUS peerings. |
| "consensusState": { # The status of update/delete for a consensus peering connection. Only set # The consensus state contains information about the status of update |
| # and delete for a consensus peering connection. |
| # when connection_status.update_strategy isCONSENSUS or a network peering is proposing to update the |
| # strategy to CONSENSUS. |
| "deleteStatus": "A String", # The status of the delete request. |
| "updateStatus": "A String", # The status of the update request. |
| }, |
| "trafficConfiguration": { # The active connectivity settings for the peering connection based on the |
| # settings of the network peerings. |
| "exportCustomRoutesToPeer": True or False, # Whether custom routes are being exported to the peer network. |
| "exportSubnetRoutesWithPublicIpToPeer": True or False, # Whether subnet routes with public IP ranges are being exported to the |
| # peer network. |
| "importCustomRoutesFromPeer": True or False, # Whether custom routes are being imported from the peer network. |
| "importSubnetRoutesWithPublicIpFromPeer": True or False, # Whether subnet routes with public IP ranges are being imported |
| # from the peer network. |
| "stackType": "A String", # Which IP version(s) of traffic and routes are being imported or |
| # exported between peer networks. |
| }, |
| "updateStrategy": "A String", # The update strategy determines the update/delete semantics for this |
| # peering connection. |
| }, |
| "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 isACTIVE. |
| "exportCustomRoutes": True or False, # Whether to export the custom routes to peer network. The default value is |
| # false. |
| "exportSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are exported. The default value |
| # is true, all subnet routes are exported.IPv4 |
| # special-use ranges 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. The default value is |
| # false. |
| "importSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are imported. The default value |
| # is false.IPv4 |
| # special-use ranges 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 withRFC1035. |
| # 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. |
| "peerMtu": 42, # Output only. [Output Only] Maximum Transmission Unit in bytes of the peer network. |
| "stackType": "A String", # Which IP version(s) of traffic and routes are allowed to be imported or |
| # exported between peer networks. The default value is IPV4_ONLY. |
| "state": "A String", # Output only. [Output Only] State for the peering. |
| "stateDetails": "A String", # Output only. [Output Only] Details about the current state of the peering. |
| "updateStrategy": "A String", # The update strategy determines the semantics for updates and deletes to the |
| # peering connection configuration. |
| }, |
| } |
| |
| 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). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents an Operation resource. |
| # |
| # Google Compute Engine has three Operation resources: |
| # |
| # * [Global](/compute/docs/reference/rest/beta/globalOperations) |
| # * [Regional](/compute/docs/reference/rest/beta/regionOperations) |
| # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) |
| # |
| # You can use an operation resource to manage asynchronous API requests. |
| # For more information, readHandling |
| # 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 `zoneOperations` resource. |
| # |
| # |
| # |
| # For more information, read |
| # Global, Regional, and Zonal Resources. |
| # |
| # Note that completed Operation resources have a limited |
| # retention period. |
| "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 inRFC3339 |
| # 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. |
| "errorDetails": [ # [Output Only] An optional list of messages that contain the error |
| # details. There is a set of defined message types to use for providing |
| # details.The syntax depends on the error code. For example, |
| # QuotaExceededInfo will have details when the error code is |
| # QUOTA_EXCEEDED. |
| { |
| "errorInfo": { # Describes the cause of the error with structured details. |
| # |
| # Example of an error when contacting the "pubsub.googleapis.com" API when it |
| # is not enabled: |
| # |
| # { "reason": "API_DISABLED" |
| # "domain": "googleapis.com" |
| # "metadata": { |
| # "resource": "projects/123", |
| # "service": "pubsub.googleapis.com" |
| # } |
| # } |
| # |
| # This response indicates that the pubsub.googleapis.com API is not enabled. |
| # |
| # Example of an error that is returned when attempting to create a Spanner |
| # instance in a region that is out of stock: |
| # |
| # { "reason": "STOCKOUT" |
| # "domain": "spanner.googleapis.com", |
| # "metadata": { |
| # "availableRegions": "us-central1,us-east2" |
| # } |
| # } |
| "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain |
| # is typically the registered service name of the tool or product that |
| # generates the error. Example: "pubsub.googleapis.com". If the error is |
| # generated by some common infrastructure, the error domain must be a |
| # globally unique value that identifies the infrastructure. For Google API |
| # infrastructure, the error domain is "googleapis.com". |
| "metadatas": { # Additional structured details about this error. |
| # |
| # Keys must match a regular expression of `a-z+` but should |
| # ideally be lowerCamelCase. Also, they must be limited to 64 characters in |
| # length. When identifying the current value of an exceeded limit, the units |
| # should be contained in the key, not the value. For example, rather than |
| # `{"instanceLimit": "100/request"}`, should be returned as, |
| # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of |
| # instances that can be created in a single (batch) request. |
| "a_key": "A String", |
| }, |
| "reason": "A String", # The reason of the error. This is a constant value that identifies the |
| # proximate cause of the error. Error reasons are unique within a particular |
| # domain of errors. This should be at most 63 characters and match a |
| # regular expression of `A-Z+[A-Z0-9]`, which represents |
| # UPPER_SNAKE_CASE. |
| }, |
| "help": { # Provides links to documentation or for performing an out of band action. |
| # |
| # For example, if a quota check failed with an error indicating the calling |
| # project hasn't enabled the accessed service, this can contain a URL pointing |
| # directly to the right place in the developer console to flip the bit. |
| "links": [ # URL(s) pointing to additional information on handling the current error. |
| { # Describes a URL link. |
| "description": "A String", # Describes what the link offers. |
| "url": "A String", # The URL of the link. |
| }, |
| ], |
| }, |
| "localizedMessage": { # Provides a localized error message that is safe to return to the user |
| # which can be attached to an RPC error. |
| "locale": "A String", # The locale used following the specification defined at |
| # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. |
| # Examples are: "en-US", "fr-CH", "es-MX" |
| "message": "A String", # The localized error message in the above locale. |
| }, |
| "quotaInfo": { # Additional details for quota exceeded error for resource quota. |
| "dimensions": { # The map holding related quota dimensions. |
| "a_key": "A String", |
| }, |
| "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota |
| # type or metric. |
| "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type |
| # or metric. |
| "limitName": "A String", # The name of the quota limit. |
| "metricName": "A String", # The Compute Engine quota metric name. |
| "rolloutStatus": "A String", # Rollout status of the future quota limit. |
| }, |
| }, |
| ], |
| "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. |
| }, |
| ], |
| }, |
| "getVersionOperationMetadata": { |
| "inlineSbomInfo": { |
| "currentComponentVersions": { # SBOM versions currently applied to the resource. The key is the component |
| # name and the value is the version. |
| "a_key": "A String", |
| }, |
| "targetComponentVersions": { # SBOM versions scheduled for the next maintenance. The key is the |
| # component name and the value is the version. |
| "a_key": "A String", |
| }, |
| }, |
| }, |
| "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 inRFC3339 |
| # text format. |
| "instancesBulkInsertOperationMetadata": { |
| "perLocationStatus": { # Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. |
| "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. |
| "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an |
| # error. |
| "status": "A String", # [Output Only] Creation status of BulkInsert operation - information |
| # if the flow is rolling forward or rolling back. |
| "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. |
| }, |
| }, |
| }, |
| "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for |
| # Operation resources. |
| "name": "A String", # [Output Only] Name of the operation. |
| "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a |
| # group of operations results from a `bulkInsert` API request. |
| "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. |
| "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, |
| # this field will contain information on all underlying zonal actions and |
| # their state. |
| "clientOperationId": "A String", # [Output Only] The client operation id. |
| "perLocationOperations": { # [Output Only] Status information per location (location name is key). |
| # Example key: zones/us-central1-a |
| "a_key": { |
| "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is |
| # populated. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| }, |
| "state": "A String", # [Output Only] Status of the action, which can be one of the following: |
| # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. |
| }, |
| }, |
| }, |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. |
| # This value is inRFC3339 |
| # 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 disk |
| # that the snapshot was created from. |
| "user": "A String", # [Output Only] User who requested the operation, for example: |
| # `user@example.com` or |
| # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. |
| "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> |
