Close httplib2 connections.
delete(project, region, sslPolicy, requestId=None, x__xgafv=None)
Deletes the specified SSL policy. The SSL policy resource can be deleted
get(project, region, sslPolicy, x__xgafv=None)
Lists all of the ordered rules present in a single specified policy.
getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. May be empty if no such
insert(project, region, body=None, requestId=None, x__xgafv=None)
Creates a new policy in the specified project and region using the data
Lists all the SSL policies that have been configured for the specified
Lists all features that can be specified in the SSL policy when using
Retrieves the next page of results.
patch(project, region, sslPolicy, body=None, requestId=None, x__xgafv=None)
Patches the specified SSL policy with the data included in the request.
setIamPolicy(project, region, resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource.
testIamPermissions(project, region, resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource.
close()
Close httplib2 connections.
delete(project, region, sslPolicy, requestId=None, x__xgafv=None)
Deletes the specified SSL policy. The SSL policy resource can be deleted
only if it is not in use by any TargetHttpsProxy or TargetSslProxy
resources.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region scoping this request. (required)
sslPolicy: string, Name of the SSL policy to delete. The name must be 1-63 characters long,
and comply with RFC1035. (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/alpha/globalOperations)
# * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
# * [Zonal](/compute/docs/reference/rest/alpha/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.
{ # Represents a single error encountered during the processing of an
# 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.
{ # Container for structured error details providing additional context
# specific to the encountered error code.
"errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata.
#
# 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. # Links and information to help the user resolve the error.
#
# 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 # A localized human-readable error message intended for end users.
# 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. # Details about quota limits and metrics when a quota is exceeded.
"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.
},
],
},
"firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the
# networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule
# methods if not explicitly provided by the user.
"allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query
# parameters specified minPriority/maxPriority.
},
"getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. [Output Only] Metadata for GetHealth operations.
"healthInfo": { # Health information. # Output only. The health information.
"availabilitySloStatus": "A String", # Output only. The availability SLO status.
"healthStatus": "A String", # Output only. The health status.
"repairCategory": "A String", # Output only. The repair category.
"unhealthyReason": "A String", # Output only. The reason for unhealthy status.
"updateTime": "A String", # Output only. The time when health info was updated.
},
},
"getVersionOperationMetadata": {
"inlineSbomInfo": {
"currentComponentVersions": { # A mapping of components to their currently-applied versions or other
# appropriate identifiers.
"a_key": "A String",
},
"targetComponentVersions": { # A mapping of components to their target versions or other appropriate
# identifiers.
"a_key": "A String",
},
},
},
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
# status code that was returned. For example, a `404` means the
# resource was not found.
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
# defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested.
# This value is inRFC3339
# text format.
"instancesBulkInsertOperationMetadata": {
"perLocationStatus": { # Status information per location (location name is key).
# Example key: zones/us-central1-a
"a_key": {
"createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
"deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
"failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
# error.
"status": "A String", # [Output Only] Creation status of BulkInsert operation - information
# if the flow is rolling forward or rolling back.
"targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
},
},
},
"kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
# Operation resources.
"name": "A String", # [Output Only] Name of the operation.
"operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
# group of operations results from a `bulkInsert` API request.
"operationType": "A String", # [Output Only] The type of operation, such as `insert`,
# `update`, or `delete`, and so on.
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
# There is no requirement that this be linear or support any granularity of
# operations. This should not be used to guess when the operation will be
# complete. This number should monotonically increase as the operation
# progresses.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only
# applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
"setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
# this field will contain information on all underlying zonal actions and
# their state.
"clientOperationId": "A String", # [Output Only] The client operation id.
"perLocationOperations": { # [Output Only] Status information per location (location name is key).
# Example key: zones/us-central1-a
"a_key": {
"error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
# populated.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
},
"state": "A String", # [Output Only] Status of the action, which can be one of the following:
# `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
},
},
},
"startTime": "A String", # [Output Only] The time that this operation was started by the server.
# This value is inRFC3339
# text format.
"status": "A String", # [Output Only] The status of the operation, which can be one of the
# following:
# `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
# operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
# of the target resource.
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
# operations related to creating a snapshot, this points to the disk
# that the snapshot was created from.
"user": "A String", # [Output Only] User who requested the operation, for example:
# `user@example.com` or
# `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the
# operation, this field will be populated.
{
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
# Engine returns NO_RESULTS_ON_PAGE if there
# are no results in the response.
"data": [ # [Output Only] Metadata about this warning in key:
# value format. For example:
#
# "data": [
# {
# "key": "scope",
# "value": "zones/us-east1-d"
# }]
{
"key": "A String", # [Output Only] A key that provides more detail on the warning being
# returned. For example, for warnings where there are no results in a list
# request for a particular zone, this key might be scope and
# the key value might be the zone name. Other examples might be a key
# indicating a deprecated resource and a suggested replacement, or a
# warning about invalid network settings (for example, if an instance
# attempts to perform IP forwarding but is not enabled for IP forwarding).
"value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
# applicable when performing per-zone operations.
}
get(project, region, sslPolicy, x__xgafv=None)
Lists all of the ordered rules present in a single specified policy.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region scoping this request. (required)
sslPolicy: string, Name of the SSL policy to update. The name must be 1-63 characters long,
and comply with RFC1035. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an SSL Policy resource.
#
# Use SSL policies to control SSL features, such as versions and cipher
# suites, that are offered by Application Load Balancers and proxy Network Load
# Balancers. For more information, read
# SSL policies overview.
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
# text format.
"customFeatures": [ # A list of features enabled when the selected profile is CUSTOM. The
# method returns the set of features that can be
# specified in this list. This field must be empty if the profile is notCUSTOM.
"A String",
],
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
"enabledFeatures": [ # Output only. [Output Only] The list of features enabled in the SSL policy.
"A String",
],
"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object.
# This field is used in optimistic locking. This field will be ignored when
# inserting a SslPolicy. An up-to-date fingerprint must be
# provided in order to update the SslPolicy, otherwise the
# request will fail with error 412 conditionNotMet.
#
# To see the latest fingerprint, make a get() request to
# retrieve an SslPolicy.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
"kind": "compute#sslPolicy", # Output only. [Output only] Type of the resource. Alwayscompute#sslPolicyfor SSL policies.
"minTlsVersion": "A String", # The minimum version of SSL protocol that can be used by the clients to
# establish a connection with the load balancer. This can be one ofTLS_1_0, TLS_1_1, TLS_1_2,TLS_1_3. When set to TLS_1_3, the profile field
# must be set to RESTRICTED.
"name": "A String", # Name of the resource. The name must be 1-63 characters long, and comply
# with RFC1035. Specifically, the name must be 1-63 characters
# long and match the regular expression
# `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
# must be a lowercase letter, and all following characters must be a dash,
# lowercase letter, or digit, except the last character, which cannot be a
# dash.
"postQuantumKeyExchange": "A String", # One of DEFAULT, ENABLED, orDEFERRED. Controls whether the load balancer negotiates
# X25519MLKEM768 key exchange when clients advertise support for it. When set
# to DEFAULT, or if no SSL Policy is attached to the target
# proxy, the load balancer disallows X25519MLKEM768 key exchange before
# October 2026, and allows it afterward. When set to ENABLED,
# the load balancer allows X25519MLKEM768 key exchange. When set toDEFERRED, the load balancer disallows X25519MLKEM768 key
# exchange until October 2027, and allows it afterward.
"profile": "A String", # Profile specifies the set of SSL features that can be used by the load
# balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in
# the customFeatures field. If using FIPS_202205,
# the min_tls_version field must be set to TLS_1_2.
"region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy
# resides. This field is not applicable to global SSL policies.
"selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
"selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
"tlsSettings": { # The TLS settings for the server. # Security settings for the proxy. This field is only applicable to a
# global backend service with the loadBalancingScheme set toINTERNAL_SELF_MANAGED.
"proxyTlsContext": { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain security certificates and identity
# information.
# The TLS settings for the client or server.
"certificateContext": { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
# certificate.
# Defines the mechanism to obtain the client or server certificate.
"certificatePaths": { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
# applicable only if tlsCertificateSource is set to USE_PATH.
# The paths to the mounted TLS Certificates and private key.
"certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use.
"privateKeyPath": "A String", # The path to the file holding the client or server private key.
},
"certificateSource": "A String", # Defines how TLS certificates are obtained.
"sdsConfig": { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
# is applicable only if tlsCertificateSource is set to USE_SDS.
# The configuration to access the SDS server.
"grpcServiceConfig": { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
# gRPC config to access the SDS server.
"callCredentials": { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
# gRPC call credentials to access the SDS server.
"callCredentialType": "A String", # The type of call credentials to use for GRPC requests to the SDS server.
# This field can be set to one of the following:
#
# - GCE_VM: The local GCE VM service account credentials are used to access
# the SDS server.
# - FROM_PLUGIN: Custom authenticator credentials are used to access the
# SDS server.
"fromPlugin": { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
# FROM_PLUGIN.
# Custom authenticator credentials.
"name": "A String", # Plugin name.
"structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the
# plugin.
},
},
"channelCredentials": { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
# gRPC channel credentials to access the SDS server.
"certificates": { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
# The paths to the mounted TLS Certificates and private key.
"certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use.
"privateKeyPath": "A String", # The path to the file holding the client or server private key.
},
"channelCredentialType": "A String", # The channel credentials to access the SDS server. This field can be set
# to one of the following:
# CERTIFICATES: Use TLS certificates to access the SDS server.
# GCE_VM: Use local GCE VM credentials to access the SDS server.
},
"targetUri": "A String", # The target URI of the SDS server.
},
},
},
"validationContext": { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
# validate the client/server certificate. If omitted, the proxy will not
# validate the server or client certificate.
# certificate to validate the client/server certificate.
# validate the client/server certificate.
"certificatePath": "A String", # The path to the file holding the CA certificate to validate the
# client or server certificate.
"sdsConfig": { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
# is applicable only if tlsCertificateSource is set to USE_SDS.
# The configuration to access the SDS server.
"grpcServiceConfig": { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
# gRPC config to access the SDS server.
"callCredentials": { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
# gRPC call credentials to access the SDS server.
"callCredentialType": "A String", # The type of call credentials to use for GRPC requests to the SDS server.
# This field can be set to one of the following:
#
# - GCE_VM: The local GCE VM service account credentials are used to access
# the SDS server.
# - FROM_PLUGIN: Custom authenticator credentials are used to access the
# SDS server.
"fromPlugin": { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
# FROM_PLUGIN.
# Custom authenticator credentials.
"name": "A String", # Plugin name.
"structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the
# plugin.
},
},
"channelCredentials": { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
# gRPC channel credentials to access the SDS server.
"certificates": { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
# The paths to the mounted TLS Certificates and private key.
"certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use.
"privateKeyPath": "A String", # The path to the file holding the client or server private key.
},
"channelCredentialType": "A String", # The channel credentials to access the SDS server. This field can be set
# to one of the following:
# CERTIFICATES: Use TLS certificates to access the SDS server.
# GCE_VM: Use local GCE VM credentials to access the SDS server.
},
"targetUri": "A String", # The target URI of the SDS server.
},
},
"validationSource": "A String", # Defines how TLS certificates are obtained.
},
},
"subjectAltNames": [ # A list of alternate names to verify the subject identity in the certificate
# presented by the client.
"A String",
],
"tlsMode": "A String", # Indicates whether connections should be secured using TLS. The value of
# this field determines how TLS is enforced. This field can be set to one
# of the following:
#
# - SIMPLE Secure connections with standard TLS semantics.
# - MUTUAL Secure connections to the backends using mutual
# TLS by presenting client certificates for authentication.
},
"warnings": [ # Output only. [Output Only] If potential misconfigurations are detected for this
# SSL policy, this field will be populated with warning messages.
{
"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.
},
],
}
getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. May be empty if no such
policy or resource exists.
Args:
project: string, Project ID for this request. (required)
region: string, The name of the region for this request. (required)
resource: string, Name or id of the resource for this request. (required)
optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access
# controls for Google Cloud resources.
#
#
# A `Policy` is a collection of `bindings`. A `binding` binds one or more
# `members`, or principals, to a single `role`. Principals can be user
# accounts, service accounts, Google groups, and domains (such as G Suite). A
# `role` is a named list of permissions; each `role` can be an IAM predefined
# role or a user-created custom role.
#
# For some types of Google Cloud resources, a `binding` can also specify a
# `condition`, which is a logical expression that allows access to a resource
# only if the expression evaluates to `true`. A condition can add constraints
# based on attributes of the request, the resource, or both. To learn which
# resources support conditions in their IAM policies, see the
# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# ```
# {
# "bindings": [
# {
# "role": "roles/resourcemanager.organizationAdmin",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
# "role": "roles/resourcemanager.organizationViewer",
# "members": [
# "user:eve@example.com"
# ],
# "condition": {
# "title": "expirable access",
# "description": "Does not grant access after Sep 2020",
# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
# "etag": "BwWWja0YfJA=",
# "version": 3
# }
# ```
#
# **YAML example:**
#
# ```
# bindings:
# - members:
# - user:mike@example.com
# - group:admins@example.com
# - domain:google.com
# - serviceAccount:my-project-id@appspot.gserviceaccount.com
# role: roles/resourcemanager.organizationAdmin
# - members:
# - user:eve@example.com
# role: roles/resourcemanager.organizationViewer
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# etag: BwWWja0YfJA=
# version: 3
# ```
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
# identities, if any, are exempted from logging.
# An AuditConfig must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
# the union of the two AuditConfigs is used for that service: the log_types
# specified in each AuditConfig are enabled, and the exempted_members in each
# AuditLogConfig are exempted.
#
# Example Policy with multiple AuditConfigs:
#
# {
# "audit_configs": [
# {
# "service": "allServices",
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# },
# {
# "log_type": "DATA_WRITE"
# },
# {
# "log_type": "ADMIN_READ"
# }
# ]
# },
# {
# "service": "sampleservice.googleapis.com",
# "audit_log_configs": [
# {
# "log_type": "DATA_READ"
# },
# {
# "log_type": "DATA_WRITE",
# "exempted_members": [
# "user:aliya@example.com"
# ]
# }
# ]
# }
# ]
# }
#
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts `jose@example.com` from DATA_READ logging, and
# `aliya@example.com` from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
#
# {
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# },
# {
# "log_type": "DATA_WRITE"
# }
# ]
# }
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
# may specify a `condition` that determines how and when the `bindings` are
# applied. Each of the `bindings` must contain at least one principal.
#
# The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
# of these principals can be Google groups. Each occurrence of a principal
# counts towards these limits. For example, if the `bindings` grant 50
# different roles to `user:alice@example.com`, and not to any other
# principal, then you can add another 1,450 principals to the `bindings` in
# the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
#
# If the condition evaluates to `true`, then this binding applies to the
# current request.
#
# If the condition evaluates to `false`, then this binding does not apply to
# the current request. However, a different role binding might grant the same
# role to one or more of the principals in this binding.
#
# To learn which resources support conditions in their IAM policies, see the
# [IAM
# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
#
# Example (Comparison):
#
# title: "Summary size limit"
# description: "Determines if a summary is less than 100 chars"
# expression: "document.summary.size() < 100"
#
# Example (Equality):
#
# title: "Requestor is owner"
# description: "Determines if requestor is the document owner"
# expression: "document.owner == request.auth.claims.email"
#
# Example (Logic):
#
# title: "Public documents"
# description: "Determine whether the document should be publicly visible"
# expression: "document.type != 'private' && document.type != 'internal'"
#
# Example (Data Manipulation):
#
# title: "Notification string"
# description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)"
#
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
"description": "A String", # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
"location": "A String", # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
# on the internet; with or without a Google account.
#
# * `allAuthenticatedUsers`: A special identifier that represents anyone
# who is authenticated with a Google account or a service account.
# Does not include identities that come from external identity providers
# (IdPs) through identity federation.
#
# * `user:{emailid}`: An email address that represents a specific Google
# account. For example, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a Google
# service account. For example,
# `my-other-app@appspot.gserviceaccount.com`.
#
# * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
# identifier for a
# [Kubernetes service
# account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
# For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
#
#
#
# * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
# A single identity in a workforce identity pool.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
# All workforce identities in a group.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
# All workforce identities with a specific attribute value.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
# All identities in a workforce identity pool.
#
# * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
# A single identity in a workload identity pool.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
# A workload identity pool group.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
# All identities in a workload identity pool with a certain attribute.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
# All identities in a workload identity pool.
#
# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a user that has been recently deleted. For
# example, `alice@example.com?uid=123456789012345678901`. If the user is
# recovered, this value reverts to `user:{emailid}` and the recovered user
# retains the role in the binding.
#
# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
# unique identifier) representing a service account that has been recently
# deleted. For example,
# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
# If the service account is undeleted, this value reverts to
# `serviceAccount:{emailid}` and the undeleted service account retains the
# role in the binding.
#
# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a Google group that has been recently
# deleted. For example, `admins@example.com?uid=123456789012345678901`. If
# the group is recovered, this value reverts to `group:{emailid}` and the
# recovered group retains the role in the binding.
#
# * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
# Deleted single identity in a workforce identity pool. For example,
# `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
#
# For an overview of the IAM roles and permissions, see the
# [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
# a list of the available pre-defined roles, see
# [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# read-modify-write cycle to perform policy updates in order to avoid race
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
#
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy.
#
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
# are rejected.
#
# Any operation that affects conditional role bindings must specify version
# `3`. This requirement applies to the following operations:
#
# * Getting a policy that includes a conditional role binding
# * Adding a conditional role binding to a policy
# * Changing a conditional role binding in a policy
# * Removing any role binding, with or without a condition, from a policy
# that includes conditions
#
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
#
# If a policy does not include any conditions, operations on that policy may
# specify any valid version or leave the field unset.
#
# To learn which resources support conditions in their IAM policies, see the
# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}
insert(project, region, body=None, requestId=None, x__xgafv=None)
Creates a new policy in the specified project and region using the data
included in the request.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region scoping this request. (required)
body: object, The request body.
The object takes the form of:
{ # Represents an SSL Policy resource.
#
# Use SSL policies to control SSL features, such as versions and cipher
# suites, that are offered by Application Load Balancers and proxy Network Load
# Balancers. For more information, read
# SSL policies overview.
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
# text format.
"customFeatures": [ # A list of features enabled when the selected profile is CUSTOM. The
# method returns the set of features that can be
# specified in this list. This field must be empty if the profile is notCUSTOM.
"A String",
],
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
"enabledFeatures": [ # Output only. [Output Only] The list of features enabled in the SSL policy.
"A String",
],
"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object.
# This field is used in optimistic locking. This field will be ignored when
# inserting a SslPolicy. An up-to-date fingerprint must be
# provided in order to update the SslPolicy, otherwise the
# request will fail with error 412 conditionNotMet.
#
# To see the latest fingerprint, make a get() request to
# retrieve an SslPolicy.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
"kind": "compute#sslPolicy", # Output only. [Output only] Type of the resource. Alwayscompute#sslPolicyfor SSL policies.
"minTlsVersion": "A String", # The minimum version of SSL protocol that can be used by the clients to
# establish a connection with the load balancer. This can be one ofTLS_1_0, TLS_1_1, TLS_1_2,TLS_1_3. When set to TLS_1_3, the profile field
# must be set to RESTRICTED.
"name": "A String", # Name of the resource. The name must be 1-63 characters long, and comply
# with RFC1035. Specifically, the name must be 1-63 characters
# long and match the regular expression
# `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
# must be a lowercase letter, and all following characters must be a dash,
# lowercase letter, or digit, except the last character, which cannot be a
# dash.
"postQuantumKeyExchange": "A String", # One of DEFAULT, ENABLED, orDEFERRED. Controls whether the load balancer negotiates
# X25519MLKEM768 key exchange when clients advertise support for it. When set
# to DEFAULT, or if no SSL Policy is attached to the target
# proxy, the load balancer disallows X25519MLKEM768 key exchange before
# October 2026, and allows it afterward. When set to ENABLED,
# the load balancer allows X25519MLKEM768 key exchange. When set toDEFERRED, the load balancer disallows X25519MLKEM768 key
# exchange until October 2027, and allows it afterward.
"profile": "A String", # Profile specifies the set of SSL features that can be used by the load
# balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in
# the customFeatures field. If using FIPS_202205,
# the min_tls_version field must be set to TLS_1_2.
"region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy
# resides. This field is not applicable to global SSL policies.
"selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
"selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
"tlsSettings": { # The TLS settings for the server. # Security settings for the proxy. This field is only applicable to a
# global backend service with the loadBalancingScheme set toINTERNAL_SELF_MANAGED.
"proxyTlsContext": { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain security certificates and identity
# information.
# The TLS settings for the client or server.
"certificateContext": { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
# certificate.
# Defines the mechanism to obtain the client or server certificate.
"certificatePaths": { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
# applicable only if tlsCertificateSource is set to USE_PATH.
# The paths to the mounted TLS Certificates and private key.
"certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use.
"privateKeyPath": "A String", # The path to the file holding the client or server private key.
},
"certificateSource": "A String", # Defines how TLS certificates are obtained.
"sdsConfig": { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
# is applicable only if tlsCertificateSource is set to USE_SDS.
# The configuration to access the SDS server.
"grpcServiceConfig": { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
# gRPC config to access the SDS server.
"callCredentials": { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
# gRPC call credentials to access the SDS server.
"callCredentialType": "A String", # The type of call credentials to use for GRPC requests to the SDS server.
# This field can be set to one of the following:
#
# - GCE_VM: The local GCE VM service account credentials are used to access
# the SDS server.
# - FROM_PLUGIN: Custom authenticator credentials are used to access the
# SDS server.
"fromPlugin": { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
# FROM_PLUGIN.
# Custom authenticator credentials.
"name": "A String", # Plugin name.
"structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the
# plugin.
},
},
"channelCredentials": { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
# gRPC channel credentials to access the SDS server.
"certificates": { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
# The paths to the mounted TLS Certificates and private key.
"certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use.
"privateKeyPath": "A String", # The path to the file holding the client or server private key.
},
"channelCredentialType": "A String", # The channel credentials to access the SDS server. This field can be set
# to one of the following:
# CERTIFICATES: Use TLS certificates to access the SDS server.
# GCE_VM: Use local GCE VM credentials to access the SDS server.
},
"targetUri": "A String", # The target URI of the SDS server.
},
},
},
"validationContext": { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
# validate the client/server certificate. If omitted, the proxy will not
# validate the server or client certificate.
# certificate to validate the client/server certificate.
# validate the client/server certificate.
"certificatePath": "A String", # The path to the file holding the CA certificate to validate the
# client or server certificate.
"sdsConfig": { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
# is applicable only if tlsCertificateSource is set to USE_SDS.
# The configuration to access the SDS server.
"grpcServiceConfig": { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
# gRPC config to access the SDS server.
"callCredentials": { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
# gRPC call credentials to access the SDS server.
"callCredentialType": "A String", # The type of call credentials to use for GRPC requests to the SDS server.
# This field can be set to one of the following:
#
# - GCE_VM: The local GCE VM service account credentials are used to access
# the SDS server.
# - FROM_PLUGIN: Custom authenticator credentials are used to access the
# SDS server.
"fromPlugin": { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
# FROM_PLUGIN.
# Custom authenticator credentials.
"name": "A String", # Plugin name.
"structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the
# plugin.
},
},
"channelCredentials": { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
# gRPC channel credentials to access the SDS server.
"certificates": { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
# The paths to the mounted TLS Certificates and private key.
"certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use.
"privateKeyPath": "A String", # The path to the file holding the client or server private key.
},
"channelCredentialType": "A String", # The channel credentials to access the SDS server. This field can be set
# to one of the following:
# CERTIFICATES: Use TLS certificates to access the SDS server.
# GCE_VM: Use local GCE VM credentials to access the SDS server.
},
"targetUri": "A String", # The target URI of the SDS server.
},
},
"validationSource": "A String", # Defines how TLS certificates are obtained.
},
},
"subjectAltNames": [ # A list of alternate names to verify the subject identity in the certificate
# presented by the client.
"A String",
],
"tlsMode": "A String", # Indicates whether connections should be secured using TLS. The value of
# this field determines how TLS is enforced. This field can be set to one
# of the following:
#
# - SIMPLE Secure connections with standard TLS semantics.
# - MUTUAL Secure connections to the backends using mutual
# TLS by presenting client certificates for authentication.
},
"warnings": [ # Output only. [Output Only] If potential misconfigurations are detected for this
# SSL policy, this field will be populated with warning messages.
{
"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.
},
],
}
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/alpha/globalOperations)
# * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
# * [Zonal](/compute/docs/reference/rest/alpha/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.
{ # Represents a single error encountered during the processing of an
# 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.
{ # Container for structured error details providing additional context
# specific to the encountered error code.
"errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata.
#
# 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. # Links and information to help the user resolve the error.
#
# 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 # A localized human-readable error message intended for end users.
# 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. # Details about quota limits and metrics when a quota is exceeded.
"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.
},
],
},
"firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the
# networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule
# methods if not explicitly provided by the user.
"allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query
# parameters specified minPriority/maxPriority.
},
"getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. [Output Only] Metadata for GetHealth operations.
"healthInfo": { # Health information. # Output only. The health information.
"availabilitySloStatus": "A String", # Output only. The availability SLO status.
"healthStatus": "A String", # Output only. The health status.
"repairCategory": "A String", # Output only. The repair category.
"unhealthyReason": "A String", # Output only. The reason for unhealthy status.
"updateTime": "A String", # Output only. The time when health info was updated.
},
},
"getVersionOperationMetadata": {
"inlineSbomInfo": {
"currentComponentVersions": { # A mapping of components to their currently-applied versions or other
# appropriate identifiers.
"a_key": "A String",
},
"targetComponentVersions": { # A mapping of components to their target versions or other appropriate
# identifiers.
"a_key": "A String",
},
},
},
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
# status code that was returned. For example, a `404` means the
# resource was not found.
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
# defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested.
# This value is inRFC3339
# text format.
"instancesBulkInsertOperationMetadata": {
"perLocationStatus": { # Status information per location (location name is key).
# Example key: zones/us-central1-a
"a_key": {
"createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
"deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
"failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
# error.
"status": "A String", # [Output Only] Creation status of BulkInsert operation - information
# if the flow is rolling forward or rolling back.
"targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
},
},
},
"kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
# Operation resources.
"name": "A String", # [Output Only] Name of the operation.
"operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
# group of operations results from a `bulkInsert` API request.
"operationType": "A String", # [Output Only] The type of operation, such as `insert`,
# `update`, or `delete`, and so on.
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
# There is no requirement that this be linear or support any granularity of
# operations. This should not be used to guess when the operation will be
# complete. This number should monotonically increase as the operation
# progresses.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only
# applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
"setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
# this field will contain information on all underlying zonal actions and
# their state.
"clientOperationId": "A String", # [Output Only] The client operation id.
"perLocationOperations": { # [Output Only] Status information per location (location name is key).
# Example key: zones/us-central1-a
"a_key": {
"error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
# populated.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
},
"state": "A String", # [Output Only] Status of the action, which can be one of the following:
# `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
},
},
},
"startTime": "A String", # [Output Only] The time that this operation was started by the server.
# This value is inRFC3339
# text format.
"status": "A String", # [Output Only] The status of the operation, which can be one of the
# following:
# `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
# operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
# of the target resource.
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
# operations related to creating a snapshot, this points to the disk
# that the snapshot was created from.
"user": "A String", # [Output Only] User who requested the operation, for example:
# `user@example.com` or
# `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the
# operation, this field will be populated.
{
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
# Engine returns NO_RESULTS_ON_PAGE if there
# are no results in the response.
"data": [ # [Output Only] Metadata about this warning in key:
# value format. For example:
#
# "data": [
# {
# "key": "scope",
# "value": "zones/us-east1-d"
# }]
{
"key": "A String", # [Output Only] A key that provides more detail on the warning being
# returned. For example, for warnings where there are no results in a list
# request for a particular zone, this key might be scope and
# the key value might be the zone name. Other examples might be a key
# indicating a deprecated resource and a suggested replacement, or a
# warning about invalid network settings (for example, if an instance
# attempts to perform IP forwarding but is not enabled for IP forwarding).
"value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
# applicable when performing per-zone operations.
}
list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists all the SSL policies that have been configured for the specified
project and region.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region scoping 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. [Output Only] Unique identifier for the resource; defined by the server.
"items": [ # Output only. A list of SslPolicy resources.
{ # Represents an SSL Policy resource.
#
# Use SSL policies to control SSL features, such as versions and cipher
# suites, that are offered by Application Load Balancers and proxy Network Load
# Balancers. For more information, read
# SSL policies overview.
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
# text format.
"customFeatures": [ # A list of features enabled when the selected profile is CUSTOM. The
# method returns the set of features that can be
# specified in this list. This field must be empty if the profile is notCUSTOM.
"A String",
],
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
"enabledFeatures": [ # Output only. [Output Only] The list of features enabled in the SSL policy.
"A String",
],
"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object.
# This field is used in optimistic locking. This field will be ignored when
# inserting a SslPolicy. An up-to-date fingerprint must be
# provided in order to update the SslPolicy, otherwise the
# request will fail with error 412 conditionNotMet.
#
# To see the latest fingerprint, make a get() request to
# retrieve an SslPolicy.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
"kind": "compute#sslPolicy", # Output only. [Output only] Type of the resource. Alwayscompute#sslPolicyfor SSL policies.
"minTlsVersion": "A String", # The minimum version of SSL protocol that can be used by the clients to
# establish a connection with the load balancer. This can be one ofTLS_1_0, TLS_1_1, TLS_1_2,TLS_1_3. When set to TLS_1_3, the profile field
# must be set to RESTRICTED.
"name": "A String", # Name of the resource. The name must be 1-63 characters long, and comply
# with RFC1035. Specifically, the name must be 1-63 characters
# long and match the regular expression
# `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
# must be a lowercase letter, and all following characters must be a dash,
# lowercase letter, or digit, except the last character, which cannot be a
# dash.
"postQuantumKeyExchange": "A String", # One of DEFAULT, ENABLED, orDEFERRED. Controls whether the load balancer negotiates
# X25519MLKEM768 key exchange when clients advertise support for it. When set
# to DEFAULT, or if no SSL Policy is attached to the target
# proxy, the load balancer disallows X25519MLKEM768 key exchange before
# October 2026, and allows it afterward. When set to ENABLED,
# the load balancer allows X25519MLKEM768 key exchange. When set toDEFERRED, the load balancer disallows X25519MLKEM768 key
# exchange until October 2027, and allows it afterward.
"profile": "A String", # Profile specifies the set of SSL features that can be used by the load
# balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in
# the customFeatures field. If using FIPS_202205,
# the min_tls_version field must be set to TLS_1_2.
"region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy
# resides. This field is not applicable to global SSL policies.
"selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
"selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
"tlsSettings": { # The TLS settings for the server. # Security settings for the proxy. This field is only applicable to a
# global backend service with the loadBalancingScheme set toINTERNAL_SELF_MANAGED.
"proxyTlsContext": { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain security certificates and identity
# information.
# The TLS settings for the client or server.
"certificateContext": { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
# certificate.
# Defines the mechanism to obtain the client or server certificate.
"certificatePaths": { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
# applicable only if tlsCertificateSource is set to USE_PATH.
# The paths to the mounted TLS Certificates and private key.
"certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use.
"privateKeyPath": "A String", # The path to the file holding the client or server private key.
},
"certificateSource": "A String", # Defines how TLS certificates are obtained.
"sdsConfig": { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
# is applicable only if tlsCertificateSource is set to USE_SDS.
# The configuration to access the SDS server.
"grpcServiceConfig": { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
# gRPC config to access the SDS server.
"callCredentials": { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
# gRPC call credentials to access the SDS server.
"callCredentialType": "A String", # The type of call credentials to use for GRPC requests to the SDS server.
# This field can be set to one of the following:
#
# - GCE_VM: The local GCE VM service account credentials are used to access
# the SDS server.
# - FROM_PLUGIN: Custom authenticator credentials are used to access the
# SDS server.
"fromPlugin": { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
# FROM_PLUGIN.
# Custom authenticator credentials.
"name": "A String", # Plugin name.
"structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the
# plugin.
},
},
"channelCredentials": { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
# gRPC channel credentials to access the SDS server.
"certificates": { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
# The paths to the mounted TLS Certificates and private key.
"certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use.
"privateKeyPath": "A String", # The path to the file holding the client or server private key.
},
"channelCredentialType": "A String", # The channel credentials to access the SDS server. This field can be set
# to one of the following:
# CERTIFICATES: Use TLS certificates to access the SDS server.
# GCE_VM: Use local GCE VM credentials to access the SDS server.
},
"targetUri": "A String", # The target URI of the SDS server.
},
},
},
"validationContext": { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
# validate the client/server certificate. If omitted, the proxy will not
# validate the server or client certificate.
# certificate to validate the client/server certificate.
# validate the client/server certificate.
"certificatePath": "A String", # The path to the file holding the CA certificate to validate the
# client or server certificate.
"sdsConfig": { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
# is applicable only if tlsCertificateSource is set to USE_SDS.
# The configuration to access the SDS server.
"grpcServiceConfig": { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
# gRPC config to access the SDS server.
"callCredentials": { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
# gRPC call credentials to access the SDS server.
"callCredentialType": "A String", # The type of call credentials to use for GRPC requests to the SDS server.
# This field can be set to one of the following:
#
# - GCE_VM: The local GCE VM service account credentials are used to access
# the SDS server.
# - FROM_PLUGIN: Custom authenticator credentials are used to access the
# SDS server.
"fromPlugin": { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
# FROM_PLUGIN.
# Custom authenticator credentials.
"name": "A String", # Plugin name.
"structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the
# plugin.
},
},
"channelCredentials": { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
# gRPC channel credentials to access the SDS server.
"certificates": { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
# The paths to the mounted TLS Certificates and private key.
"certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use.
"privateKeyPath": "A String", # The path to the file holding the client or server private key.
},
"channelCredentialType": "A String", # The channel credentials to access the SDS server. This field can be set
# to one of the following:
# CERTIFICATES: Use TLS certificates to access the SDS server.
# GCE_VM: Use local GCE VM credentials to access the SDS server.
},
"targetUri": "A String", # The target URI of the SDS server.
},
},
"validationSource": "A String", # Defines how TLS certificates are obtained.
},
},
"subjectAltNames": [ # A list of alternate names to verify the subject identity in the certificate
# presented by the client.
"A String",
],
"tlsMode": "A String", # Indicates whether connections should be secured using TLS. The value of
# this field determines how TLS is enforced. This field can be set to one
# of the following:
#
# - SIMPLE Secure connections with standard TLS semantics.
# - MUTUAL Secure connections to the backends using mutual
# TLS by presenting client certificates for authentication.
},
"warnings": [ # Output only. [Output Only] If potential misconfigurations are detected for this
# SSL policy, this field will be populated with warning messages.
{
"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#sslPoliciesList", # Output only. [Output Only] Type of the resource. Alwayscompute#sslPoliciesList for lists of sslPolicies.
"nextPageToken": "A String", # Output only. [Output Only] This token allows you to get the next page of results for
# list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
# the query parameter pageToken in the next list request.
# Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
"selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
"warning": { # [Output Only] Informational warning message.
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
# Engine returns NO_RESULTS_ON_PAGE if there
# are no results in the response.
"data": [ # [Output Only] Metadata about this warning in key:
# value format. For example:
#
# "data": [
# {
# "key": "scope",
# "value": "zones/us-east1-d"
# }]
{
"key": "A String", # [Output Only] A key that provides more detail on the warning being
# returned. For example, for warnings where there are no results in a list
# request for a particular zone, this key might be scope and
# the key value might be the zone name. Other examples might be a key
# indicating a deprecated resource and a suggested replacement, or a
# warning about invalid network settings (for example, if an instance
# attempts to perform IP forwarding but is not enabled for IP forwarding).
"value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
}
listAvailableFeatures(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists all features that can be specified in the SSL policy when using
custom profile.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region scoping 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:
{
"features": [
"A String",
],
}
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, sslPolicy, body=None, requestId=None, x__xgafv=None)
Patches the specified SSL policy with the data included in the request.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region scoping this request. (required)
sslPolicy: string, Name of the SSL policy to update. The name must be 1-63 characters long,
and comply with RFC1035. (required)
body: object, The request body.
The object takes the form of:
{ # Represents an SSL Policy resource.
#
# Use SSL policies to control SSL features, such as versions and cipher
# suites, that are offered by Application Load Balancers and proxy Network Load
# Balancers. For more information, read
# SSL policies overview.
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
# text format.
"customFeatures": [ # A list of features enabled when the selected profile is CUSTOM. The
# method returns the set of features that can be
# specified in this list. This field must be empty if the profile is notCUSTOM.
"A String",
],
"description": "A String", # An optional description of this resource. Provide this property when you
# create the resource.
"enabledFeatures": [ # Output only. [Output Only] The list of features enabled in the SSL policy.
"A String",
],
"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object.
# This field is used in optimistic locking. This field will be ignored when
# inserting a SslPolicy. An up-to-date fingerprint must be
# provided in order to update the SslPolicy, otherwise the
# request will fail with error 412 conditionNotMet.
#
# To see the latest fingerprint, make a get() request to
# retrieve an SslPolicy.
"id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
"kind": "compute#sslPolicy", # Output only. [Output only] Type of the resource. Alwayscompute#sslPolicyfor SSL policies.
"minTlsVersion": "A String", # The minimum version of SSL protocol that can be used by the clients to
# establish a connection with the load balancer. This can be one ofTLS_1_0, TLS_1_1, TLS_1_2,TLS_1_3. When set to TLS_1_3, the profile field
# must be set to RESTRICTED.
"name": "A String", # Name of the resource. The name must be 1-63 characters long, and comply
# with RFC1035. Specifically, the name must be 1-63 characters
# long and match the regular expression
# `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
# must be a lowercase letter, and all following characters must be a dash,
# lowercase letter, or digit, except the last character, which cannot be a
# dash.
"postQuantumKeyExchange": "A String", # One of DEFAULT, ENABLED, orDEFERRED. Controls whether the load balancer negotiates
# X25519MLKEM768 key exchange when clients advertise support for it. When set
# to DEFAULT, or if no SSL Policy is attached to the target
# proxy, the load balancer disallows X25519MLKEM768 key exchange before
# October 2026, and allows it afterward. When set to ENABLED,
# the load balancer allows X25519MLKEM768 key exchange. When set toDEFERRED, the load balancer disallows X25519MLKEM768 key
# exchange until October 2027, and allows it afterward.
"profile": "A String", # Profile specifies the set of SSL features that can be used by the load
# balancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in
# the customFeatures field. If using FIPS_202205,
# the min_tls_version field must be set to TLS_1_2.
"region": "A String", # Output only. [Output Only] URL of the region where the regional SSL policy
# resides. This field is not applicable to global SSL policies.
"selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
"selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
"tlsSettings": { # The TLS settings for the server. # Security settings for the proxy. This field is only applicable to a
# global backend service with the loadBalancingScheme set toINTERNAL_SELF_MANAGED.
"proxyTlsContext": { # [Deprecated] The TLS settings for the client or server. # Configures the mechanism to obtain security certificates and identity
# information.
# The TLS settings for the client or server.
"certificateContext": { # [Deprecated] Defines the mechanism to obtain the client or server # Defines the mechanism to obtain the client or server certificate.
# certificate.
# Defines the mechanism to obtain the client or server certificate.
"certificatePaths": { # [Deprecated] The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is
# applicable only if tlsCertificateSource is set to USE_PATH.
# The paths to the mounted TLS Certificates and private key.
"certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use.
"privateKeyPath": "A String", # The path to the file holding the client or server private key.
},
"certificateSource": "A String", # Defines how TLS certificates are obtained.
"sdsConfig": { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
# is applicable only if tlsCertificateSource is set to USE_SDS.
# The configuration to access the SDS server.
"grpcServiceConfig": { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
# gRPC config to access the SDS server.
"callCredentials": { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
# gRPC call credentials to access the SDS server.
"callCredentialType": "A String", # The type of call credentials to use for GRPC requests to the SDS server.
# This field can be set to one of the following:
#
# - GCE_VM: The local GCE VM service account credentials are used to access
# the SDS server.
# - FROM_PLUGIN: Custom authenticator credentials are used to access the
# SDS server.
"fromPlugin": { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
# FROM_PLUGIN.
# Custom authenticator credentials.
"name": "A String", # Plugin name.
"structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the
# plugin.
},
},
"channelCredentials": { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
# gRPC channel credentials to access the SDS server.
"certificates": { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
# The paths to the mounted TLS Certificates and private key.
"certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use.
"privateKeyPath": "A String", # The path to the file holding the client or server private key.
},
"channelCredentialType": "A String", # The channel credentials to access the SDS server. This field can be set
# to one of the following:
# CERTIFICATES: Use TLS certificates to access the SDS server.
# GCE_VM: Use local GCE VM credentials to access the SDS server.
},
"targetUri": "A String", # The target URI of the SDS server.
},
},
},
"validationContext": { # [Deprecated] Defines the mechanism to obtain the Certificate Authority # Defines the mechanism to obtain the Certificate Authority certificate to
# validate the client/server certificate. If omitted, the proxy will not
# validate the server or client certificate.
# certificate to validate the client/server certificate.
# validate the client/server certificate.
"certificatePath": "A String", # The path to the file holding the CA certificate to validate the
# client or server certificate.
"sdsConfig": { # [Deprecated] The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field
# is applicable only if tlsCertificateSource is set to USE_SDS.
# The configuration to access the SDS server.
"grpcServiceConfig": { # [Deprecated] gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC.
# gRPC config to access the SDS server.
"callCredentials": { # [Deprecated] gRPC call credentials to access the SDS server. # The call credentials to access the SDS server.
# gRPC call credentials to access the SDS server.
"callCredentialType": "A String", # The type of call credentials to use for GRPC requests to the SDS server.
# This field can be set to one of the following:
#
# - GCE_VM: The local GCE VM service account credentials are used to access
# the SDS server.
# - FROM_PLUGIN: Custom authenticator credentials are used to access the
# SDS server.
"fromPlugin": { # [Deprecated] Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is
# FROM_PLUGIN.
# Custom authenticator credentials.
"name": "A String", # Plugin name.
"structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the
# plugin.
},
},
"channelCredentials": { # [Deprecated] gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server.
# gRPC channel credentials to access the SDS server.
"certificates": { # [Deprecated] The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server.
# The paths to the mounted TLS Certificates and private key.
"certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use.
"privateKeyPath": "A String", # The path to the file holding the client or server private key.
},
"channelCredentialType": "A String", # The channel credentials to access the SDS server. This field can be set
# to one of the following:
# CERTIFICATES: Use TLS certificates to access the SDS server.
# GCE_VM: Use local GCE VM credentials to access the SDS server.
},
"targetUri": "A String", # The target URI of the SDS server.
},
},
"validationSource": "A String", # Defines how TLS certificates are obtained.
},
},
"subjectAltNames": [ # A list of alternate names to verify the subject identity in the certificate
# presented by the client.
"A String",
],
"tlsMode": "A String", # Indicates whether connections should be secured using TLS. The value of
# this field determines how TLS is enforced. This field can be set to one
# of the following:
#
# - SIMPLE Secure connections with standard TLS semantics.
# - MUTUAL Secure connections to the backends using mutual
# TLS by presenting client certificates for authentication.
},
"warnings": [ # Output only. [Output Only] If potential misconfigurations are detected for this
# SSL policy, this field will be populated with warning messages.
{
"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.
},
],
}
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/alpha/globalOperations)
# * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
# * [Zonal](/compute/docs/reference/rest/alpha/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.
{ # Represents a single error encountered during the processing of an
# 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.
{ # Container for structured error details providing additional context
# specific to the encountered error code.
"errorInfo": { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata.
#
# 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. # Links and information to help the user resolve the error.
#
# 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 # A localized human-readable error message intended for end users.
# 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. # Details about quota limits and metrics when a quota is exceeded.
"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.
},
],
},
"firewallPolicyRuleOperationMetadata": { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the
# networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule
# methods if not explicitly provided by the user.
"allocatedPriority": 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query
# parameters specified minPriority/maxPriority.
},
"getHealthOperationMetadata": { # Metadata for GetHealth operations. # Output only. [Output Only] Metadata for GetHealth operations.
"healthInfo": { # Health information. # Output only. The health information.
"availabilitySloStatus": "A String", # Output only. The availability SLO status.
"healthStatus": "A String", # Output only. The health status.
"repairCategory": "A String", # Output only. The repair category.
"unhealthyReason": "A String", # Output only. The reason for unhealthy status.
"updateTime": "A String", # Output only. The time when health info was updated.
},
},
"getVersionOperationMetadata": {
"inlineSbomInfo": {
"currentComponentVersions": { # A mapping of components to their currently-applied versions or other
# appropriate identifiers.
"a_key": "A String",
},
"targetComponentVersions": { # A mapping of components to their target versions or other appropriate
# identifiers.
"a_key": "A String",
},
},
},
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
# status code that was returned. For example, a `404` means the
# resource was not found.
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
# defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested.
# This value is inRFC3339
# text format.
"instancesBulkInsertOperationMetadata": {
"perLocationStatus": { # Status information per location (location name is key).
# Example key: zones/us-central1-a
"a_key": {
"createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
"deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
"failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
# error.
"status": "A String", # [Output Only] Creation status of BulkInsert operation - information
# if the flow is rolling forward or rolling back.
"targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
},
},
},
"kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
# Operation resources.
"name": "A String", # [Output Only] Name of the operation.
"operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
# group of operations results from a `bulkInsert` API request.
"operationType": "A String", # [Output Only] The type of operation, such as `insert`,
# `update`, or `delete`, and so on.
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
# There is no requirement that this be linear or support any granularity of
# operations. This should not be used to guess when the operation will be
# complete. This number should monotonically increase as the operation
# progresses.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only
# applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
"setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
# this field will contain information on all underlying zonal actions and
# their state.
"clientOperationId": "A String", # [Output Only] The client operation id.
"perLocationOperations": { # [Output Only] Status information per location (location name is key).
# Example key: zones/us-central1-a
"a_key": {
"error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
# populated.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
},
"state": "A String", # [Output Only] Status of the action, which can be one of the following:
# `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
},
},
},
"startTime": "A String", # [Output Only] The time that this operation was started by the server.
# This value is inRFC3339
# text format.
"status": "A String", # [Output Only] The status of the operation, which can be one of the
# following:
# `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
# operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
# of the target resource.
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
# operations related to creating a snapshot, this points to the disk
# that the snapshot was created from.
"user": "A String", # [Output Only] User who requested the operation, for example:
# `user@example.com` or
# `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the
# operation, this field will be populated.
{
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
# Engine returns NO_RESULTS_ON_PAGE if there
# are no results in the response.
"data": [ # [Output Only] Metadata about this warning in key:
# value format. For example:
#
# "data": [
# {
# "key": "scope",
# "value": "zones/us-east1-d"
# }]
{
"key": "A String", # [Output Only] A key that provides more detail on the warning being
# returned. For example, for warnings where there are no results in a list
# request for a particular zone, this key might be scope and
# the key value might be the zone name. Other examples might be a key
# indicating a deprecated resource and a suggested replacement, or a
# warning about invalid network settings (for example, if an instance
# attempts to perform IP forwarding but is not enabled for IP forwarding).
"value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
# applicable when performing per-zone operations.
}
setIamPolicy(project, region, resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource.
Replaces any existing policy.
Args:
project: string, Project ID for this request. (required)
region: string, The name of the region for this request. (required)
resource: string, Name or id of the resource for this request. (required)
body: object, The request body.
The object takes the form of:
{
"bindings": [ # Flatten Policy to create a backwacd compatible wire-format.
# Deprecated. Use 'policy' to specify bindings.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
#
# If the condition evaluates to `true`, then this binding applies to the
# current request.
#
# If the condition evaluates to `false`, then this binding does not apply to
# the current request. However, a different role binding might grant the same
# role to one or more of the principals in this binding.
#
# To learn which resources support conditions in their IAM policies, see the
# [IAM
# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
#
# Example (Comparison):
#
# title: "Summary size limit"
# description: "Determines if a summary is less than 100 chars"
# expression: "document.summary.size() < 100"
#
# Example (Equality):
#
# title: "Requestor is owner"
# description: "Determines if requestor is the document owner"
# expression: "document.owner == request.auth.claims.email"
#
# Example (Logic):
#
# title: "Public documents"
# description: "Determine whether the document should be publicly visible"
# expression: "document.type != 'private' && document.type != 'internal'"
#
# Example (Data Manipulation):
#
# title: "Notification string"
# description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)"
#
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
"description": "A String", # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
"location": "A String", # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
# on the internet; with or without a Google account.
#
# * `allAuthenticatedUsers`: A special identifier that represents anyone
# who is authenticated with a Google account or a service account.
# Does not include identities that come from external identity providers
# (IdPs) through identity federation.
#
# * `user:{emailid}`: An email address that represents a specific Google
# account. For example, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a Google
# service account. For example,
# `my-other-app@appspot.gserviceaccount.com`.
#
# * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
# identifier for a
# [Kubernetes service
# account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
# For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
#
#
#
# * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
# A single identity in a workforce identity pool.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
# All workforce identities in a group.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
# All workforce identities with a specific attribute value.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
# All identities in a workforce identity pool.
#
# * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
# A single identity in a workload identity pool.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
# A workload identity pool group.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
# All identities in a workload identity pool with a certain attribute.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
# All identities in a workload identity pool.
#
# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a user that has been recently deleted. For
# example, `alice@example.com?uid=123456789012345678901`. If the user is
# recovered, this value reverts to `user:{emailid}` and the recovered user
# retains the role in the binding.
#
# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
# unique identifier) representing a service account that has been recently
# deleted. For example,
# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
# If the service account is undeleted, this value reverts to
# `serviceAccount:{emailid}` and the undeleted service account retains the
# role in the binding.
#
# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a Google group that has been recently
# deleted. For example, `admins@example.com?uid=123456789012345678901`. If
# the group is recovered, this value reverts to `group:{emailid}` and the
# recovered group retains the role in the binding.
#
# * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
# Deleted single identity in a workforce identity pool. For example,
# `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
#
# For an overview of the IAM roles and permissions, see the
# [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
# a list of the available pre-defined roles, see
# [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # Flatten Policy to create a backward compatible wire-format.
# Deprecated. Use 'policy' to specify the etag.
"policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the 'resource'. The size of
# the policy is limited to a few 10s of KB. An empty policy is in general a
# valid policy but certain services (like Projects) might reject them.
# controls for Google Cloud resources.
#
#
# A `Policy` is a collection of `bindings`. A `binding` binds one or more
# `members`, or principals, to a single `role`. Principals can be user
# accounts, service accounts, Google groups, and domains (such as G Suite). A
# `role` is a named list of permissions; each `role` can be an IAM predefined
# role or a user-created custom role.
#
# For some types of Google Cloud resources, a `binding` can also specify a
# `condition`, which is a logical expression that allows access to a resource
# only if the expression evaluates to `true`. A condition can add constraints
# based on attributes of the request, the resource, or both. To learn which
# resources support conditions in their IAM policies, see the
# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# ```
# {
# "bindings": [
# {
# "role": "roles/resourcemanager.organizationAdmin",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
# "role": "roles/resourcemanager.organizationViewer",
# "members": [
# "user:eve@example.com"
# ],
# "condition": {
# "title": "expirable access",
# "description": "Does not grant access after Sep 2020",
# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
# "etag": "BwWWja0YfJA=",
# "version": 3
# }
# ```
#
# **YAML example:**
#
# ```
# bindings:
# - members:
# - user:mike@example.com
# - group:admins@example.com
# - domain:google.com
# - serviceAccount:my-project-id@appspot.gserviceaccount.com
# role: roles/resourcemanager.organizationAdmin
# - members:
# - user:eve@example.com
# role: roles/resourcemanager.organizationViewer
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# etag: BwWWja0YfJA=
# version: 3
# ```
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
# identities, if any, are exempted from logging.
# An AuditConfig must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
# the union of the two AuditConfigs is used for that service: the log_types
# specified in each AuditConfig are enabled, and the exempted_members in each
# AuditLogConfig are exempted.
#
# Example Policy with multiple AuditConfigs:
#
# {
# "audit_configs": [
# {
# "service": "allServices",
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# },
# {
# "log_type": "DATA_WRITE"
# },
# {
# "log_type": "ADMIN_READ"
# }
# ]
# },
# {
# "service": "sampleservice.googleapis.com",
# "audit_log_configs": [
# {
# "log_type": "DATA_READ"
# },
# {
# "log_type": "DATA_WRITE",
# "exempted_members": [
# "user:aliya@example.com"
# ]
# }
# ]
# }
# ]
# }
#
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts `jose@example.com` from DATA_READ logging, and
# `aliya@example.com` from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
#
# {
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# },
# {
# "log_type": "DATA_WRITE"
# }
# ]
# }
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
# may specify a `condition` that determines how and when the `bindings` are
# applied. Each of the `bindings` must contain at least one principal.
#
# The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
# of these principals can be Google groups. Each occurrence of a principal
# counts towards these limits. For example, if the `bindings` grant 50
# different roles to `user:alice@example.com`, and not to any other
# principal, then you can add another 1,450 principals to the `bindings` in
# the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
#
# If the condition evaluates to `true`, then this binding applies to the
# current request.
#
# If the condition evaluates to `false`, then this binding does not apply to
# the current request. However, a different role binding might grant the same
# role to one or more of the principals in this binding.
#
# To learn which resources support conditions in their IAM policies, see the
# [IAM
# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
#
# Example (Comparison):
#
# title: "Summary size limit"
# description: "Determines if a summary is less than 100 chars"
# expression: "document.summary.size() < 100"
#
# Example (Equality):
#
# title: "Requestor is owner"
# description: "Determines if requestor is the document owner"
# expression: "document.owner == request.auth.claims.email"
#
# Example (Logic):
#
# title: "Public documents"
# description: "Determine whether the document should be publicly visible"
# expression: "document.type != 'private' && document.type != 'internal'"
#
# Example (Data Manipulation):
#
# title: "Notification string"
# description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)"
#
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
"description": "A String", # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
"location": "A String", # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
# on the internet; with or without a Google account.
#
# * `allAuthenticatedUsers`: A special identifier that represents anyone
# who is authenticated with a Google account or a service account.
# Does not include identities that come from external identity providers
# (IdPs) through identity federation.
#
# * `user:{emailid}`: An email address that represents a specific Google
# account. For example, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a Google
# service account. For example,
# `my-other-app@appspot.gserviceaccount.com`.
#
# * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
# identifier for a
# [Kubernetes service
# account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
# For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
#
#
#
# * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
# A single identity in a workforce identity pool.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
# All workforce identities in a group.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
# All workforce identities with a specific attribute value.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
# All identities in a workforce identity pool.
#
# * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
# A single identity in a workload identity pool.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
# A workload identity pool group.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
# All identities in a workload identity pool with a certain attribute.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
# All identities in a workload identity pool.
#
# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a user that has been recently deleted. For
# example, `alice@example.com?uid=123456789012345678901`. If the user is
# recovered, this value reverts to `user:{emailid}` and the recovered user
# retains the role in the binding.
#
# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
# unique identifier) representing a service account that has been recently
# deleted. For example,
# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
# If the service account is undeleted, this value reverts to
# `serviceAccount:{emailid}` and the undeleted service account retains the
# role in the binding.
#
# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a Google group that has been recently
# deleted. For example, `admins@example.com?uid=123456789012345678901`. If
# the group is recovered, this value reverts to `group:{emailid}` and the
# recovered group retains the role in the binding.
#
# * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
# Deleted single identity in a workforce identity pool. For example,
# `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
#
# For an overview of the IAM roles and permissions, see the
# [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
# a list of the available pre-defined roles, see
# [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# read-modify-write cycle to perform policy updates in order to avoid race
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
#
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy.
#
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
# are rejected.
#
# Any operation that affects conditional role bindings must specify version
# `3`. This requirement applies to the following operations:
#
# * Getting a policy that includes a conditional role binding
# * Adding a conditional role binding to a policy
# * Changing a conditional role binding in a policy
# * Removing any role binding, with or without a condition, from a policy
# that includes conditions
#
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
#
# If a policy does not include any conditions, operations on that policy may
# specify any valid version or leave the field unset.
#
# To learn which resources support conditions in their IAM policies, see the
# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access
# controls for Google Cloud resources.
#
#
# A `Policy` is a collection of `bindings`. A `binding` binds one or more
# `members`, or principals, to a single `role`. Principals can be user
# accounts, service accounts, Google groups, and domains (such as G Suite). A
# `role` is a named list of permissions; each `role` can be an IAM predefined
# role or a user-created custom role.
#
# For some types of Google Cloud resources, a `binding` can also specify a
# `condition`, which is a logical expression that allows access to a resource
# only if the expression evaluates to `true`. A condition can add constraints
# based on attributes of the request, the resource, or both. To learn which
# resources support conditions in their IAM policies, see the
# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# ```
# {
# "bindings": [
# {
# "role": "roles/resourcemanager.organizationAdmin",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
# "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
# "role": "roles/resourcemanager.organizationViewer",
# "members": [
# "user:eve@example.com"
# ],
# "condition": {
# "title": "expirable access",
# "description": "Does not grant access after Sep 2020",
# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
# "etag": "BwWWja0YfJA=",
# "version": 3
# }
# ```
#
# **YAML example:**
#
# ```
# bindings:
# - members:
# - user:mike@example.com
# - group:admins@example.com
# - domain:google.com
# - serviceAccount:my-project-id@appspot.gserviceaccount.com
# role: roles/resourcemanager.organizationAdmin
# - members:
# - user:eve@example.com
# role: roles/resourcemanager.organizationViewer
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# etag: BwWWja0YfJA=
# version: 3
# ```
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
# identities, if any, are exempted from logging.
# An AuditConfig must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
# the union of the two AuditConfigs is used for that service: the log_types
# specified in each AuditConfig are enabled, and the exempted_members in each
# AuditLogConfig are exempted.
#
# Example Policy with multiple AuditConfigs:
#
# {
# "audit_configs": [
# {
# "service": "allServices",
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# },
# {
# "log_type": "DATA_WRITE"
# },
# {
# "log_type": "ADMIN_READ"
# }
# ]
# },
# {
# "service": "sampleservice.googleapis.com",
# "audit_log_configs": [
# {
# "log_type": "DATA_READ"
# },
# {
# "log_type": "DATA_WRITE",
# "exempted_members": [
# "user:aliya@example.com"
# ]
# }
# ]
# }
# ]
# }
#
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts `jose@example.com` from DATA_READ logging, and
# `aliya@example.com` from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
#
# {
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# },
# {
# "log_type": "DATA_WRITE"
# }
# ]
# }
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
"A String",
],
"logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
"bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
# may specify a `condition` that determines how and when the `bindings` are
# applied. Each of the `bindings` must contain at least one principal.
#
# The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
# of these principals can be Google groups. Each occurrence of a principal
# counts towards these limits. For example, if the `bindings` grant 50
# different roles to `user:alice@example.com`, and not to any other
# principal, then you can add another 1,450 principals to the `bindings` in
# the `Policy`.
{ # Associates `members`, or principals, with a `role`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
#
# If the condition evaluates to `true`, then this binding applies to the
# current request.
#
# If the condition evaluates to `false`, then this binding does not apply to
# the current request. However, a different role binding might grant the same
# role to one or more of the principals in this binding.
#
# To learn which resources support conditions in their IAM policies, see the
# [IAM
# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
#
# Example (Comparison):
#
# title: "Summary size limit"
# description: "Determines if a summary is less than 100 chars"
# expression: "document.summary.size() < 100"
#
# Example (Equality):
#
# title: "Requestor is owner"
# description: "Determines if requestor is the document owner"
# expression: "document.owner == request.auth.claims.email"
#
# Example (Logic):
#
# title: "Public documents"
# description: "Determine whether the document should be publicly visible"
# expression: "document.type != 'private' && document.type != 'internal'"
#
# Example (Data Manipulation):
#
# title: "Notification string"
# description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)"
#
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
"description": "A String", # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
"expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
"location": "A String", # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
},
"members": [ # Specifies the principals requesting access for a Google Cloud resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
# on the internet; with or without a Google account.
#
# * `allAuthenticatedUsers`: A special identifier that represents anyone
# who is authenticated with a Google account or a service account.
# Does not include identities that come from external identity providers
# (IdPs) through identity federation.
#
# * `user:{emailid}`: An email address that represents a specific Google
# account. For example, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a Google
# service account. For example,
# `my-other-app@appspot.gserviceaccount.com`.
#
# * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
# identifier for a
# [Kubernetes service
# account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
# For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
#
#
#
# * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
# A single identity in a workforce identity pool.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
# All workforce identities in a group.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
# All workforce identities with a specific attribute value.
#
# * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
# All identities in a workforce identity pool.
#
# * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
# A single identity in a workload identity pool.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
# A workload identity pool group.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
# All identities in a workload identity pool with a certain attribute.
#
# * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
# All identities in a workload identity pool.
#
# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a user that has been recently deleted. For
# example, `alice@example.com?uid=123456789012345678901`. If the user is
# recovered, this value reverts to `user:{emailid}` and the recovered user
# retains the role in the binding.
#
# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
# unique identifier) representing a service account that has been recently
# deleted. For example,
# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
# If the service account is undeleted, this value reverts to
# `serviceAccount:{emailid}` and the undeleted service account retains the
# role in the binding.
#
# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a Google group that has been recently
# deleted. For example, `admins@example.com?uid=123456789012345678901`. If
# the group is recovered, this value reverts to `group:{emailid}` and the
# recovered group retains the role in the binding.
#
# * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
# Deleted single identity in a workforce identity pool. For example,
# `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
"A String",
],
"role": "A String", # Role that is assigned to the list of `members`, or principals.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
#
# For an overview of the IAM roles and permissions, see the
# [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
# a list of the available pre-defined roles, see
# [here](https://cloud.google.com/iam/docs/understanding-roles).
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# read-modify-write cycle to perform policy updates in order to avoid race
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
#
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy.
#
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
# are rejected.
#
# Any operation that affects conditional role bindings must specify version
# `3`. This requirement applies to the following operations:
#
# * Getting a policy that includes a conditional role binding
# * Adding a conditional role binding to a policy
# * Changing a conditional role binding in a policy
# * Removing any role binding, with or without a condition, from a policy
# that includes conditions
#
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
#
# If a policy does not include any conditions, operations on that policy may
# specify any valid version or leave the field unset.
#
# To learn which resources support conditions in their IAM policies, see the
# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}
testIamPermissions(project, region, resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource.
Args:
project: string, Project ID for this request. (required)
region: string, The name of the region for this request. (required)
resource: string, Name or id of the resource for this request. (required)
body: object, The request body.
The object takes the form of:
{
"permissions": [ # The set of permissions to check for the 'resource'. Permissions with
# wildcards (such as '*' or 'storage.*') are not allowed.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
# allowed.
"A String",
],
}