docs: update generated docs (#981)
diff --git a/docs/dyn/cloudfunctions_v1.projects.locations.functions.html b/docs/dyn/cloudfunctions_v1.projects.locations.functions.html
index 2128649..44bf51c 100644
--- a/docs/dyn/cloudfunctions_v1.projects.locations.functions.html
+++ b/docs/dyn/cloudfunctions_v1.projects.locations.functions.html
@@ -96,7 +96,7 @@
<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the IAM access control policy for a function.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of functions that belong to the requested project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -137,10 +137,10 @@
{ # Response of `CallFunction` method.
"executionId": "A String", # Execution id of function invocation.
- "result": "A String", # Result populated for successful execution of synchronous function. Will
- # not be populated if function does not return a result through context.
"error": "A String", # Either system or user-function generated error. Set if execution
# was not successful.
+ "result": "A String", # Result populated for successful execution of synchronous function. Will
+ # not be populated if function does not return a result through context.
}</pre>
</div>
@@ -158,24 +158,25 @@
{ # Describes a Cloud Function that contains user computation executed in
# response to an event. It encapsulate function and triggers configurations.
- "httpsTrigger": { # Describes HttpsTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL.
- "url": "A String", # Output only. The deployed url for the function.
- },
- "vpcConnectorEgressSettings": "A String", # The egress settings for the connector, controlling what traffic is diverted
- # through it.
- "ingressSettings": "A String", # The ingress settings for the function, controlling what traffic can reach
- # it.
+ "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
+ "runtime": "A String", # The runtime in which to run the function. Required when deploying a new
+ # function, optional when updating an existing function. For a complete
+ # list of possible choices, see the
+ # [`gcloud` command
+ # reference](/sdk/gcloud/reference/functions/deploy#--runtime).
+ "buildId": "A String", # Output only. The Cloud Build ID of the latest successful deployment of the
+ # function.
"serviceAccountEmail": "A String", # The email of the function's service account. If empty, defaults to
# `{project_id}@appspot.gserviceaccount.com`.
- "maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a
- # given time.
- "description": "A String", # User-provided description of a function.
- "environmentVariables": { # Environment variables that shall be available during function execution.
- "a_key": "A String",
- },
- "status": "A String", # Output only. Status of the function deployment.
+ "name": "A String", # A user-defined name of the function. Function names must be unique
+ # globally and match pattern `projects/*/locations/*/functions/*`
"eventTrigger": { # Describes EventTrigger, used to request events be sent from another # A source that fires events in response to a condition in another service.
# service.
+ "service": "A String", # The hostname of the service that should be observed.
+ #
+ # If no string is provided, the default service implementing the API will
+ # be used. For example, `storage.googleapis.com` is the default for all
+ # event types in the `google.storage` namespace.
"eventType": "A String", # Required. The type of event to observe. For example:
# `providers/cloud.storage/eventTypes/object.change` and
# `providers/cloud.pubsub/eventTypes/topic.publish`.
@@ -209,11 +210,6 @@
# format.
#
# See each *service's* documentation for supported formats.
- "service": "A String", # The hostname of the service that should be observed.
- #
- # If no string is provided, the default service implementing the API will
- # be used. For example, `storage.googleapis.com` is the default for all
- # event types in the `google.storage` namespace.
"failurePolicy": { # Describes the policy in case of function's execution failure. # Specifies policy for failed executions.
# If empty, then defaults to ignoring failures (i.e. not retrying them).
"retry": { # Describes the retry policy in case of function's execution failure. # If specified, then the function will be retried in case of a failure.
@@ -224,24 +220,53 @@
},
},
},
- "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated
- # by google.cloud.functions.v1.GenerateUploadUrl
+ "entryPoint": "A String", # The name of the function (as defined in source code) that will be
+ # executed. Defaults to the resource name suffix, if not specified. For
+ # backward compatibility, if function with given name is not found, then the
+ # system will try to use function named "function".
+ # For Node.js this is name of a function exported by the module specified
+ # in `source_location`.
+ "vpcConnector": "A String", # The VPC Network Connector that this cloud function can connect to. It can
+ # be either the fully-qualified URI, or the short name of the network
+ # connector resource. The format of this field is
+ # `projects/*/locations/*/connectors/*`
+ #
+ # This field is mutually exclusive with `network` field and will eventually
+ # replace it.
+ #
+ # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
+ # more information on connecting Cloud projects.
+ "network": "A String", # The VPC Network that this cloud function can connect to. It can be
+ # either the fully-qualified URI, or the short name of the network resource.
+ # If the short network name is used, the network must belong to the same
+ # project. Otherwise, it must belong to a project within the same
+ # organization. The format of this field is either
+ # `projects/{project}/global/networks/{network}` or `{network}`, where
+ # {project} is a project id where the network is defined, and {network} is
+ # the short name of the network.
+ #
+ # This field is mutually exclusive with `vpc_connector` and will be replaced
+ # by it.
+ #
+ # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
+ # more information on connecting Cloud projects.
+ "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip
+ # archive which contains the function.
+ "httpsTrigger": { # Describes HttpsTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL.
+ "url": "A String", # Output only. The deployed url for the function.
+ },
+ "vpcConnectorEgressSettings": "A String", # The egress settings for the connector, controlling what traffic is diverted
+ # through it.
+ "status": "A String", # Output only. Status of the function deployment.
+ "description": "A String", # User-provided description of a function.
"timeout": "A String", # The function execution timeout. Execution is considered failed and
# can be terminated if the function is not completed at the end of the
# timeout period. Defaults to 60 seconds.
- "availableMemoryMb": 42, # The amount of memory in MB available for a function.
- # Defaults to 256MB.
- "name": "A String", # A user-defined name of the function. Function names must be unique
- # globally and match pattern `projects/*/locations/*/functions/*`
- "runtime": "A String", # The runtime in which to run the function. Required when deploying a new
- # function, optional when updating an existing function. For a complete
- # list of possible choices, see the
- # [`gcloud` command
- # reference](/sdk/gcloud/reference/functions/deploy#--runtime).
+ "labels": { # Labels associated with this Cloud Function.
+ "a_key": "A String",
+ },
"versionId": "A String", # Output only. The version identifier of the Cloud Function. Each deployment attempt
# results in a new version of a function being created.
- "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip
- # archive which contains the function.
"sourceRepository": { # Describes SourceRepository, used to represent parameters related to # **Beta Feature**
#
# The source repository where a function is hosted.
@@ -263,40 +288,17 @@
# were defined at the time of deployment. It always points to a specific
# commit in the format described above.
},
- "network": "A String", # The VPC Network that this cloud function can connect to. It can be
- # either the fully-qualified URI, or the short name of the network resource.
- # If the short network name is used, the network must belong to the same
- # project. Otherwise, it must belong to a project within the same
- # organization. The format of this field is either
- # `projects/{project}/global/networks/{network}` or `{network}`, where
- # {project} is a project id where the network is defined, and {network} is
- # the short name of the network.
- #
- # This field is mutually exclusive with `vpc_connector` and will be replaced
- # by it.
- #
- # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
- # more information on connecting Cloud projects.
- "vpcConnector": "A String", # The VPC Network Connector that this cloud function can connect to. It can
- # be either the fully-qualified URI, or the short name of the network
- # connector resource. The format of this field is
- # `projects/*/locations/*/connectors/*`
- #
- # This field is mutually exclusive with `network` field and will eventually
- # replace it.
- #
- # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
- # more information on connecting Cloud projects.
- "entryPoint": "A String", # The name of the function (as defined in source code) that will be
- # executed. Defaults to the resource name suffix, if not specified. For
- # backward compatibility, if function with given name is not found, then the
- # system will try to use function named "function".
- # For Node.js this is name of a function exported by the module specified
- # in `source_location`.
- "labels": { # Labels associated with this Cloud Function.
+ "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated
+ # by google.cloud.functions.v1.GenerateUploadUrl
+ "availableMemoryMb": 42, # The amount of memory in MB available for a function.
+ # Defaults to 256MB.
+ "environmentVariables": { # Environment variables that shall be available during function execution.
"a_key": "A String",
},
- "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
+ "maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a
+ # given time.
+ "ingressSettings": "A String", # The ingress settings for the function, controlling what traffic can reach
+ # it.
}
x__xgafv: string, V1 error format.
@@ -312,6 +314,24 @@
"done": True or False, # If the value is `false`, it means the operation is still in progress.
# If `true`, the operation is completed, and either `error` or `response` is
# available.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "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.
+ "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.
+ },
+ ],
+ },
"response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
@@ -325,24 +345,6 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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.
- "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.
- "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.
- },
- ],
- },
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
@@ -373,6 +375,24 @@
"done": True or False, # If the value is `false`, it means the operation is still in progress.
# If `true`, the operation is completed, and either `error` or `response` is
# available.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "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.
+ "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.
+ },
+ ],
+ },
"response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
@@ -386,24 +406,6 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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.
- "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.
- "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.
- },
- ],
- },
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
@@ -514,24 +516,25 @@
{ # Describes a Cloud Function that contains user computation executed in
# response to an event. It encapsulate function and triggers configurations.
- "httpsTrigger": { # Describes HttpsTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL.
- "url": "A String", # Output only. The deployed url for the function.
- },
- "vpcConnectorEgressSettings": "A String", # The egress settings for the connector, controlling what traffic is diverted
- # through it.
- "ingressSettings": "A String", # The ingress settings for the function, controlling what traffic can reach
- # it.
+ "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
+ "runtime": "A String", # The runtime in which to run the function. Required when deploying a new
+ # function, optional when updating an existing function. For a complete
+ # list of possible choices, see the
+ # [`gcloud` command
+ # reference](/sdk/gcloud/reference/functions/deploy#--runtime).
+ "buildId": "A String", # Output only. The Cloud Build ID of the latest successful deployment of the
+ # function.
"serviceAccountEmail": "A String", # The email of the function's service account. If empty, defaults to
# `{project_id}@appspot.gserviceaccount.com`.
- "maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a
- # given time.
- "description": "A String", # User-provided description of a function.
- "environmentVariables": { # Environment variables that shall be available during function execution.
- "a_key": "A String",
- },
- "status": "A String", # Output only. Status of the function deployment.
+ "name": "A String", # A user-defined name of the function. Function names must be unique
+ # globally and match pattern `projects/*/locations/*/functions/*`
"eventTrigger": { # Describes EventTrigger, used to request events be sent from another # A source that fires events in response to a condition in another service.
# service.
+ "service": "A String", # The hostname of the service that should be observed.
+ #
+ # If no string is provided, the default service implementing the API will
+ # be used. For example, `storage.googleapis.com` is the default for all
+ # event types in the `google.storage` namespace.
"eventType": "A String", # Required. The type of event to observe. For example:
# `providers/cloud.storage/eventTypes/object.change` and
# `providers/cloud.pubsub/eventTypes/topic.publish`.
@@ -565,11 +568,6 @@
# format.
#
# See each *service's* documentation for supported formats.
- "service": "A String", # The hostname of the service that should be observed.
- #
- # If no string is provided, the default service implementing the API will
- # be used. For example, `storage.googleapis.com` is the default for all
- # event types in the `google.storage` namespace.
"failurePolicy": { # Describes the policy in case of function's execution failure. # Specifies policy for failed executions.
# If empty, then defaults to ignoring failures (i.e. not retrying them).
"retry": { # Describes the retry policy in case of function's execution failure. # If specified, then the function will be retried in case of a failure.
@@ -580,24 +578,53 @@
},
},
},
- "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated
- # by google.cloud.functions.v1.GenerateUploadUrl
+ "entryPoint": "A String", # The name of the function (as defined in source code) that will be
+ # executed. Defaults to the resource name suffix, if not specified. For
+ # backward compatibility, if function with given name is not found, then the
+ # system will try to use function named "function".
+ # For Node.js this is name of a function exported by the module specified
+ # in `source_location`.
+ "vpcConnector": "A String", # The VPC Network Connector that this cloud function can connect to. It can
+ # be either the fully-qualified URI, or the short name of the network
+ # connector resource. The format of this field is
+ # `projects/*/locations/*/connectors/*`
+ #
+ # This field is mutually exclusive with `network` field and will eventually
+ # replace it.
+ #
+ # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
+ # more information on connecting Cloud projects.
+ "network": "A String", # The VPC Network that this cloud function can connect to. It can be
+ # either the fully-qualified URI, or the short name of the network resource.
+ # If the short network name is used, the network must belong to the same
+ # project. Otherwise, it must belong to a project within the same
+ # organization. The format of this field is either
+ # `projects/{project}/global/networks/{network}` or `{network}`, where
+ # {project} is a project id where the network is defined, and {network} is
+ # the short name of the network.
+ #
+ # This field is mutually exclusive with `vpc_connector` and will be replaced
+ # by it.
+ #
+ # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
+ # more information on connecting Cloud projects.
+ "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip
+ # archive which contains the function.
+ "httpsTrigger": { # Describes HttpsTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL.
+ "url": "A String", # Output only. The deployed url for the function.
+ },
+ "vpcConnectorEgressSettings": "A String", # The egress settings for the connector, controlling what traffic is diverted
+ # through it.
+ "status": "A String", # Output only. Status of the function deployment.
+ "description": "A String", # User-provided description of a function.
"timeout": "A String", # The function execution timeout. Execution is considered failed and
# can be terminated if the function is not completed at the end of the
# timeout period. Defaults to 60 seconds.
- "availableMemoryMb": 42, # The amount of memory in MB available for a function.
- # Defaults to 256MB.
- "name": "A String", # A user-defined name of the function. Function names must be unique
- # globally and match pattern `projects/*/locations/*/functions/*`
- "runtime": "A String", # The runtime in which to run the function. Required when deploying a new
- # function, optional when updating an existing function. For a complete
- # list of possible choices, see the
- # [`gcloud` command
- # reference](/sdk/gcloud/reference/functions/deploy#--runtime).
+ "labels": { # Labels associated with this Cloud Function.
+ "a_key": "A String",
+ },
"versionId": "A String", # Output only. The version identifier of the Cloud Function. Each deployment attempt
# results in a new version of a function being created.
- "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip
- # archive which contains the function.
"sourceRepository": { # Describes SourceRepository, used to represent parameters related to # **Beta Feature**
#
# The source repository where a function is hosted.
@@ -619,40 +646,17 @@
# were defined at the time of deployment. It always points to a specific
# commit in the format described above.
},
- "network": "A String", # The VPC Network that this cloud function can connect to. It can be
- # either the fully-qualified URI, or the short name of the network resource.
- # If the short network name is used, the network must belong to the same
- # project. Otherwise, it must belong to a project within the same
- # organization. The format of this field is either
- # `projects/{project}/global/networks/{network}` or `{network}`, where
- # {project} is a project id where the network is defined, and {network} is
- # the short name of the network.
- #
- # This field is mutually exclusive with `vpc_connector` and will be replaced
- # by it.
- #
- # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
- # more information on connecting Cloud projects.
- "vpcConnector": "A String", # The VPC Network Connector that this cloud function can connect to. It can
- # be either the fully-qualified URI, or the short name of the network
- # connector resource. The format of this field is
- # `projects/*/locations/*/connectors/*`
- #
- # This field is mutually exclusive with `network` field and will eventually
- # replace it.
- #
- # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
- # more information on connecting Cloud projects.
- "entryPoint": "A String", # The name of the function (as defined in source code) that will be
- # executed. Defaults to the resource name suffix, if not specified. For
- # backward compatibility, if function with given name is not found, then the
- # system will try to use function named "function".
- # For Node.js this is name of a function exported by the module specified
- # in `source_location`.
- "labels": { # Labels associated with this Cloud Function.
+ "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated
+ # by google.cloud.functions.v1.GenerateUploadUrl
+ "availableMemoryMb": 42, # The amount of memory in MB available for a function.
+ # Defaults to 256MB.
+ "environmentVariables": { # Environment variables that shall be available during function execution.
"a_key": "A String",
},
- "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
+ "maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a
+ # given time.
+ "ingressSettings": "A String", # The ingress settings for the function, controlling what traffic can reach
+ # it.
}</pre>
</div>
@@ -752,30 +756,6 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "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).
"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
@@ -792,7 +772,7 @@
# {
# "audit_configs": [
# {
- # "service": "allServices"
+ # "service": "allServices",
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
@@ -801,18 +781,18 @@
# ]
# },
# {
- # "log_type": "DATA_WRITE",
+ # "log_type": "DATA_WRITE"
# },
# {
- # "log_type": "ADMIN_READ",
+ # "log_type": "ADMIN_READ"
# }
# ]
# },
# {
- # "service": "sampleservice.googleapis.com"
+ # "service": "sampleservice.googleapis.com",
# "audit_log_configs": [
# {
- # "log_type": "DATA_READ",
+ # "log_type": "DATA_READ"
# },
# {
# "log_type": "DATA_WRITE",
@@ -844,7 +824,7 @@
# ]
# },
# {
- # "log_type": "DATA_WRITE",
+ # "log_type": "DATA_WRITE"
# }
# ]
# }
@@ -861,6 +841,18 @@
],
},
],
+ "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.
"bindings": [ # Associates a list of `members` to 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 member.
@@ -907,16 +899,18 @@
# 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.
+ "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.
- "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.
- "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.
},
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -962,27 +956,37 @@
#
"A String",
],
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
- "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.
+ "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).
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Returns a list of functions that belong to the requested project.
Args:
@@ -992,11 +996,11 @@
location. When listing functions in all locations, if one or more
location(s) are unreachable, the response will contain functions from all
reachable locations along with the names of any unreachable locations. (required)
+ pageSize: integer, Maximum number of functions to return per call.
pageToken: string, The value returned by the last
`ListFunctionsResponse`; indicates that
this is a continuation of a prior `ListFunctions` call, and that the
system should return the next page of data.
- pageSize: integer, Maximum number of functions to return per call.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -1006,31 +1010,28 @@
An object of the form:
{ # Response for the `ListFunctions` method.
- "unreachable": [ # Locations that could not be reached. The response does not include any
- # functions from these locations.
- "A String",
- ],
"functions": [ # The functions that match the request.
{ # Describes a Cloud Function that contains user computation executed in
# response to an event. It encapsulate function and triggers configurations.
- "httpsTrigger": { # Describes HttpsTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL.
- "url": "A String", # Output only. The deployed url for the function.
- },
- "vpcConnectorEgressSettings": "A String", # The egress settings for the connector, controlling what traffic is diverted
- # through it.
- "ingressSettings": "A String", # The ingress settings for the function, controlling what traffic can reach
- # it.
+ "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
+ "runtime": "A String", # The runtime in which to run the function. Required when deploying a new
+ # function, optional when updating an existing function. For a complete
+ # list of possible choices, see the
+ # [`gcloud` command
+ # reference](/sdk/gcloud/reference/functions/deploy#--runtime).
+ "buildId": "A String", # Output only. The Cloud Build ID of the latest successful deployment of the
+ # function.
"serviceAccountEmail": "A String", # The email of the function's service account. If empty, defaults to
# `{project_id}@appspot.gserviceaccount.com`.
- "maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a
- # given time.
- "description": "A String", # User-provided description of a function.
- "environmentVariables": { # Environment variables that shall be available during function execution.
- "a_key": "A String",
- },
- "status": "A String", # Output only. Status of the function deployment.
+ "name": "A String", # A user-defined name of the function. Function names must be unique
+ # globally and match pattern `projects/*/locations/*/functions/*`
"eventTrigger": { # Describes EventTrigger, used to request events be sent from another # A source that fires events in response to a condition in another service.
# service.
+ "service": "A String", # The hostname of the service that should be observed.
+ #
+ # If no string is provided, the default service implementing the API will
+ # be used. For example, `storage.googleapis.com` is the default for all
+ # event types in the `google.storage` namespace.
"eventType": "A String", # Required. The type of event to observe. For example:
# `providers/cloud.storage/eventTypes/object.change` and
# `providers/cloud.pubsub/eventTypes/topic.publish`.
@@ -1064,11 +1065,6 @@
# format.
#
# See each *service's* documentation for supported formats.
- "service": "A String", # The hostname of the service that should be observed.
- #
- # If no string is provided, the default service implementing the API will
- # be used. For example, `storage.googleapis.com` is the default for all
- # event types in the `google.storage` namespace.
"failurePolicy": { # Describes the policy in case of function's execution failure. # Specifies policy for failed executions.
# If empty, then defaults to ignoring failures (i.e. not retrying them).
"retry": { # Describes the retry policy in case of function's execution failure. # If specified, then the function will be retried in case of a failure.
@@ -1079,24 +1075,53 @@
},
},
},
- "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated
- # by google.cloud.functions.v1.GenerateUploadUrl
+ "entryPoint": "A String", # The name of the function (as defined in source code) that will be
+ # executed. Defaults to the resource name suffix, if not specified. For
+ # backward compatibility, if function with given name is not found, then the
+ # system will try to use function named "function".
+ # For Node.js this is name of a function exported by the module specified
+ # in `source_location`.
+ "vpcConnector": "A String", # The VPC Network Connector that this cloud function can connect to. It can
+ # be either the fully-qualified URI, or the short name of the network
+ # connector resource. The format of this field is
+ # `projects/*/locations/*/connectors/*`
+ #
+ # This field is mutually exclusive with `network` field and will eventually
+ # replace it.
+ #
+ # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
+ # more information on connecting Cloud projects.
+ "network": "A String", # The VPC Network that this cloud function can connect to. It can be
+ # either the fully-qualified URI, or the short name of the network resource.
+ # If the short network name is used, the network must belong to the same
+ # project. Otherwise, it must belong to a project within the same
+ # organization. The format of this field is either
+ # `projects/{project}/global/networks/{network}` or `{network}`, where
+ # {project} is a project id where the network is defined, and {network} is
+ # the short name of the network.
+ #
+ # This field is mutually exclusive with `vpc_connector` and will be replaced
+ # by it.
+ #
+ # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
+ # more information on connecting Cloud projects.
+ "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip
+ # archive which contains the function.
+ "httpsTrigger": { # Describes HttpsTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL.
+ "url": "A String", # Output only. The deployed url for the function.
+ },
+ "vpcConnectorEgressSettings": "A String", # The egress settings for the connector, controlling what traffic is diverted
+ # through it.
+ "status": "A String", # Output only. Status of the function deployment.
+ "description": "A String", # User-provided description of a function.
"timeout": "A String", # The function execution timeout. Execution is considered failed and
# can be terminated if the function is not completed at the end of the
# timeout period. Defaults to 60 seconds.
- "availableMemoryMb": 42, # The amount of memory in MB available for a function.
- # Defaults to 256MB.
- "name": "A String", # A user-defined name of the function. Function names must be unique
- # globally and match pattern `projects/*/locations/*/functions/*`
- "runtime": "A String", # The runtime in which to run the function. Required when deploying a new
- # function, optional when updating an existing function. For a complete
- # list of possible choices, see the
- # [`gcloud` command
- # reference](/sdk/gcloud/reference/functions/deploy#--runtime).
+ "labels": { # Labels associated with this Cloud Function.
+ "a_key": "A String",
+ },
"versionId": "A String", # Output only. The version identifier of the Cloud Function. Each deployment attempt
# results in a new version of a function being created.
- "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip
- # archive which contains the function.
"sourceRepository": { # Describes SourceRepository, used to represent parameters related to # **Beta Feature**
#
# The source repository where a function is hosted.
@@ -1118,46 +1143,27 @@
# were defined at the time of deployment. It always points to a specific
# commit in the format described above.
},
- "network": "A String", # The VPC Network that this cloud function can connect to. It can be
- # either the fully-qualified URI, or the short name of the network resource.
- # If the short network name is used, the network must belong to the same
- # project. Otherwise, it must belong to a project within the same
- # organization. The format of this field is either
- # `projects/{project}/global/networks/{network}` or `{network}`, where
- # {project} is a project id where the network is defined, and {network} is
- # the short name of the network.
- #
- # This field is mutually exclusive with `vpc_connector` and will be replaced
- # by it.
- #
- # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
- # more information on connecting Cloud projects.
- "vpcConnector": "A String", # The VPC Network Connector that this cloud function can connect to. It can
- # be either the fully-qualified URI, or the short name of the network
- # connector resource. The format of this field is
- # `projects/*/locations/*/connectors/*`
- #
- # This field is mutually exclusive with `network` field and will eventually
- # replace it.
- #
- # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
- # more information on connecting Cloud projects.
- "entryPoint": "A String", # The name of the function (as defined in source code) that will be
- # executed. Defaults to the resource name suffix, if not specified. For
- # backward compatibility, if function with given name is not found, then the
- # system will try to use function named "function".
- # For Node.js this is name of a function exported by the module specified
- # in `source_location`.
- "labels": { # Labels associated with this Cloud Function.
+ "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated
+ # by google.cloud.functions.v1.GenerateUploadUrl
+ "availableMemoryMb": 42, # The amount of memory in MB available for a function.
+ # Defaults to 256MB.
+ "environmentVariables": { # Environment variables that shall be available during function execution.
"a_key": "A String",
},
- "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
+ "maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a
+ # given time.
+ "ingressSettings": "A String", # The ingress settings for the function, controlling what traffic can reach
+ # it.
},
],
"nextPageToken": "A String", # If not empty, indicates that there may be more functions that match
# the request; this value should be passed in a new
# google.cloud.functions.v1.ListFunctionsRequest
# to get more functions.
+ "unreachable": [ # Locations that could not be reached. The response does not include any
+ # functions from these locations.
+ "A String",
+ ],
}</pre>
</div>
@@ -1187,24 +1193,25 @@
{ # Describes a Cloud Function that contains user computation executed in
# response to an event. It encapsulate function and triggers configurations.
- "httpsTrigger": { # Describes HttpsTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL.
- "url": "A String", # Output only. The deployed url for the function.
- },
- "vpcConnectorEgressSettings": "A String", # The egress settings for the connector, controlling what traffic is diverted
- # through it.
- "ingressSettings": "A String", # The ingress settings for the function, controlling what traffic can reach
- # it.
+ "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
+ "runtime": "A String", # The runtime in which to run the function. Required when deploying a new
+ # function, optional when updating an existing function. For a complete
+ # list of possible choices, see the
+ # [`gcloud` command
+ # reference](/sdk/gcloud/reference/functions/deploy#--runtime).
+ "buildId": "A String", # Output only. The Cloud Build ID of the latest successful deployment of the
+ # function.
"serviceAccountEmail": "A String", # The email of the function's service account. If empty, defaults to
# `{project_id}@appspot.gserviceaccount.com`.
- "maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a
- # given time.
- "description": "A String", # User-provided description of a function.
- "environmentVariables": { # Environment variables that shall be available during function execution.
- "a_key": "A String",
- },
- "status": "A String", # Output only. Status of the function deployment.
+ "name": "A String", # A user-defined name of the function. Function names must be unique
+ # globally and match pattern `projects/*/locations/*/functions/*`
"eventTrigger": { # Describes EventTrigger, used to request events be sent from another # A source that fires events in response to a condition in another service.
# service.
+ "service": "A String", # The hostname of the service that should be observed.
+ #
+ # If no string is provided, the default service implementing the API will
+ # be used. For example, `storage.googleapis.com` is the default for all
+ # event types in the `google.storage` namespace.
"eventType": "A String", # Required. The type of event to observe. For example:
# `providers/cloud.storage/eventTypes/object.change` and
# `providers/cloud.pubsub/eventTypes/topic.publish`.
@@ -1238,11 +1245,6 @@
# format.
#
# See each *service's* documentation for supported formats.
- "service": "A String", # The hostname of the service that should be observed.
- #
- # If no string is provided, the default service implementing the API will
- # be used. For example, `storage.googleapis.com` is the default for all
- # event types in the `google.storage` namespace.
"failurePolicy": { # Describes the policy in case of function's execution failure. # Specifies policy for failed executions.
# If empty, then defaults to ignoring failures (i.e. not retrying them).
"retry": { # Describes the retry policy in case of function's execution failure. # If specified, then the function will be retried in case of a failure.
@@ -1253,24 +1255,53 @@
},
},
},
- "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated
- # by google.cloud.functions.v1.GenerateUploadUrl
+ "entryPoint": "A String", # The name of the function (as defined in source code) that will be
+ # executed. Defaults to the resource name suffix, if not specified. For
+ # backward compatibility, if function with given name is not found, then the
+ # system will try to use function named "function".
+ # For Node.js this is name of a function exported by the module specified
+ # in `source_location`.
+ "vpcConnector": "A String", # The VPC Network Connector that this cloud function can connect to. It can
+ # be either the fully-qualified URI, or the short name of the network
+ # connector resource. The format of this field is
+ # `projects/*/locations/*/connectors/*`
+ #
+ # This field is mutually exclusive with `network` field and will eventually
+ # replace it.
+ #
+ # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
+ # more information on connecting Cloud projects.
+ "network": "A String", # The VPC Network that this cloud function can connect to. It can be
+ # either the fully-qualified URI, or the short name of the network resource.
+ # If the short network name is used, the network must belong to the same
+ # project. Otherwise, it must belong to a project within the same
+ # organization. The format of this field is either
+ # `projects/{project}/global/networks/{network}` or `{network}`, where
+ # {project} is a project id where the network is defined, and {network} is
+ # the short name of the network.
+ #
+ # This field is mutually exclusive with `vpc_connector` and will be replaced
+ # by it.
+ #
+ # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
+ # more information on connecting Cloud projects.
+ "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip
+ # archive which contains the function.
+ "httpsTrigger": { # Describes HttpsTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL.
+ "url": "A String", # Output only. The deployed url for the function.
+ },
+ "vpcConnectorEgressSettings": "A String", # The egress settings for the connector, controlling what traffic is diverted
+ # through it.
+ "status": "A String", # Output only. Status of the function deployment.
+ "description": "A String", # User-provided description of a function.
"timeout": "A String", # The function execution timeout. Execution is considered failed and
# can be terminated if the function is not completed at the end of the
# timeout period. Defaults to 60 seconds.
- "availableMemoryMb": 42, # The amount of memory in MB available for a function.
- # Defaults to 256MB.
- "name": "A String", # A user-defined name of the function. Function names must be unique
- # globally and match pattern `projects/*/locations/*/functions/*`
- "runtime": "A String", # The runtime in which to run the function. Required when deploying a new
- # function, optional when updating an existing function. For a complete
- # list of possible choices, see the
- # [`gcloud` command
- # reference](/sdk/gcloud/reference/functions/deploy#--runtime).
+ "labels": { # Labels associated with this Cloud Function.
+ "a_key": "A String",
+ },
"versionId": "A String", # Output only. The version identifier of the Cloud Function. Each deployment attempt
# results in a new version of a function being created.
- "sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip
- # archive which contains the function.
"sourceRepository": { # Describes SourceRepository, used to represent parameters related to # **Beta Feature**
#
# The source repository where a function is hosted.
@@ -1292,40 +1323,17 @@
# were defined at the time of deployment. It always points to a specific
# commit in the format described above.
},
- "network": "A String", # The VPC Network that this cloud function can connect to. It can be
- # either the fully-qualified URI, or the short name of the network resource.
- # If the short network name is used, the network must belong to the same
- # project. Otherwise, it must belong to a project within the same
- # organization. The format of this field is either
- # `projects/{project}/global/networks/{network}` or `{network}`, where
- # {project} is a project id where the network is defined, and {network} is
- # the short name of the network.
- #
- # This field is mutually exclusive with `vpc_connector` and will be replaced
- # by it.
- #
- # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
- # more information on connecting Cloud projects.
- "vpcConnector": "A String", # The VPC Network Connector that this cloud function can connect to. It can
- # be either the fully-qualified URI, or the short name of the network
- # connector resource. The format of this field is
- # `projects/*/locations/*/connectors/*`
- #
- # This field is mutually exclusive with `network` field and will eventually
- # replace it.
- #
- # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for
- # more information on connecting Cloud projects.
- "entryPoint": "A String", # The name of the function (as defined in source code) that will be
- # executed. Defaults to the resource name suffix, if not specified. For
- # backward compatibility, if function with given name is not found, then the
- # system will try to use function named "function".
- # For Node.js this is name of a function exported by the module specified
- # in `source_location`.
- "labels": { # Labels associated with this Cloud Function.
+ "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated
+ # by google.cloud.functions.v1.GenerateUploadUrl
+ "availableMemoryMb": 42, # The amount of memory in MB available for a function.
+ # Defaults to 256MB.
+ "environmentVariables": { # Environment variables that shall be available during function execution.
"a_key": "A String",
},
- "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
+ "maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a
+ # given time.
+ "ingressSettings": "A String", # The ingress settings for the function, controlling what traffic can reach
+ # it.
}
updateMask: string, Required list of fields to be updated in this request.
@@ -1342,6 +1350,24 @@
"done": True or False, # If the value is `false`, it means the operation is still in progress.
# If `true`, the operation is completed, and either `error` or `response` is
# available.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "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.
+ "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.
+ },
+ ],
+ },
"response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
@@ -1355,24 +1381,6 @@
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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.
- "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.
- "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.
- },
- ],
- },
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
@@ -1394,6 +1402,11 @@
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
+ "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
+ # the fields in the mask will be modified. If no mask is provided, the
+ # following default mask is used:
+ #
+ # `paths: "bindings, 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 a
# valid policy but certain Cloud Platform services (such as Projects)
@@ -1464,30 +1477,6 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "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).
"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
@@ -1504,7 +1493,7 @@
# {
# "audit_configs": [
# {
- # "service": "allServices"
+ # "service": "allServices",
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
@@ -1513,18 +1502,18 @@
# ]
# },
# {
- # "log_type": "DATA_WRITE",
+ # "log_type": "DATA_WRITE"
# },
# {
- # "log_type": "ADMIN_READ",
+ # "log_type": "ADMIN_READ"
# }
# ]
# },
# {
- # "service": "sampleservice.googleapis.com"
+ # "service": "sampleservice.googleapis.com",
# "audit_log_configs": [
# {
- # "log_type": "DATA_READ",
+ # "log_type": "DATA_READ"
# },
# {
# "log_type": "DATA_WRITE",
@@ -1556,7 +1545,7 @@
# ]
# },
# {
- # "log_type": "DATA_WRITE",
+ # "log_type": "DATA_WRITE"
# }
# ]
# }
@@ -1573,6 +1562,18 @@
],
},
],
+ "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.
"bindings": [ # Associates a list of `members` to 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 member.
@@ -1619,16 +1620,18 @@
# 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.
+ "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.
- "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.
- "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.
},
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -1674,28 +1677,33 @@
#
"A String",
],
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
- "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.
+ "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).
},
- "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
- # the fields in the mask will be modified. If no mask is provided, the
- # following default mask is used:
- #
- # `paths: "bindings, etag"`
}
x__xgafv: string, V1 error format.
@@ -1773,30 +1781,6 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "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).
"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
@@ -1813,7 +1797,7 @@
# {
# "audit_configs": [
# {
- # "service": "allServices"
+ # "service": "allServices",
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
@@ -1822,18 +1806,18 @@
# ]
# },
# {
- # "log_type": "DATA_WRITE",
+ # "log_type": "DATA_WRITE"
# },
# {
- # "log_type": "ADMIN_READ",
+ # "log_type": "ADMIN_READ"
# }
# ]
# },
# {
- # "service": "sampleservice.googleapis.com"
+ # "service": "sampleservice.googleapis.com",
# "audit_log_configs": [
# {
- # "log_type": "DATA_READ",
+ # "log_type": "DATA_READ"
# },
# {
# "log_type": "DATA_WRITE",
@@ -1865,7 +1849,7 @@
# ]
# },
# {
- # "log_type": "DATA_WRITE",
+ # "log_type": "DATA_WRITE"
# }
# ]
# }
@@ -1882,6 +1866,18 @@
],
},
],
+ "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.
"bindings": [ # Associates a list of `members` to 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 member.
@@ -1928,16 +1924,18 @@
# 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.
+ "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.
- "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.
- "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.
},
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -1983,22 +1981,32 @@
#
"A String",
],
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
- "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.
+ "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).
}</pre>
</div>