addAssociation(project, region, networkPolicy, body=None, requestId=None, x__xgafv=None)
Inserts an association for the specified network policy.
Inserts a rule into a network policy.
Retrieves an aggregated list of network policies.
Retrieves the next page of results.
Close httplib2 connections.
delete(project, region, networkPolicy, requestId=None, x__xgafv=None)
Deletes the specified policy.
get(project, region, networkPolicy, x__xgafv=None)
Returns the specified network policy.
getAssociation(project, region, networkPolicy, name=None, x__xgafv=None)
Gets an association with the specified name.
getTrafficClassificationRule(project, region, networkPolicy, priority=None, x__xgafv=None)
Gets a rule of the specified priority.
insert(project, region, body=None, requestId=None, x__xgafv=None)
Creates a new policy in the specified project using the data included in
Lists all the policies that have been configured for the specified project
Retrieves the next page of results.
patch(project, region, networkPolicy, body=None, requestId=None, x__xgafv=None)
Patches the specified policy with the data included in the
Patches a rule of the specified priority.
removeAssociation(project, region, networkPolicy, name=None, requestId=None, x__xgafv=None)
Removes an association for the specified network policy.
Deletes a rule of the specified priority.
addAssociation(project, region, networkPolicy, body=None, requestId=None, x__xgafv=None)
Inserts an association for the specified network policy.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region of this request. (required)
networkPolicy: string, Name of the network policy resource to update. (required)
body: object, The request body.
The object takes the form of:
{
"attachmentTarget": "A String", # The target that the network policy is attached to.
"name": "A String", # The name for an association.
}
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.
},
],
},
"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] Type of the resource. Always `compute#operation` for
# Operation resources.
"name": "A String", # [Output Only] Name of the operation.
"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a
# group of operations results from a `bulkInsert` API request.
"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] 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.
}
addTrafficClassificationRule(project, region, networkPolicy, body=None, requestId=None, x__xgafv=None)
Inserts a rule into a network policy.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region of this request. (required)
networkPolicy: string, Name of the network policy resource to update. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a traffic classification rule that describes one or more match
# conditions along with the action to be taken when traffic matches this
# condition.
"action": { # The Action to perform when the client connection triggers the rule.
"dscpMode": "A String", # DSCP mode. When set to AUTO, the DSCP value will be picked
# automatically based on selected trafficClass. Otherwise,dscpValue needs to be explicitly specified.
"dscpValue": 42, # Custom DSCP value from 0-63 range.
"trafficClass": "A String", # The traffic class that should be applied to the matching packet.
"type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
},
"description": "A String", # An optional description for this resource.
"disabled": True or False, # Denotes whether the network policy rule is disabled. When set to true,
# the network policy rule is not enforced and traffic behaves as if it did
# not exist. If this is unspecified, the network policy rule will be
# enabled.
"kind": "compute#networkPolicyTrafficClassificationRule", # [Output only] Type of the resource. Alwayscompute#networkPolicyTrafficClassificationRule for network
# policy traffic classification rules
"match": { # Represents a match condition that incoming traffic is evaluated against. # A match condition that outgoing traffic is evaluated against.
# If it evaluates to true, the corresponding 'action' is enforced.
# Exactly one field must be specified.
"destIpRanges": [ # CIDR IP address range.
# Maximum number of destination CIDR IP ranges allowed is 5000.
"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 traffic classification 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, TCP or SCTP 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",
],
},
],
"srcIpRanges": [ # CIDR IP address range.
# Maximum number of source CIDR IP ranges allowed is 5000.
"A String",
],
},
"priority": 42, # An integer indicating the priority of a rule in the list. The priority
# must be a positive value between 1 and 2147482647.
# The priority values from 2147482648 to 2147483647 (1000) are reserved for
# system default network policy rules. Rules are evaluated from highest to
# lowest priority where 1 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] Calculation of the complexity of a single network policy
# rule.
"targetSecureTags": [ # A list of secure tags that controls which instances the traffic
# classification rule applies to. If targetSecureTag are
# specified, then the traffic classification rule applies only to instances
# in the VPC network that have one of those EFFECTIVE secure tags, if all
# the targetSecureTag are in INEFFECTIVE state, then this rule
# will be ignored. targetSecureTag may not be set at the same
# time as targetServiceAccounts. If neithertargetServiceAccounts nor targetSecureTag are
# specified, the traffic classification 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] 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",
],
}
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.
},
],
},
"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] Type of the resource. Always `compute#operation` for
# Operation resources.
"name": "A String", # [Output Only] Name of the operation.
"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a
# group of operations results from a `bulkInsert` API request.
"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] 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.
}
aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
Retrieves an aggregated list of network policies.
To prevent failure, it's recommended that you set the
`returnPartialSuccess` parameter to `true`.
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.
includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
global) should be included in the response. For new resource types added
after this field, the flag has no effect as new resource types will always
include every visible scope for each scope type in response. For resource
types which predate this field, if this flag is omitted or false, only
scopes of the scope types where the resource type is expected to be found
will be included.
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.
serviceProjectNumber: string, The Shared VPC service project id or service project number for which
aggregated list request is invoked for subnetworks list-usable api.
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 NetworkPoliciesScopedList resources.
"a_key": { # Name of the scope containing this set of addresses.
"networkPolicies": [ # A list of network policies contained in this scope.
{ # Represents a Network Policy resource.
"associations": [ # [Output Only] A list of associations that belong to this network policy.
{
"attachmentTarget": "A String", # The target that the network policy is attached to.
"name": "A String", # The name for an association.
},
],
"creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
# text format.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
"kind": "compute#networkPolicy", # [Output only] Type of the resource. Alwayscompute#networkPolicy for network policies
"name": "A String", # Name of the resource.
"region": "A String", # [Output Only] URL of the region where the regional network policy resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
"ruleTupleCount": 42, # [Output Only] Total count of all network policy rule tuples. A network
# policy can not exceed a set number of tuples.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"trafficClassificationRules": [ # [Output Only] A list of traffic classification rules that belong to this
# policy.
{ # Represents a traffic classification rule that describes one or more match
# conditions along with the action to be taken when traffic matches this
# condition.
"action": { # The Action to perform when the client connection triggers the rule.
"dscpMode": "A String", # DSCP mode. When set to AUTO, the DSCP value will be picked
# automatically based on selected trafficClass. Otherwise,dscpValue needs to be explicitly specified.
"dscpValue": 42, # Custom DSCP value from 0-63 range.
"trafficClass": "A String", # The traffic class that should be applied to the matching packet.
"type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
},
"description": "A String", # An optional description for this resource.
"disabled": True or False, # Denotes whether the network policy rule is disabled. When set to true,
# the network policy rule is not enforced and traffic behaves as if it did
# not exist. If this is unspecified, the network policy rule will be
# enabled.
"kind": "compute#networkPolicyTrafficClassificationRule", # [Output only] Type of the resource. Alwayscompute#networkPolicyTrafficClassificationRule for network
# policy traffic classification rules
"match": { # Represents a match condition that incoming traffic is evaluated against. # A match condition that outgoing traffic is evaluated against.
# If it evaluates to true, the corresponding 'action' is enforced.
# Exactly one field must be specified.
"destIpRanges": [ # CIDR IP address range.
# Maximum number of destination CIDR IP ranges allowed is 5000.
"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 traffic classification 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, TCP or SCTP 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",
],
},
],
"srcIpRanges": [ # CIDR IP address range.
# Maximum number of source CIDR IP ranges allowed is 5000.
"A String",
],
},
"priority": 42, # An integer indicating the priority of a rule in the list. The priority
# must be a positive value between 1 and 2147482647.
# The priority values from 2147482648 to 2147483647 (1000) are reserved for
# system default network policy rules. Rules are evaluated from highest to
# lowest priority where 1 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] Calculation of the complexity of a single network policy
# rule.
"targetSecureTags": [ # A list of secure tags that controls which instances the traffic
# classification rule applies to. If targetSecureTag are
# specified, then the traffic classification rule applies only to instances
# in the VPC network that have one of those EFFECTIVE secure tags, if all
# the targetSecureTag are in INEFFECTIVE state, then this rule
# will be ignored. targetSecureTag may not be set at the same
# time as targetServiceAccounts. If neithertargetServiceAccounts nor targetSecureTag are
# specified, the traffic classification 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] 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",
],
},
],
},
],
"warning": { # Informational warning which replaces the list of network policies when
# the list is empty.
"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.
},
},
},
"kind": "compute#networkPolicyAggregatedList", # [Output Only] Type of resource. Alwayscompute#networkPolicyAggregatedList for lists of
# network policies.
"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] Server-defined URL for this resource.
"unreachables": [ # [Output Only] Unreachable resources.
"A String",
],
"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.
},
}
aggregatedList_next()
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.
close()
Close httplib2 connections.
delete(project, region, networkPolicy, requestId=None, x__xgafv=None)
Deletes the specified policy.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region of this request. (required)
networkPolicy: string, Name of the network policy resource 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.
},
],
},
"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] Type of the resource. Always `compute#operation` for
# Operation resources.
"name": "A String", # [Output Only] Name of the operation.
"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a
# group of operations results from a `bulkInsert` API request.
"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] 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.
}
get(project, region, networkPolicy, x__xgafv=None)
Returns the specified network policy.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region of this request. (required)
networkPolicy: string, Name of the network policy resource 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 Network Policy resource.
"associations": [ # [Output Only] A list of associations that belong to this network policy.
{
"attachmentTarget": "A String", # The target that the network policy is attached to.
"name": "A String", # The name for an association.
},
],
"creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
# text format.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
"kind": "compute#networkPolicy", # [Output only] Type of the resource. Alwayscompute#networkPolicy for network policies
"name": "A String", # Name of the resource.
"region": "A String", # [Output Only] URL of the region where the regional network policy resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
"ruleTupleCount": 42, # [Output Only] Total count of all network policy rule tuples. A network
# policy can not exceed a set number of tuples.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"trafficClassificationRules": [ # [Output Only] A list of traffic classification rules that belong to this
# policy.
{ # Represents a traffic classification rule that describes one or more match
# conditions along with the action to be taken when traffic matches this
# condition.
"action": { # The Action to perform when the client connection triggers the rule.
"dscpMode": "A String", # DSCP mode. When set to AUTO, the DSCP value will be picked
# automatically based on selected trafficClass. Otherwise,dscpValue needs to be explicitly specified.
"dscpValue": 42, # Custom DSCP value from 0-63 range.
"trafficClass": "A String", # The traffic class that should be applied to the matching packet.
"type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
},
"description": "A String", # An optional description for this resource.
"disabled": True or False, # Denotes whether the network policy rule is disabled. When set to true,
# the network policy rule is not enforced and traffic behaves as if it did
# not exist. If this is unspecified, the network policy rule will be
# enabled.
"kind": "compute#networkPolicyTrafficClassificationRule", # [Output only] Type of the resource. Alwayscompute#networkPolicyTrafficClassificationRule for network
# policy traffic classification rules
"match": { # Represents a match condition that incoming traffic is evaluated against. # A match condition that outgoing traffic is evaluated against.
# If it evaluates to true, the corresponding 'action' is enforced.
# Exactly one field must be specified.
"destIpRanges": [ # CIDR IP address range.
# Maximum number of destination CIDR IP ranges allowed is 5000.
"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 traffic classification 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, TCP or SCTP 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",
],
},
],
"srcIpRanges": [ # CIDR IP address range.
# Maximum number of source CIDR IP ranges allowed is 5000.
"A String",
],
},
"priority": 42, # An integer indicating the priority of a rule in the list. The priority
# must be a positive value between 1 and 2147482647.
# The priority values from 2147482648 to 2147483647 (1000) are reserved for
# system default network policy rules. Rules are evaluated from highest to
# lowest priority where 1 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] Calculation of the complexity of a single network policy
# rule.
"targetSecureTags": [ # A list of secure tags that controls which instances the traffic
# classification rule applies to. If targetSecureTag are
# specified, then the traffic classification rule applies only to instances
# in the VPC network that have one of those EFFECTIVE secure tags, if all
# the targetSecureTag are in INEFFECTIVE state, then this rule
# will be ignored. targetSecureTag may not be set at the same
# time as targetServiceAccounts. If neithertargetServiceAccounts nor targetSecureTag are
# specified, the traffic classification 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] 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",
],
},
],
}
getAssociation(project, region, networkPolicy, name=None, x__xgafv=None)
Gets an association with the specified name.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region of this request. (required)
networkPolicy: string, Name of the network policy to which the queried association belongs. (required)
name: string, The name of the association to get from the network policy.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"attachmentTarget": "A String", # The target that the network policy is attached to.
"name": "A String", # The name for an association.
}
getTrafficClassificationRule(project, region, networkPolicy, priority=None, x__xgafv=None)
Gets a rule of the specified priority.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region of this request. (required)
networkPolicy: string, Name of the network policy to which the queried rule belongs. (required)
priority: integer, The priority of the rule to get from the network policy.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a traffic classification rule that describes one or more match
# conditions along with the action to be taken when traffic matches this
# condition.
"action": { # The Action to perform when the client connection triggers the rule.
"dscpMode": "A String", # DSCP mode. When set to AUTO, the DSCP value will be picked
# automatically based on selected trafficClass. Otherwise,dscpValue needs to be explicitly specified.
"dscpValue": 42, # Custom DSCP value from 0-63 range.
"trafficClass": "A String", # The traffic class that should be applied to the matching packet.
"type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
},
"description": "A String", # An optional description for this resource.
"disabled": True or False, # Denotes whether the network policy rule is disabled. When set to true,
# the network policy rule is not enforced and traffic behaves as if it did
# not exist. If this is unspecified, the network policy rule will be
# enabled.
"kind": "compute#networkPolicyTrafficClassificationRule", # [Output only] Type of the resource. Alwayscompute#networkPolicyTrafficClassificationRule for network
# policy traffic classification rules
"match": { # Represents a match condition that incoming traffic is evaluated against. # A match condition that outgoing traffic is evaluated against.
# If it evaluates to true, the corresponding 'action' is enforced.
# Exactly one field must be specified.
"destIpRanges": [ # CIDR IP address range.
# Maximum number of destination CIDR IP ranges allowed is 5000.
"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 traffic classification 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, TCP or SCTP 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",
],
},
],
"srcIpRanges": [ # CIDR IP address range.
# Maximum number of source CIDR IP ranges allowed is 5000.
"A String",
],
},
"priority": 42, # An integer indicating the priority of a rule in the list. The priority
# must be a positive value between 1 and 2147482647.
# The priority values from 2147482648 to 2147483647 (1000) are reserved for
# system default network policy rules. Rules are evaluated from highest to
# lowest priority where 1 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] Calculation of the complexity of a single network policy
# rule.
"targetSecureTags": [ # A list of secure tags that controls which instances the traffic
# classification rule applies to. If targetSecureTag are
# specified, then the traffic classification rule applies only to instances
# in the VPC network that have one of those EFFECTIVE secure tags, if all
# the targetSecureTag are in INEFFECTIVE state, then this rule
# will be ignored. targetSecureTag may not be set at the same
# time as targetServiceAccounts. If neithertargetServiceAccounts nor targetSecureTag are
# specified, the traffic classification 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] 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",
],
}
insert(project, region, body=None, requestId=None, x__xgafv=None)
Creates a new policy in the specified project using the data included in
the request.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region of this request. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a Network Policy resource.
"associations": [ # [Output Only] A list of associations that belong to this network policy.
{
"attachmentTarget": "A String", # The target that the network policy is attached to.
"name": "A String", # The name for an association.
},
],
"creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
# text format.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
"kind": "compute#networkPolicy", # [Output only] Type of the resource. Alwayscompute#networkPolicy for network policies
"name": "A String", # Name of the resource.
"region": "A String", # [Output Only] URL of the region where the regional network policy resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
"ruleTupleCount": 42, # [Output Only] Total count of all network policy rule tuples. A network
# policy can not exceed a set number of tuples.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"trafficClassificationRules": [ # [Output Only] A list of traffic classification rules that belong to this
# policy.
{ # Represents a traffic classification rule that describes one or more match
# conditions along with the action to be taken when traffic matches this
# condition.
"action": { # The Action to perform when the client connection triggers the rule.
"dscpMode": "A String", # DSCP mode. When set to AUTO, the DSCP value will be picked
# automatically based on selected trafficClass. Otherwise,dscpValue needs to be explicitly specified.
"dscpValue": 42, # Custom DSCP value from 0-63 range.
"trafficClass": "A String", # The traffic class that should be applied to the matching packet.
"type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
},
"description": "A String", # An optional description for this resource.
"disabled": True or False, # Denotes whether the network policy rule is disabled. When set to true,
# the network policy rule is not enforced and traffic behaves as if it did
# not exist. If this is unspecified, the network policy rule will be
# enabled.
"kind": "compute#networkPolicyTrafficClassificationRule", # [Output only] Type of the resource. Alwayscompute#networkPolicyTrafficClassificationRule for network
# policy traffic classification rules
"match": { # Represents a match condition that incoming traffic is evaluated against. # A match condition that outgoing traffic is evaluated against.
# If it evaluates to true, the corresponding 'action' is enforced.
# Exactly one field must be specified.
"destIpRanges": [ # CIDR IP address range.
# Maximum number of destination CIDR IP ranges allowed is 5000.
"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 traffic classification 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, TCP or SCTP 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",
],
},
],
"srcIpRanges": [ # CIDR IP address range.
# Maximum number of source CIDR IP ranges allowed is 5000.
"A String",
],
},
"priority": 42, # An integer indicating the priority of a rule in the list. The priority
# must be a positive value between 1 and 2147482647.
# The priority values from 2147482648 to 2147483647 (1000) are reserved for
# system default network policy rules. Rules are evaluated from highest to
# lowest priority where 1 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] Calculation of the complexity of a single network policy
# rule.
"targetSecureTags": [ # A list of secure tags that controls which instances the traffic
# classification rule applies to. If targetSecureTag are
# specified, then the traffic classification rule applies only to instances
# in the VPC network that have one of those EFFECTIVE secure tags, if all
# the targetSecureTag are in INEFFECTIVE state, then this rule
# will be ignored. targetSecureTag may not be set at the same
# time as targetServiceAccounts. If neithertargetServiceAccounts nor targetSecureTag are
# specified, the traffic classification 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] 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",
],
},
],
}
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.
},
],
},
"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] Type of the resource. Always `compute#operation` for
# Operation resources.
"name": "A String", # [Output Only] Name of the operation.
"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a
# group of operations results from a `bulkInsert` API request.
"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] 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.
}
list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists all the policies that have been configured for the specified project
in the given region.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region of 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:
{
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"items": [ # A list of NetworkPolicy resources.
{ # Represents a Network Policy resource.
"associations": [ # [Output Only] A list of associations that belong to this network policy.
{
"attachmentTarget": "A String", # The target that the network policy is attached to.
"name": "A String", # The name for an association.
},
],
"creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
# text format.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
"kind": "compute#networkPolicy", # [Output only] Type of the resource. Alwayscompute#networkPolicy for network policies
"name": "A String", # Name of the resource.
"region": "A String", # [Output Only] URL of the region where the regional network policy resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
"ruleTupleCount": 42, # [Output Only] Total count of all network policy rule tuples. A network
# policy can not exceed a set number of tuples.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"trafficClassificationRules": [ # [Output Only] A list of traffic classification rules that belong to this
# policy.
{ # Represents a traffic classification rule that describes one or more match
# conditions along with the action to be taken when traffic matches this
# condition.
"action": { # The Action to perform when the client connection triggers the rule.
"dscpMode": "A String", # DSCP mode. When set to AUTO, the DSCP value will be picked
# automatically based on selected trafficClass. Otherwise,dscpValue needs to be explicitly specified.
"dscpValue": 42, # Custom DSCP value from 0-63 range.
"trafficClass": "A String", # The traffic class that should be applied to the matching packet.
"type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
},
"description": "A String", # An optional description for this resource.
"disabled": True or False, # Denotes whether the network policy rule is disabled. When set to true,
# the network policy rule is not enforced and traffic behaves as if it did
# not exist. If this is unspecified, the network policy rule will be
# enabled.
"kind": "compute#networkPolicyTrafficClassificationRule", # [Output only] Type of the resource. Alwayscompute#networkPolicyTrafficClassificationRule for network
# policy traffic classification rules
"match": { # Represents a match condition that incoming traffic is evaluated against. # A match condition that outgoing traffic is evaluated against.
# If it evaluates to true, the corresponding 'action' is enforced.
# Exactly one field must be specified.
"destIpRanges": [ # CIDR IP address range.
# Maximum number of destination CIDR IP ranges allowed is 5000.
"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 traffic classification 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, TCP or SCTP 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",
],
},
],
"srcIpRanges": [ # CIDR IP address range.
# Maximum number of source CIDR IP ranges allowed is 5000.
"A String",
],
},
"priority": 42, # An integer indicating the priority of a rule in the list. The priority
# must be a positive value between 1 and 2147482647.
# The priority values from 2147482648 to 2147483647 (1000) are reserved for
# system default network policy rules. Rules are evaluated from highest to
# lowest priority where 1 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] Calculation of the complexity of a single network policy
# rule.
"targetSecureTags": [ # A list of secure tags that controls which instances the traffic
# classification rule applies to. If targetSecureTag are
# specified, then the traffic classification rule applies only to instances
# in the VPC network that have one of those EFFECTIVE secure tags, if all
# the targetSecureTag are in INEFFECTIVE state, then this rule
# will be ignored. targetSecureTag may not be set at the same
# time as targetServiceAccounts. If neithertargetServiceAccounts nor targetSecureTag are
# specified, the traffic classification 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] 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",
],
},
],
},
],
"kind": "compute#networkPolicyList", # [Output Only] Type of resource. Alwayscompute#networkPolicyList for lists of network policies.
"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.
"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.
},
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(project, region, networkPolicy, body=None, requestId=None, x__xgafv=None)
Patches the specified policy with the data included in the
request.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region of this request. (required)
networkPolicy: string, Name of the network policy resource to update. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a Network Policy resource.
"associations": [ # [Output Only] A list of associations that belong to this network policy.
{
"attachmentTarget": "A String", # The target that the network policy is attached to.
"name": "A String", # The name for an association.
},
],
"creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
# text format.
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
"kind": "compute#networkPolicy", # [Output only] Type of the resource. Alwayscompute#networkPolicy for network policies
"name": "A String", # Name of the resource.
"region": "A String", # [Output Only] URL of the region where the regional network policy resides.
# You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
"ruleTupleCount": 42, # [Output Only] Total count of all network policy rule tuples. A network
# policy can not exceed a set number of tuples.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"trafficClassificationRules": [ # [Output Only] A list of traffic classification rules that belong to this
# policy.
{ # Represents a traffic classification rule that describes one or more match
# conditions along with the action to be taken when traffic matches this
# condition.
"action": { # The Action to perform when the client connection triggers the rule.
"dscpMode": "A String", # DSCP mode. When set to AUTO, the DSCP value will be picked
# automatically based on selected trafficClass. Otherwise,dscpValue needs to be explicitly specified.
"dscpValue": 42, # Custom DSCP value from 0-63 range.
"trafficClass": "A String", # The traffic class that should be applied to the matching packet.
"type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
},
"description": "A String", # An optional description for this resource.
"disabled": True or False, # Denotes whether the network policy rule is disabled. When set to true,
# the network policy rule is not enforced and traffic behaves as if it did
# not exist. If this is unspecified, the network policy rule will be
# enabled.
"kind": "compute#networkPolicyTrafficClassificationRule", # [Output only] Type of the resource. Alwayscompute#networkPolicyTrafficClassificationRule for network
# policy traffic classification rules
"match": { # Represents a match condition that incoming traffic is evaluated against. # A match condition that outgoing traffic is evaluated against.
# If it evaluates to true, the corresponding 'action' is enforced.
# Exactly one field must be specified.
"destIpRanges": [ # CIDR IP address range.
# Maximum number of destination CIDR IP ranges allowed is 5000.
"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 traffic classification 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, TCP or SCTP 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",
],
},
],
"srcIpRanges": [ # CIDR IP address range.
# Maximum number of source CIDR IP ranges allowed is 5000.
"A String",
],
},
"priority": 42, # An integer indicating the priority of a rule in the list. The priority
# must be a positive value between 1 and 2147482647.
# The priority values from 2147482648 to 2147483647 (1000) are reserved for
# system default network policy rules. Rules are evaluated from highest to
# lowest priority where 1 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] Calculation of the complexity of a single network policy
# rule.
"targetSecureTags": [ # A list of secure tags that controls which instances the traffic
# classification rule applies to. If targetSecureTag are
# specified, then the traffic classification rule applies only to instances
# in the VPC network that have one of those EFFECTIVE secure tags, if all
# the targetSecureTag are in INEFFECTIVE state, then this rule
# will be ignored. targetSecureTag may not be set at the same
# time as targetServiceAccounts. If neithertargetServiceAccounts nor targetSecureTag are
# specified, the traffic classification 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] 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",
],
},
],
}
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.
},
],
},
"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] Type of the resource. Always `compute#operation` for
# Operation resources.
"name": "A String", # [Output Only] Name of the operation.
"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a
# group of operations results from a `bulkInsert` API request.
"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] 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.
}
patchTrafficClassificationRule(project, region, networkPolicy, body=None, priority=None, requestId=None, x__xgafv=None)
Patches a rule of the specified priority.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region of this request. (required)
networkPolicy: string, Name of the network policy resource to update. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a traffic classification rule that describes one or more match
# conditions along with the action to be taken when traffic matches this
# condition.
"action": { # The Action to perform when the client connection triggers the rule.
"dscpMode": "A String", # DSCP mode. When set to AUTO, the DSCP value will be picked
# automatically based on selected trafficClass. Otherwise,dscpValue needs to be explicitly specified.
"dscpValue": 42, # Custom DSCP value from 0-63 range.
"trafficClass": "A String", # The traffic class that should be applied to the matching packet.
"type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
},
"description": "A String", # An optional description for this resource.
"disabled": True or False, # Denotes whether the network policy rule is disabled. When set to true,
# the network policy rule is not enforced and traffic behaves as if it did
# not exist. If this is unspecified, the network policy rule will be
# enabled.
"kind": "compute#networkPolicyTrafficClassificationRule", # [Output only] Type of the resource. Alwayscompute#networkPolicyTrafficClassificationRule for network
# policy traffic classification rules
"match": { # Represents a match condition that incoming traffic is evaluated against. # A match condition that outgoing traffic is evaluated against.
# If it evaluates to true, the corresponding 'action' is enforced.
# Exactly one field must be specified.
"destIpRanges": [ # CIDR IP address range.
# Maximum number of destination CIDR IP ranges allowed is 5000.
"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 traffic classification 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, TCP or SCTP 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",
],
},
],
"srcIpRanges": [ # CIDR IP address range.
# Maximum number of source CIDR IP ranges allowed is 5000.
"A String",
],
},
"priority": 42, # An integer indicating the priority of a rule in the list. The priority
# must be a positive value between 1 and 2147482647.
# The priority values from 2147482648 to 2147483647 (1000) are reserved for
# system default network policy rules. Rules are evaluated from highest to
# lowest priority where 1 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] Calculation of the complexity of a single network policy
# rule.
"targetSecureTags": [ # A list of secure tags that controls which instances the traffic
# classification rule applies to. If targetSecureTag are
# specified, then the traffic classification rule applies only to instances
# in the VPC network that have one of those EFFECTIVE secure tags, if all
# the targetSecureTag are in INEFFECTIVE state, then this rule
# will be ignored. targetSecureTag may not be set at the same
# time as targetServiceAccounts. If neithertargetServiceAccounts nor targetSecureTag are
# specified, the traffic classification 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] 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",
],
}
priority: integer, The priority of the traffic classification rule to patch. Only rules with
a priority value between 1 and 2147482647 (inclusive) can be patched.
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.
},
],
},
"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] Type of the resource. Always `compute#operation` for
# Operation resources.
"name": "A String", # [Output Only] Name of the operation.
"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a
# group of operations results from a `bulkInsert` API request.
"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] 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.
}
removeAssociation(project, region, networkPolicy, name=None, requestId=None, x__xgafv=None)
Removes an association for the specified network policy.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region of this request. (required)
networkPolicy: string, Name of the network policy resource to update. (required)
name: string, Name for the association that will be removed.
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.
},
],
},
"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] Type of the resource. Always `compute#operation` for
# Operation resources.
"name": "A String", # [Output Only] Name of the operation.
"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a
# group of operations results from a `bulkInsert` API request.
"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] 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.
}
removeTrafficClassificationRule(project, region, networkPolicy, priority=None, requestId=None, x__xgafv=None)
Deletes a rule of the specified priority.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region of this request. (required)
networkPolicy: string, Name of the network policy resource to update. (required)
priority: integer, The priority of the rule to remove from the network policy.
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.
},
],
},
"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] Type of the resource. Always `compute#operation` for
# Operation resources.
"name": "A String", # [Output Only] Name of the operation.
"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a
# group of operations results from a `bulkInsert` API request.
"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] 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.
}