Types overview

GoogleCloudRunV2BinaryAuthorization

Settings for Binary Authorization feature.

Fields
breakglassJustification	string Optional. If present, indicates to use Breakglass using this justification. If use_default is False, then it must be empty. For more information on breakglass, see https://cloud.google.com/binary-authorization/docs/using-breakglass
policy	string Optional. The path to a binary authorization policy. Format: projects/{project}/platforms/cloudRun/{policy-name}
useDefault	boolean Optional. If True, indicates to use the default project's binary authorization policy. If False, binary authorization will be disabled.

GoogleCloudRunV2CancelExecutionRequest

Request message for deleting an Execution.

Fields
etag	string A system-generated fingerprint for this version of the resource. This may be used to detect modification conflict during updates.
validateOnly	boolean Indicates that the request should be validated without actually cancelling any resources.

GoogleCloudRunV2CloudSqlInstance

Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.

Fields
instances[]	string The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}

GoogleCloudRunV2Condition

Defines a status condition for a resource.

Fields
executionReason	enum Output only. A reason for the execution condition.
Enum type. Can be one of the following:
EXECUTION_REASON_UNDEFINED	Default value.
JOB_STATUS_SERVICE_POLLING_ERROR	Internal system error getting execution status. System will retry.
NON_ZERO_EXIT_CODE	A task reached its retry limit and the last attempt failed due to the user container exiting with a non-zero exit code.
CANCELLED	The execution was cancelled by users.
CANCELLING	The execution is in the process of being cancelled.
DELETED	The execution was deleted.
lastTransitionTime	string (Timestamp format) Last time the condition transitioned from one status to another.
message	string Human readable message indicating details about the current status.
reason	enum Output only. A common (service-level) reason for this condition.
Enum type. Can be one of the following:
COMMON_REASON_UNDEFINED	Default value.
UNKNOWN	Reason unknown. Further details will be in message.
REVISION_FAILED	Revision creation process failed.
PROGRESS_DEADLINE_EXCEEDED	Timed out waiting for completion.
CONTAINER_MISSING	The container image path is incorrect.
CONTAINER_PERMISSION_DENIED	Insufficient permissions on the container image.
CONTAINER_IMAGE_UNAUTHORIZED	Container image is not authorized by policy.
CONTAINER_IMAGE_AUTHORIZATION_CHECK_FAILED	Container image policy authorization check failed.
ENCRYPTION_KEY_PERMISSION_DENIED	Insufficient permissions on encryption key.
ENCRYPTION_KEY_CHECK_FAILED	Permission check on encryption key failed.
SECRETS_ACCESS_CHECK_FAILED	At least one Access check on secrets failed.
WAITING_FOR_OPERATION	Waiting for operation to complete.
IMMEDIATE_RETRY	System will retry immediately.
POSTPONED_RETRY	System will retry later; current attempt failed.
INTERNAL	An internal error occurred. Further information may be in the message.
revisionReason	enum Output only. A reason for the revision condition.
Enum type. Can be one of the following:
REVISION_REASON_UNDEFINED	Default value.
PENDING	Revision in Pending state.
RESERVE	Revision is in Reserve state.
RETIRED	Revision is Retired.
RETIRING	Revision is being retired.
RECREATING	Revision is being recreated.
HEALTH_CHECK_CONTAINER_ERROR	There was a health check error.
CUSTOMIZED_PATH_RESPONSE_PENDING	Health check failed due to user error from customized path of the container. System will retry.
MIN_INSTANCES_NOT_PROVISIONED	A revision with min_instance_count > 0 was created and is reserved, but it was not configured to serve traffic, so it's not live. This can also happen momentarily during traffic migration.
ACTIVE_REVISION_LIMIT_REACHED	The maximum allowed number of active revisions has been reached.
NO_DEPLOYMENT	There was no deployment defined. This value is no longer used, but Services created in older versions of the API might contain this value.
HEALTH_CHECK_SKIPPED	A revision's container has no port specified since the revision is of a manually scaled service with 0 instance count
MIN_INSTANCES_WARMING	A revision with min_instance_count > 0 was created and is waiting for enough instances to begin a traffic migration.
severity	enum How to interpret failures of this condition, one of Error, Warning, Info
Enum type. Can be one of the following:
SEVERITY_UNSPECIFIED	Unspecified severity
ERROR	Error severity.
WARNING	Warning severity.
INFO	Info severity.
state	enum State of the condition.
Enum type. Can be one of the following:
STATE_UNSPECIFIED	The default value. This value is used if the state is omitted.
CONDITION_PENDING	Transient state: Reconciliation has not started yet.
CONDITION_RECONCILING	Transient state: reconciliation is still in progress.
CONDITION_FAILED	Terminal state: Reconciliation did not succeed.
CONDITION_SUCCEEDED	Terminal state: Reconciliation completed successfully.
type	string type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.

GoogleCloudRunV2Container

A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments can be supplied by the system to the container at runtime.

Fields
args[]	string Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
command[]	string Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
dependsOn[]	string Names of the containers that must start before this container.
env[]	object (GoogleCloudRunV2EnvVar) List of environment variables to set in the container.
image	string Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed.
livenessProbe	object (GoogleCloudRunV2Probe) Periodic probe of container liveness. Container will be restarted if the probe fails.
name	string Name of the container specified as a DNS_LABEL (RFC 1123).
ports[]	object (GoogleCloudRunV2ContainerPort) List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
resources	object (GoogleCloudRunV2ResourceRequirements) Compute Resource requirements by this container.
startupProbe	object (GoogleCloudRunV2Probe) Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails.
volumeMounts[]	object (GoogleCloudRunV2VolumeMount) Volume to mount into the container's filesystem.
workingDir	string Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.

GoogleCloudRunV2ContainerOverride

Per-container override specification.

Fields
args[]	string Optional. Arguments to the entrypoint. Will replace existing args for override.
clearArgs	boolean Optional. True if the intention is to clear out existing args list.
env[]	object (GoogleCloudRunV2EnvVar) List of environment variables to set in the container. Will be merged with existing env for override.
name	string The name of the container specified as a DNS_LABEL.

GoogleCloudRunV2ContainerPort

ContainerPort represents a network port in a single container.

Fields
containerPort	integer (int32 format) Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
name	string If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c".

GoogleCloudRunV2EmptyDirVolumeSource

In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs).

Fields
medium	enum The medium on which the data is stored. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional
Enum type. Can be one of the following:
MEDIUM_UNSPECIFIED	When not specified, falls back to the default implementation which is currently in memory (this may change over time).
MEMORY	Explicitly set the EmptyDir to be in memory. Uses tmpfs.
sizeLimit	string Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir

GoogleCloudRunV2EnvVar

EnvVar represents an environment variable present in a Container.

Fields
name	string Required. Name of the environment variable. Must not exceed 32768 characters.
value	string Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "", and the maximum length is 32768 bytes.
valueSource	object (GoogleCloudRunV2EnvVarSource) Source for the environment variable's value.

GoogleCloudRunV2EnvVarSource

EnvVarSource represents a source for the value of an EnvVar.

Fields
secretKeyRef	object (GoogleCloudRunV2SecretKeySelector) Selects a secret and a specific version from Cloud Secret Manager.

GoogleCloudRunV2Execution

Execution represents the configuration of a single execution. A execution an immutable resource that references a container image which is run to completion.

Fields
annotations	map (key: string, value: string) Output only. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.
cancelledCount	integer (int32 format) Output only. The number of tasks which reached phase Cancelled.
completionTime	string (Timestamp format) Output only. Represents time when the execution was completed. It is not guaranteed to be set in happens-before order across separate operations.
conditions[]	object (GoogleCloudRunV2Condition) Output only. The Condition of this Execution, containing its readiness status, and detailed error information in case it did not reach the desired state.
createTime	string (Timestamp format) Output only. Represents time when the execution was acknowledged by the execution controller. It is not guaranteed to be set in happens-before order across separate operations.
deleteTime	string (Timestamp format) Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.
etag	string Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
expireTime	string (Timestamp format) Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request.
failedCount	integer (int32 format) Output only. The number of tasks which reached phase Failed.
generation	string (int64 format) Output only. A number that monotonically increases every time the user modifies the desired state.
job	string Output only. The name of the parent Job.
labels	map (key: string, value: string) Output only. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels
launchStage	enum The least stable launch stage needed to create this resource, as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. Note that this value might not be what was used as input. For example, if ALPHA was provided as input in the parent resource, but only BETA and GA-level features are were, this field will be BETA.
Enum type. Can be one of the following:
LAUNCH_STAGE_UNSPECIFIED	Do not use this default value.
UNIMPLEMENTED	The feature is not yet implemented. Users can not use it.
PRELAUNCH	Prelaunch features are hidden from users and are only visible internally.
EARLY_ACCESS	Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
ALPHA	Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.
BETA	Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
GA	GA features are open to all developers and are considered stable and fully qualified for production use.
DEPRECATED	Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation.
logUri	string Output only. URI where logs for this execution can be found in Cloud Console.
name	string Output only. The unique name of this Execution.
observedGeneration	string (int64 format) Output only. The generation of this Execution. See comments in reconciling for additional information on reconciliation process in Cloud Run.
parallelism	integer (int32 format) Output only. Specifies the maximum desired number of tasks the execution should run at any given time. Must be <= task_count. The actual number of tasks running in steady state will be less than this number when ((.spec.task_count - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism.
reconciling	boolean Output only. Indicates whether the resource's reconciliation is still in progress. See comments in Job.reconciling for additional information on reconciliation process in Cloud Run.
retriedCount	integer (int32 format) Output only. The number of tasks which have retried at least once.
runningCount	integer (int32 format) Output only. The number of actively running tasks.
satisfiesPzs	boolean Output only. Reserved for future use.
startTime	string (Timestamp format) Output only. Represents time when the execution started to run. It is not guaranteed to be set in happens-before order across separate operations.
succeededCount	integer (int32 format) Output only. The number of tasks which reached phase Succeeded.
taskCount	integer (int32 format) Output only. Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution.
template	object (GoogleCloudRunV2TaskTemplate) Output only. The template used to create tasks for this execution.
uid	string Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
updateTime	string (Timestamp format) Output only. The last-modified time.

GoogleCloudRunV2ExecutionReference

Reference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status.

Fields
completionTime	string (Timestamp format) Creation timestamp of the execution.
createTime	string (Timestamp format) Creation timestamp of the execution.
name	string Name of the execution.

GoogleCloudRunV2ExecutionTemplate

ExecutionTemplate describes the data an execution should have when created from a template.

Fields
annotations	map (key: string, value: string) Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 ExecutionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules.
labels	map (key: string, value: string) Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 ExecutionTemplate.
parallelism	integer (int32 format) Specifies the maximum desired number of tasks the execution should run at given time. Must be <= task_count. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed remaining, i.e. when the work left to do is less than max parallelism.
taskCount	integer (int32 format) Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution. Defaults to 1.
template	object (GoogleCloudRunV2TaskTemplate) Required. Describes the task(s) that will be created when executing an execution.

GoogleCloudRunV2ExportImageRequest

Request message for exporting Cloud Run image.

Fields
destinationRepo	string Required. The export destination url (the Artifact Registry repo).

GoogleCloudRunV2ExportImageResponse

ExportImageResponse contains an operation Id to track the image export operation.

Fields
operationId	string An operation ID used to track the status of image exports tied to the original pod ID in the request.

GoogleCloudRunV2ExportStatusResponse

ExportStatusResponse contains the status of image export operation, with the status of each image export job.

Fields
imageExportStatuses[]	object (GoogleCloudRunV2ImageExportStatus) The status of each image export job.
operationId	string The operation id.
operationState	enum Output only. The state of the overall export operation.
Enum type. Can be one of the following:
OPERATION_STATE_UNSPECIFIED	State unspecified.
IN_PROGRESS	Operation still in progress.
FINISHED	Operation finished.

GoogleCloudRunV2GCSVolumeSource

Represents a volume backed by a Cloud Storage bucket using Cloud Storage FUSE.

Fields
bucket	string Cloud Storage Bucket name.
readOnly	boolean If true, the volume will be mounted as read only for all mounts.

GoogleCloudRunV2GRPCAction

GRPCAction describes an action involving a GRPC port.

Fields
port	integer (int32 format) Optional. Port number of the gRPC service. Number must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
service	string Optional. Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md ). If this is not specified, the default behavior is defined by gRPC.

GoogleCloudRunV2HTTPGetAction

HTTPGetAction describes an action based on HTTP Get requests.

Fields
httpHeaders[]	object (GoogleCloudRunV2HTTPHeader) Optional. Custom headers to set in the request. HTTP allows repeated headers.
path	string Optional. Path to access on the HTTP server. Defaults to '/'.
port	integer (int32 format) Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.

GoogleCloudRunV2HTTPHeader

HTTPHeader describes a custom header to be used in HTTP probes

Fields
name	string Required. The header field name
value	string Optional. The header field value

GoogleCloudRunV2ImageExportStatus

The status of an image export job.

Fields
exportJobState	enum Output only. Has the image export job finished (regardless of successful or failure).
Enum type. Can be one of the following:
EXPORT_JOB_STATE_UNSPECIFIED	State unspecified.
IN_PROGRESS	Job still in progress.
FINISHED	Job finished.
exportedImageDigest	string The exported image ID as it will appear in Artifact Registry.
status	object (UtilStatusProto) The status of the export task if done.
tag	string The image tag as it will appear in Artifact Registry.

GoogleCloudRunV2Job

Job represents the configuration of a single job, which references a container image that is run to completion.

Fields
annotations	map (key: string, value: string) Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected on new resources. All system annotations in v1 now have a corresponding field in v2 Job. This field follows Kubernetes annotations' namespacing, limits, and rules.
binaryAuthorization	object (GoogleCloudRunV2BinaryAuthorization) Settings for the Binary Authorization feature.
client	string Arbitrary identifier for the API client.
clientVersion	string Arbitrary version identifier for the API client.
conditions[]	object (GoogleCloudRunV2Condition) Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Job does not reach its desired state. See comments in reconciling for additional information on reconciliation process in Cloud Run.
createTime	string (Timestamp format) Output only. The creation time.
creator	string Output only. Email address of the authenticated creator.
deleteTime	string (Timestamp format) Output only. The deletion time.
etag	string Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
executionCount	integer (int32 format) Output only. Number of executions created for this job.
expireTime	string (Timestamp format) Output only. For a deleted resource, the time after which it will be permamently deleted.
generation	string (int64 format) Output only. A number that monotonically increases every time the user modifies the desired state.
labels	map (key: string, value: string) Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Job.
lastModifier	string Output only. Email address of the last authenticated modifier.
latestCreatedExecution	object (GoogleCloudRunV2ExecutionReference) Output only. Name of the last created execution.
launchStage	enum The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.
Enum type. Can be one of the following:
LAUNCH_STAGE_UNSPECIFIED	Do not use this default value.
UNIMPLEMENTED	The feature is not yet implemented. Users can not use it.
PRELAUNCH	Prelaunch features are hidden from users and are only visible internally.
EARLY_ACCESS	Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
ALPHA	Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.
BETA	Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
GA	GA features are open to all developers and are considered stable and fully qualified for production use.
DEPRECATED	Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation.
name	string The fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job}
observedGeneration	string (int64 format) Output only. The generation of this Job. See comments in reconciling for additional information on reconciliation process in Cloud Run.
reconciling	boolean Output only. Returns true if the Job is currently being acted upon by the system to bring it into the desired state. When a new Job is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Job to the desired state. This process is called reconciliation. While reconciliation is in process, observed_generation and latest_succeeded_execution, will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the state matches the Job, or there was an error, and reconciliation failed. This state can be found in terminal_condition.state. If reconciliation succeeded, the following fields will match: observed_generation and generation, latest_succeeded_execution and latest_created_execution. If reconciliation failed, observed_generation and latest_succeeded_execution will have the state of the last succeeded execution or empty for newly created Job. Additional information on the failure can be found in terminal_condition and conditions.
runExecutionToken	string A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully completed. The sum of job name and token length must be fewer than 63 characters.
satisfiesPzs	boolean Output only. Reserved for future use.
startExecutionToken	string A unique string used as a suffix creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters.
template	object (GoogleCloudRunV2ExecutionTemplate) Required. The template used to create executions for this Job.
terminalCondition	object (GoogleCloudRunV2Condition) Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state.
uid	string Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
updateTime	string (Timestamp format) Output only. The last-modified time.

GoogleCloudRunV2ListExecutionsResponse

Response message containing a list of Executions.

Fields
executions[]	object (GoogleCloudRunV2Execution) The resulting list of Executions.
nextPageToken	string A token indicating there are more items than page_size. Use it in the next ListExecutions request to continue.

GoogleCloudRunV2ListJobsResponse

Response message containing a list of Jobs.

Fields
jobs[]	object (GoogleCloudRunV2Job) The resulting list of Jobs.
nextPageToken	string A token indicating there are more items than page_size. Use it in the next ListJobs request to continue.

GoogleCloudRunV2ListRevisionsResponse

Response message containing a list of Revisions.

Fields
nextPageToken	string A token indicating there are more items than page_size. Use it in the next ListRevisions request to continue.
revisions[]	object (GoogleCloudRunV2Revision) The resulting list of Revisions.

GoogleCloudRunV2ListServicesResponse

Response message containing a list of Services.

Fields
nextPageToken	string A token indicating there are more items than page_size. Use it in the next ListServices request to continue.
services[]	object (GoogleCloudRunV2Service) The resulting list of Services.

GoogleCloudRunV2ListTasksResponse

Response message containing a list of Tasks.

Fields
nextPageToken	string A token indicating there are more items than page_size. Use it in the next ListTasks request to continue.
tasks[]	object (GoogleCloudRunV2Task) The resulting list of Tasks.

GoogleCloudRunV2Metadata

Metadata represents the JSON encoded generated customer metadata.

Fields
metadata	string JSON encoded Google-generated Customer Metadata for a given resource/project.

GoogleCloudRunV2NFSVolumeSource

Represents an NFS mount.

Fields
path	string Path that is exported by the NFS server.
readOnly	boolean If true, the volume will be mounted as read only for all mounts.
server	string Hostname or IP address of the NFS server

GoogleCloudRunV2NetworkInterface

Direct VPC egress settings.

Fields
network	string Optional. The VPC network that the Cloud Run resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork.
subnetwork	string Optional. The VPC subnetwork that the Cloud Run resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.
tags[]	string Optional. Network tags applied to this Cloud Run resource.

GoogleCloudRunV2NodeSelector

Hardware constraints configuration.

Fields
accelerator	string Required. GPU accelerator type to attach to an instance.

GoogleCloudRunV2Overrides

RunJob Overrides that contains Execution fields to be overridden.

Fields
containerOverrides[]	object (GoogleCloudRunV2ContainerOverride) Per container override specification.
taskCount	integer (int32 format) Optional. The desired number of tasks the execution should run. Will replace existing task_count value.
timeout	string (Duration format) Duration in seconds the task may be active before the system will actively try to mark it failed and kill associated containers. Will replace existing timeout_seconds value.

GoogleCloudRunV2Probe

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Fields
failureThreshold	integer (int32 format) Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
grpc	object (GoogleCloudRunV2GRPCAction) Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
httpGet	object (GoogleCloudRunV2HTTPGetAction) Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
initialDelaySeconds	integer (int32 format) Optional. Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
periodSeconds	integer (int32 format) Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
tcpSocket	object (GoogleCloudRunV2TCPSocketAction) Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
timeoutSeconds	integer (int32 format) Optional. Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.

GoogleCloudRunV2ResourceRequirements

ResourceRequirements describes the compute resource requirements.

Fields
cpuIdle	boolean Determines whether CPU is only allocated during requests (true by default). However, if ResourceRequirements is set, the caller must explicitly set this field to true to preserve the default behavior.
limits	map (key: string, value: string) Only memory and cpu keys in the map are supported. Notes: * The only supported values for CPU are '1', '2', '4', and '8'. Setting 4 CPU requires at least 2Gi of memory. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
startupCpuBoost	boolean Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency.

GoogleCloudRunV2Revision

A Revision is an immutable snapshot of code and configuration. A Revision references a container image. Revisions are only created by updates to its parent Service.

Fields
annotations	map (key: string, value: string) Output only. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.
conditions[]	object (GoogleCloudRunV2Condition) Output only. The Condition of this Revision, containing its readiness status, and detailed error information in case it did not reach a serving state.
containers[]	object (GoogleCloudRunV2Container) Holds the single container that defines the unit of execution for this Revision.
createTime	string (Timestamp format) Output only. The creation time.
deleteTime	string (Timestamp format) Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.
encryptionKey	string A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
encryptionKeyRevocationAction	enum The action to take if the encryption key is revoked.
Enum type. Can be one of the following:
ENCRYPTION_KEY_REVOCATION_ACTION_UNSPECIFIED	Unspecified
PREVENT_NEW	Prevents the creation of new instances.
SHUTDOWN	Shuts down existing instances, and prevents creation of new ones.
encryptionKeyShutdownDuration	string (Duration format) If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.
etag	string Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
executionEnvironment	enum The execution environment being used to host this Revision.
Enum type. Can be one of the following:
EXECUTION_ENVIRONMENT_UNSPECIFIED	Unspecified
EXECUTION_ENVIRONMENT_GEN1	Uses the First Generation environment.
EXECUTION_ENVIRONMENT_GEN2	Uses Second Generation environment.
expireTime	string (Timestamp format) Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request.
generation	string (int64 format) Output only. A number that monotonically increases every time the user modifies the desired state.
labels	map (key: string, value: string) Output only. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.
launchStage	enum The least stable launch stage needed to create this resource, as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. Note that this value might not be what was used as input. For example, if ALPHA was provided as input in the parent resource, but only BETA and GA-level features are were, this field will be BETA.
Enum type. Can be one of the following:
LAUNCH_STAGE_UNSPECIFIED	Do not use this default value.
UNIMPLEMENTED	The feature is not yet implemented. Users can not use it.
PRELAUNCH	Prelaunch features are hidden from users and are only visible internally.
EARLY_ACCESS	Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
ALPHA	Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.
BETA	Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
GA	GA features are open to all developers and are considered stable and fully qualified for production use.
DEPRECATED	Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation.
logUri	string Output only. The Google Console URI to obtain logs for the Revision.
maxInstanceRequestConcurrency	integer (int32 format) Sets the maximum number of requests that each serving instance can receive.
name	string Output only. The unique name of this Revision.
nodeSelector	object (GoogleCloudRunV2NodeSelector) The node selector for the revision.
observedGeneration	string (int64 format) Output only. The generation of this Revision currently serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run.
reconciling	boolean Output only. Indicates whether the resource's reconciliation is still in progress. See comments in Service.reconciling for additional information on reconciliation process in Cloud Run.
satisfiesPzs	boolean Output only. Reserved for future use.
scaling	object (GoogleCloudRunV2RevisionScaling) Scaling settings for this revision.
scalingStatus	object (GoogleCloudRunV2RevisionScalingStatus) Output only. The current effective scaling settings for the revision.
service	string Output only. The name of the parent service.
serviceAccount	string Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has.
sessionAffinity	boolean Enable session affinity.
timeout	string (Duration format) Max allowed time for an instance to respond to a request.
uid	string Output only. Server assigned unique identifier for the Revision. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
updateTime	string (Timestamp format) Output only. The last-modified time.
volumes[]	object (GoogleCloudRunV2Volume) A list of Volumes to make available to containers.
vpcAccess	object (GoogleCloudRunV2VpcAccess) VPC Access configuration for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.

GoogleCloudRunV2RevisionScaling

Settings for revision-level scaling settings.

Fields
maxInstanceCount	integer (int32 format) Optional. Maximum number of serving instances that this resource should have.
minInstanceCount	integer (int32 format) Optional. Minimum number of serving instances that this resource should have.

GoogleCloudRunV2RevisionScalingStatus

Effective settings for the current revision

Fields
desiredMinInstanceCount	integer (int32 format) The current number of min instances provisioned for this revision.

GoogleCloudRunV2RevisionTemplate

RevisionTemplate describes the data a revision should have when created from a template.

Fields
annotations	map (key: string, value: string) Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 RevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules.
containers[]	object (GoogleCloudRunV2Container) Holds the single container that defines the unit of execution for this Revision.
encryptionKey	string A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
executionEnvironment	enum Optional. The sandbox environment to host this Revision.
Enum type. Can be one of the following:
EXECUTION_ENVIRONMENT_UNSPECIFIED	Unspecified
EXECUTION_ENVIRONMENT_GEN1	Uses the First Generation environment.
EXECUTION_ENVIRONMENT_GEN2	Uses Second Generation environment.
healthCheckDisabled	boolean Optional. Disables health checking containers during deployment.
labels	map (key: string, value: string) Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 RevisionTemplate.
maxInstanceRequestConcurrency	integer (int32 format) Optional. Sets the maximum number of requests that each serving instance can receive.
nodeSelector	object (GoogleCloudRunV2NodeSelector) Optional. The node selector for the revision template.
revision	string Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name.
scaling	object (GoogleCloudRunV2RevisionScaling) Optional. Scaling settings for this Revision.
serviceAccount	string Optional. Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account.
sessionAffinity	boolean Optional. Enable session affinity.
timeout	string (Duration format) Optional. Max allowed time for an instance to respond to a request.
volumes[]	object (GoogleCloudRunV2Volume) Optional. A list of Volumes to make available to containers.
vpcAccess	object (GoogleCloudRunV2VpcAccess) Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.

GoogleCloudRunV2RunJobRequest

Request message to create a new Execution of a Job.

Fields
etag	string A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
overrides	object (GoogleCloudRunV2Overrides) Overrides specification for a given execution of a job. If provided, overrides will be applied to update the execution or task spec.
validateOnly	boolean Indicates that the request should be validated without actually deleting any resources.

GoogleCloudRunV2SecretKeySelector

SecretEnvVarSource represents a source for the value of an EnvVar.

Fields
secret	string Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project.
version	string The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias.

GoogleCloudRunV2SecretVolumeSource

The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret.

Fields
defaultMode	integer (int32 format) Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set.
items[]	object (GoogleCloudRunV2VersionToPath) If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.
secret	string Required. The name of the secret in Cloud Secret Manager. Format: {secret} if the secret is in the same project. projects/{project}/secrets/{secret} if the secret is in a different project.

GoogleCloudRunV2Service

Service acts as a top-level container that manages a set of configurations and revision templates which implement a network service. Service exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership.

Fields
annotations	map (key: string, value: string) Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 Service. This field follows Kubernetes annotations' namespacing, limits, and rules.
binaryAuthorization	object (GoogleCloudRunV2BinaryAuthorization) Optional. Settings for the Binary Authorization feature.
client	string Arbitrary identifier for the API client.
clientVersion	string Arbitrary version identifier for the API client.
conditions[]	object (GoogleCloudRunV2Condition) Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Service does not reach its Serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.
createTime	string (Timestamp format) Output only. The creation time.
creator	string Output only. Email address of the authenticated creator.
customAudiences[]	string One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.
defaultUriDisabled	boolean Optional. Disables public resolution of the default URI of this service.
deleteTime	string (Timestamp format) Output only. The deletion time.
description	string User-provided description of the Service. This field currently has a 512-character limit.
etag	string Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
expireTime	string (Timestamp format) Output only. For a deleted resource, the time after which it will be permamently deleted.
generation	string (int64 format) Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.
ingress	enum Optional. Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active.
Enum type. Can be one of the following:
INGRESS_TRAFFIC_UNSPECIFIED	Unspecified
INGRESS_TRAFFIC_ALL	All inbound traffic is allowed.
INGRESS_TRAFFIC_INTERNAL_ONLY	Only internal traffic is allowed.
INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER	Both internal and Google Cloud Load Balancer traffic is allowed.
INGRESS_TRAFFIC_NONE	No ingress traffic is allowed.
labels	map (key: string, value: string) Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Service.
lastModifier	string Output only. Email address of the last authenticated modifier.
latestCreatedRevision	string Output only. Name of the last created revision. See comments in reconciling for additional information on reconciliation process in Cloud Run.
latestReadyRevision	string Output only. Name of the latest revision that is serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run.
launchStage	enum Optional. The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.
Enum type. Can be one of the following:
LAUNCH_STAGE_UNSPECIFIED	Do not use this default value.
UNIMPLEMENTED	The feature is not yet implemented. Users can not use it.
PRELAUNCH	Prelaunch features are hidden from users and are only visible internally.
EARLY_ACCESS	Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.
ALPHA	Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.
BETA	Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
GA	GA features are open to all developers and are considered stable and fully qualified for production use.
DEPRECATED	Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation.
name	string The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id}
observedGeneration	string (int64 format) Output only. The generation of this Service currently serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.
reconciling	boolean Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state. When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, observed_generation, latest_ready_revison, traffic_statuses, and uri will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Service, or there was an error, and reconciliation failed. This state can be found in terminal_condition.state. If reconciliation succeeded, the following fields will match: traffic and traffic_statuses, observed_generation and generation, latest_ready_revision and latest_created_revision. If reconciliation failed, traffic_statuses, observed_generation, and latest_ready_revision will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in terminal_condition and conditions.
satisfiesPzs	boolean Output only. Reserved for future use.
scaling	object (GoogleCloudRunV2ServiceScaling) Optional. Specifies service-level scaling settings
template	object (GoogleCloudRunV2RevisionTemplate) Required. The template used to create revisions for this Service.
terminalCondition	object (GoogleCloudRunV2Condition) Output only. The Condition of this Service, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.
traffic[]	object (GoogleCloudRunV2TrafficTarget) Optional. Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest Ready Revision.
trafficStatuses[]	object (GoogleCloudRunV2TrafficTargetStatus) Output only. Detailed status information for corresponding traffic targets. See comments in reconciling for additional information on reconciliation process in Cloud Run.
uid	string Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
updateTime	string (Timestamp format) Output only. The last-modified time.
uri	string Output only. The main URI in which this Service is serving traffic.

GoogleCloudRunV2ServiceScaling

Scaling settings applied at the service level rather than at the revision level.

Fields
minInstanceCount	integer (int32 format) Optional. total min instances for the service. This number of instances is divided among all revisions with specified traffic based on the percent of traffic they are receiving. (BETA)

GoogleCloudRunV2TCPSocketAction

TCPSocketAction describes an action based on opening a socket

Fields
port	integer (int32 format) Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.

GoogleCloudRunV2Task

Task represents a single run of a container to completion.

Fields
annotations	map (key: string, value: string) Output only. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.
completionTime	string (Timestamp format) Output only. Represents time when the Task was completed. It is not guaranteed to be set in happens-before order across separate operations.
conditions[]	object (GoogleCloudRunV2Condition) Output only. The Condition of this Task, containing its readiness status, and detailed error information in case it did not reach the desired state.
containers[]	object (GoogleCloudRunV2Container) Holds the single container that defines the unit of execution for this task.
createTime	string (Timestamp format) Output only. Represents time when the task was created by the system. It is not guaranteed to be set in happens-before order across separate operations.
deleteTime	string (Timestamp format) Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.
encryptionKey	string Output only. A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
etag	string Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
execution	string Output only. The name of the parent Execution.
executionEnvironment	enum The execution environment being used to host this Task.
Enum type. Can be one of the following:
EXECUTION_ENVIRONMENT_UNSPECIFIED	Unspecified
EXECUTION_ENVIRONMENT_GEN1	Uses the First Generation environment.
EXECUTION_ENVIRONMENT_GEN2	Uses Second Generation environment.
expireTime	string (Timestamp format) Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request.
generation	string (int64 format) Output only. A number that monotonically increases every time the user modifies the desired state.
index	integer (int32 format) Output only. Index of the Task, unique per execution, and beginning at 0.
job	string Output only. The name of the parent Job.
labels	map (key: string, value: string) Output only. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels
lastAttemptResult	object (GoogleCloudRunV2TaskAttemptResult) Output only. Result of the last attempt of this Task.
logUri	string Output only. URI where logs for this execution can be found in Cloud Console.
maxRetries	integer (int32 format) Number of retries allowed per Task, before marking this Task failed.
name	string Output only. The unique name of this Task.
observedGeneration	string (int64 format) Output only. The generation of this Task. See comments in Job.reconciling for additional information on reconciliation process in Cloud Run.
reconciling	boolean Output only. Indicates whether the resource's reconciliation is still in progress. See comments in Job.reconciling for additional information on reconciliation process in Cloud Run.
retried	integer (int32 format) Output only. The number of times this Task was retried. Tasks are retried when they fail up to the maxRetries limit.
satisfiesPzs	boolean Output only. Reserved for future use.
scheduledTime	string (Timestamp format) Output only. Represents time when the task was scheduled to run by the system. It is not guaranteed to be set in happens-before order across separate operations.
serviceAccount	string Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account.
startTime	string (Timestamp format) Output only. Represents time when the task started to run. It is not guaranteed to be set in happens-before order across separate operations.
timeout	string (Duration format) Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout.
uid	string Output only. Server assigned unique identifier for the Task. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
updateTime	string (Timestamp format) Output only. The last-modified time.
volumes[]	object (GoogleCloudRunV2Volume) A list of Volumes to make available to containers.
vpcAccess	object (GoogleCloudRunV2VpcAccess) Output only. VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.

GoogleCloudRunV2TaskAttemptResult

Result of a task attempt.

Fields
exitCode	integer (int32 format) Output only. The exit code of this attempt. This may be unset if the container was unable to exit cleanly with a code due to some other failure. See status field for possible failure details.
status	object (GoogleRpcStatus) Output only. The status of this attempt. If the status code is OK, then the attempt succeeded.

GoogleCloudRunV2TaskTemplate

TaskTemplate describes the data a task should have when created from a template.

Fields
containers[]	object (GoogleCloudRunV2Container) Holds the single container that defines the unit of execution for this task.
encryptionKey	string A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
executionEnvironment	enum Optional. The execution environment being used to host this Task.
Enum type. Can be one of the following:
EXECUTION_ENVIRONMENT_UNSPECIFIED	Unspecified
EXECUTION_ENVIRONMENT_GEN1	Uses the First Generation environment.
EXECUTION_ENVIRONMENT_GEN2	Uses Second Generation environment.
maxRetries	integer (int32 format) Number of retries allowed per Task, before marking this Task failed. Defaults to 3.
serviceAccount	string Optional. Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account.
timeout	string (Duration format) Optional. Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. Defaults to 600 seconds.
volumes[]	object (GoogleCloudRunV2Volume) Optional. A list of Volumes to make available to containers.
vpcAccess	object (GoogleCloudRunV2VpcAccess) Optional. VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.

GoogleCloudRunV2TrafficTarget

Holds a single traffic routing entry for the Service. Allocations can be done to a specific Revision name, or pointing to the latest Ready Revision.

Fields
percent	integer (int32 format) Specifies percent of the traffic to this Revision. This defaults to zero if unspecified.
revision	string Revision to which to send this portion of traffic, if traffic allocation is by revision.
tag	string Indicates a string to be part of the URI to exclusively reference this target.
type	enum The allocation type for this traffic target.
Enum type. Can be one of the following:
TRAFFIC_TARGET_ALLOCATION_TYPE_UNSPECIFIED	Unspecified instance allocation type.
TRAFFIC_TARGET_ALLOCATION_TYPE_LATEST	Allocates instances to the Service's latest ready Revision.
TRAFFIC_TARGET_ALLOCATION_TYPE_REVISION	Allocates instances to a Revision by name.

GoogleCloudRunV2TrafficTargetStatus

Represents the observed state of a single TrafficTarget entry.

Fields
percent	integer (int32 format) Specifies percent of the traffic to this Revision.
revision	string Revision to which this traffic is sent.
tag	string Indicates the string used in the URI to exclusively reference this target.
type	enum The allocation type for this traffic target.
Enum type. Can be one of the following:
TRAFFIC_TARGET_ALLOCATION_TYPE_UNSPECIFIED	Unspecified instance allocation type.
TRAFFIC_TARGET_ALLOCATION_TYPE_LATEST	Allocates instances to the Service's latest ready Revision.
TRAFFIC_TARGET_ALLOCATION_TYPE_REVISION	Allocates instances to a Revision by name.
uri	string Displays the target URI.

GoogleCloudRunV2VersionToPath

VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path.

Fields
mode	integer (int32 format) Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
path	string Required. The relative path of the secret in the container.
version	string The Cloud Secret Manager secret version. Can be 'latest' for the latest value, or an integer or a secret alias for a specific version.

GoogleCloudRunV2Volume

Volume represents a named volume in a container.

Fields
cloudSqlInstance	object (GoogleCloudRunV2CloudSqlInstance) For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
emptyDir	object (GoogleCloudRunV2EmptyDirVolumeSource) Ephemeral storage used as a shared volume.
gcs	object (GoogleCloudRunV2GCSVolumeSource) Persistent storage backed by a Google Cloud Storage bucket.
name	string Required. Volume's name.
nfs	object (GoogleCloudRunV2NFSVolumeSource) For NFS Voumes, contains the path to the nfs Volume
secret	object (GoogleCloudRunV2SecretVolumeSource) Secret represents a secret that should populate this volume.

GoogleCloudRunV2VolumeMount

VolumeMount describes a mounting of a Volume within a container.

Fields
mountPath	string Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be /cloudsql. All instances defined in the Volume will be available as /cloudsql/[instance]. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run
name	string Required. This must match the Name of a Volume.

GoogleCloudRunV2VpcAccess

VPC Access settings. For more information on sending traffic to a VPC network, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.

Fields
connector	string VPC Access connector name. Format: projects/{project}/locations/{location}/connectors/{connector}, where {project} can be project id or number. For more information on sending traffic to a VPC network via a connector, visit https://cloud.google.com/run/docs/configuring/vpc-connectors.
egress	enum Optional. Traffic VPC egress settings. If not provided, it defaults to PRIVATE_RANGES_ONLY.
Enum type. Can be one of the following:
VPC_EGRESS_UNSPECIFIED	Unspecified
ALL_TRAFFIC	All outbound traffic is routed through the VPC connector.
PRIVATE_RANGES_ONLY	Only private IP ranges are routed through the VPC connector.
networkInterfaces[]	object (GoogleCloudRunV2NetworkInterface) Optional. Direct VPC egress settings. Currently only single network interface is supported.

GoogleDevtoolsCloudbuildV1ApprovalConfig

ApprovalConfig describes configuration for manual approval of a build.

Fields
approvalRequired	boolean Whether or not approval is needed. If this is set on a build, it will become pending when created, and will need to be explicitly approved to start.

GoogleDevtoolsCloudbuildV1ApprovalResult

ApprovalResult describes the decision and associated metadata of a manual approval of a build.

Fields
approvalTime	string (Timestamp format) Output only. The time when the approval decision was made.
approverAccount	string Output only. Email of the user that called the ApproveBuild API to approve or reject a build at the time that the API was called.
comment	string Optional. An optional comment for this manual approval result.
decision	enum Required. The decision of this manual approval.
Enum type. Can be one of the following:
DECISION_UNSPECIFIED	Default enum type. This should not be used.
APPROVED	Build is approved.
REJECTED	Build is rejected.
url	string Optional. An optional URL tied to this manual approval result. This field is essentially the same as comment, except that it will be rendered by the UI differently. An example use case is a link to an external job that approved this Build.

GoogleDevtoolsCloudbuildV1ArtifactObjects

Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.

Fields
location	string Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see Bucket Name Requirements). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix.
paths[]	string Path globs used to match files in the build's workspace.
timing	object (GoogleDevtoolsCloudbuildV1TimeSpan) Output only. Stores timing information for pushing all artifact objects.

GoogleDevtoolsCloudbuildV1Artifacts

Artifacts produced by a build that should be uploaded upon successful completion of all build steps.

Fields
images[]	string A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE.
mavenArtifacts[]	object (GoogleDevtoolsCloudbuildV1MavenArtifact) A list of Maven artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. Artifacts in the workspace matching specified paths globs will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any artifacts fail to be pushed, the build is marked FAILURE.
npmPackages[]	object (GoogleDevtoolsCloudbuildV1NpmPackage) A list of npm packages to be uploaded to Artifact Registry upon successful completion of all build steps. Npm packages in the specified paths will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any packages fail to be pushed, the build is marked FAILURE.
objects	object (GoogleDevtoolsCloudbuildV1ArtifactObjects) A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE.
pythonPackages[]	object (GoogleDevtoolsCloudbuildV1PythonPackage) A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE.

GoogleDevtoolsCloudbuildV1Build

A build resource in the Cloud Build API. At a high level, a Build describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: the location/region of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.

Fields
approval	object (GoogleDevtoolsCloudbuildV1BuildApproval) Output only. Describes this build's approval configuration, status, and result.
artifacts	object (GoogleDevtoolsCloudbuildV1Artifacts) Artifacts produced by the build that should be uploaded upon successful completion of all build steps.
availableSecrets	object (GoogleDevtoolsCloudbuildV1Secrets) Secrets and secret environment variables.
buildTriggerId	string Output only. The ID of the BuildTrigger that triggered this build, if it was triggered automatically.
createTime	string (Timestamp format) Output only. Time at which the request to create the build was received.
failureInfo	object (GoogleDevtoolsCloudbuildV1FailureInfo) Output only. Contains information about the build when status=FAILURE.
finishTime	string (Timestamp format) Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution.
gitConfig	object (GoogleDevtoolsCloudbuildV1GitConfig) Optional. Configuration for git operations.
id	string Output only. Unique identifier of the build.
images[]	string A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build status is marked FAILURE.
logUrl	string Output only. URL to logs for this build in Google Cloud Console.
logsBucket	string Cloud Storage bucket where logs should be written (see Bucket Name Requirements). Logs file names will be of the format ${logs_bucket}/log-${build_id}.txt.
name	string Output only. The 'Build' name with format: projects/{project}/locations/{location}/builds/{build}, where {build} is a unique identifier generated by the service.
options	object (GoogleDevtoolsCloudbuildV1BuildOptions) Special options for this build.
projectId	string Output only. ID of the project.
queueTtl	string (Duration format) TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be EXPIRED. The TTL starts ticking from create_time.
results	object (GoogleDevtoolsCloudbuildV1Results) Output only. Results of the build.
secrets[]	object (GoogleDevtoolsCloudbuildV1Secret) Secrets to decrypt using Cloud Key Management Service. Note: Secret Manager is the recommended technique for managing sensitive data with Cloud Build. Use available_secrets to configure builds to access secrets from Secret Manager. For instructions, see: https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets
serviceAccount	string IAM service account whose credentials will be used at build runtime. Must be of the format projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. ACCOUNT can be email address or uniqueId of the service account.
source	object (GoogleDevtoolsCloudbuildV1Source) Optional. The location of the source files to build.
sourceProvenance	object (GoogleDevtoolsCloudbuildV1SourceProvenance) Output only. A permanent fixed identifier for source.
startTime	string (Timestamp format) Output only. Time at which execution of the build was started.
status	enum Output only. Status of the build.
Enum type. Can be one of the following:
STATUS_UNKNOWN	Status of the build is unknown.
PENDING	Build has been created and is pending execution and queuing. It has not been queued.
QUEUED	Build or step is queued; work has not yet begun.
WORKING	Build or step is being executed.
SUCCESS	Build or step finished successfully.
FAILURE	Build or step failed to complete successfully.
INTERNAL_ERROR	Build or step failed due to an internal cause.
TIMEOUT	Build or step took longer than was allowed.
CANCELLED	Build or step was canceled by a user.
EXPIRED	Build was enqueued for longer than the value of queue_ttl.
statusDetail	string Output only. Customer-readable message about the current status.
steps[]	object (GoogleDevtoolsCloudbuildV1BuildStep) Required. The operations to be performed on the workspace.
substitutions	map (key: string, value: string) Substitutions data for Build resource.
tags[]	string Tags for annotation of a Build. These are not docker tags.
timeout	string (Duration format) Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be TIMEOUT. timeout starts ticking from startTime. Default time is 60 minutes.
timing	map (key: string, value: object (GoogleDevtoolsCloudbuildV1TimeSpan)) Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps. * PUSH: time to push all artifacts including docker images and non docker artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time to set up build. If the build does not specify source or images, these keys will not be included.
warnings[]	object (GoogleDevtoolsCloudbuildV1Warning) Output only. Non-fatal problems encountered during the execution of the build.

GoogleDevtoolsCloudbuildV1BuildApproval

BuildApproval describes a build's approval configuration, state, and result.

Fields
config	object (GoogleDevtoolsCloudbuildV1ApprovalConfig) Output only. Configuration for manual approval of this build.
result	object (GoogleDevtoolsCloudbuildV1ApprovalResult) Output only. Result of manual approval for this Build.
state	enum Output only. The state of this build's approval.
Enum type. Can be one of the following:
STATE_UNSPECIFIED	Default enum type. This should not be used.
PENDING	Build approval is pending.
APPROVED	Build approval has been approved.
REJECTED	Build approval has been rejected.
CANCELLED	Build was cancelled while it was still pending approval.

GoogleDevtoolsCloudbuildV1BuildOperationMetadata

Metadata for build operations.

Fields
build	object (GoogleDevtoolsCloudbuildV1Build) The build that the operation is tracking.

GoogleDevtoolsCloudbuildV1BuildOptions

Optional arguments to enable specific features of builds.

Fields
automapSubstitutions	boolean Option to include built-in and custom substitutions as env variables for all build steps.
defaultLogsBucketBehavior	enum Optional. Option to specify how default logs buckets are setup.
Enum type. Can be one of the following:
DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED	Unspecified.
REGIONAL_USER_OWNED_BUCKET	Bucket is located in user-owned project in the same region as the build. The builder service account must have access to create and write to Cloud Storage buckets in the build project.
diskSizeGb	string (int64 format) Requested disk size for the VM that runs the build. Note that this is NOT "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 4000GB; builds that request more than the maximum are rejected with an error.
dynamicSubstitutions	boolean Option to specify whether or not to apply bash style string operations to the substitutions. NOTE: this is always enabled for triggered builds and cannot be overridden in the build configuration file.
env[]	string A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".
logStreamingOption	enum Option to define build log streaming behavior to Cloud Storage.
Enum type. Can be one of the following:
STREAM_DEFAULT	Service may automatically determine build log streaming behavior.
STREAM_ON	Build logs should be streamed to Cloud Storage.
STREAM_OFF	Build logs should not be streamed to Cloud Storage; they will be written when the build is completed.
logging	enum Option to specify the logging mode, which determines if and where build logs are stored.
Enum type. Can be one of the following:
LOGGING_UNSPECIFIED	The service determines the logging mode. The default is LEGACY. Do not rely on the default logging behavior as it may change in the future.
LEGACY	Build logs are stored in Cloud Logging and Cloud Storage.
GCS_ONLY	Build logs are stored in Cloud Storage.
STACKDRIVER_ONLY	This option is the same as CLOUD_LOGGING_ONLY.
CLOUD_LOGGING_ONLY	Build logs are stored in Cloud Logging. Selecting this option will not allow logs streaming.
NONE	Turn off all logging. No build logs will be captured.
machineType	enum Compute Engine machine type on which to run the build.
Enum type. Can be one of the following:
UNSPECIFIED	Standard machine type.
N1_HIGHCPU_8	Highcpu machine with 8 CPUs.
N1_HIGHCPU_32	Highcpu machine with 32 CPUs.
E2_HIGHCPU_8	Highcpu e2 machine with 8 CPUs.
E2_HIGHCPU_32	Highcpu e2 machine with 32 CPUs.
E2_MEDIUM	E2 machine with 1 CPU.
pool	object (GoogleDevtoolsCloudbuildV1PoolOption) Optional. Specification for execution on a WorkerPool. See running builds in a private pool for more information.
requestedVerifyOption	enum Requested verifiability options.
Enum type. Can be one of the following:
NOT_VERIFIED	Not a verifiable build (the default).
VERIFIED	Build must be verified.
secretEnv[]	string A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret. These variables will be available to all build steps in this build.
sourceProvenanceHash[]	string Requested hash for SourceProvenance.
substitutionOption	enum Option to specify behavior when there is an error in the substitution checks. NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be overridden in the build configuration file.
Enum type. Can be one of the following:
MUST_MATCH	Fails the build if error in substitutions checks, like missing a substitution in the template or in the map.
ALLOW_LOOSE	Do not fail the build if error in substitutions checks.
volumes[]	object (GoogleDevtoolsCloudbuildV1Volume) Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration.
workerPool	string This field deprecated; please use pool.name instead.

GoogleDevtoolsCloudbuildV1BuildStep

A step in the build pipeline.

Fields
allowExitCodes[]	integer (int32 format) Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take precedence.
allowFailure	boolean Allow this build step to fail without failing the entire build. If false, the entire build will fail if this step fails. Otherwise, the build will succeed, but this step will still have a failure status. Error information will be reported in the failure_detail field.
args[]	string A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the args are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.
automapSubstitutions	boolean Option to include built-in and custom substitutions as env variables for this build step. This option will override the global option in BuildOption.
dir	string Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a volume for that path is specified. If the build specifies a RepoSource with dir and a step with a dir, which specifies an absolute path, the RepoSource dir is ignored for the step's execution.
entrypoint	string Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.
env[]	string A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".
exitCode	integer (int32 format) Output only. Return code from running the step.
id	string Unique identifier for this build step, used in wait_for to reference this build step as a dependency.
name	string Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.
pullTiming	object (GoogleDevtoolsCloudbuildV1TimeSpan) Output only. Stores timing information for pulling this build step's builder image only.
script	string A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.
secretEnv[]	string A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret.
status	enum Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.
Enum type. Can be one of the following:
STATUS_UNKNOWN	Status of the build is unknown.
PENDING	Build has been created and is pending execution and queuing. It has not been queued.
QUEUED	Build or step is queued; work has not yet begun.
WORKING	Build or step is being executed.
SUCCESS	Build or step finished successfully.
FAILURE	Build or step failed to complete successfully.
INTERNAL_ERROR	Build or step failed due to an internal cause.
TIMEOUT	Build or step took longer than was allowed.
CANCELLED	Build or step was canceled by a user.
EXPIRED	Build was enqueued for longer than the value of queue_ttl.
timeout	string (Duration format) Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.
timing	object (GoogleDevtoolsCloudbuildV1TimeSpan) Output only. Stores timing information for executing this build step.
volumes[]	object (GoogleDevtoolsCloudbuildV1Volume) List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration.
waitFor[]	string The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in wait_for have completed successfully. If wait_for is empty, this build step will start when all previous build steps in the Build.Steps list have completed successfully.

GoogleDevtoolsCloudbuildV1BuiltImage

An image built by the pipeline.

Fields
digest	string Docker Registry 2.0 digest.
name	string Name used to push the container image to Google Container Registry, as presented to docker push.
pushTiming	object (GoogleDevtoolsCloudbuildV1TimeSpan) Output only. Stores timing information for pushing the specified image.

GoogleDevtoolsCloudbuildV1ConnectedRepository

Location of the source in a 2nd-gen Google Cloud Build repository resource.

Fields
dir	string Optional. Directory, relative to the source root, in which to run the build.
repository	string Required. Name of the Google Cloud Build repository, formatted as projects/*/locations/*/connections/*/repositories/*.
revision	string Required. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.

GoogleDevtoolsCloudbuildV1DeveloperConnectConfig

This config defines the location of a source through Developer Connect.

Fields
dir	string Required. Directory, relative to the source root, in which to run the build.
gitRepositoryLink	string Required. The Developer Connect Git repository link, formatted as projects/*/locations/*/connections/*/gitRepositoryLink/*.
revision	string Required. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.

GoogleDevtoolsCloudbuildV1FailureInfo

A fatal problem encountered during the execution of the build.

Fields
detail	string Explains the failure issue in more detail using hard-coded text.
type	enum The name of the failure.
Enum type. Can be one of the following:
FAILURE_TYPE_UNSPECIFIED	Type unspecified
PUSH_FAILED	Unable to push the image to the repository.
PUSH_IMAGE_NOT_FOUND	Final image not found.
PUSH_NOT_AUTHORIZED	Unauthorized push of the final image.
LOGGING_FAILURE	Backend logging failures. Should retry.
USER_BUILD_STEP	A build step has failed.
FETCH_SOURCE_FAILED	The source fetching has failed.

GoogleDevtoolsCloudbuildV1FileHashes

Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.

Fields
fileHash[]	object (GoogleDevtoolsCloudbuildV1Hash) Collection of file hashes.

GoogleDevtoolsCloudbuildV1GCSLocation

Represents a storage location in Cloud Storage

Fields
bucket	string Cloud Storage bucket. See https://cloud.google.com/storage/docs/naming#requirements
generation	string (int64 format) Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
object	string Cloud Storage object. See https://cloud.google.com/storage/docs/naming#objectnames

GoogleDevtoolsCloudbuildV1GitConfig

GitConfig is a configuration for git operations.

Fields
http	object (GoogleDevtoolsCloudbuildV1HttpConfig) Configuration for HTTP related git operations.

GoogleDevtoolsCloudbuildV1GitSource

Location of the source in any accessible Git repository.

Fields
dir	string Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's dir is specified and is an absolute path, this value is ignored for that step's execution.
revision	string Optional. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref. Cloud Build uses git fetch to fetch the revision from the Git repository; therefore make sure that the string you provide for revision is parsable by the command. For information on string values accepted by git fetch, see https://git-scm.com/docs/gitrevisions#_specifying_revisions. For information on git fetch, see https://git-scm.com/docs/git-fetch.
url	string Required. Location of the Git repo to build. This will be used as a git remote, see https://git-scm.com/docs/git-remote.

GoogleDevtoolsCloudbuildV1Hash

Container message for hash values.

Fields
type	enum The type of hash that was performed.
Enum type. Can be one of the following:
NONE	No hash requested.
SHA256	Use a sha256 hash.
MD5	Use a md5 hash.
SHA512	Use a sha512 hash.
value	string (bytes format) The hash value.

GoogleDevtoolsCloudbuildV1HttpConfig

HttpConfig is a configuration for HTTP related git operations.

Fields
proxySecretVersionName	string SecretVersion resource of the HTTP proxy URL. The proxy URL should be in format protocol://@]proxyhost[:port].
proxySslCaInfo	object (GoogleDevtoolsCloudbuildV1GCSLocation) Optional. Cloud Storage object storing the certificate to use with the HTTP proxy.

GoogleDevtoolsCloudbuildV1InlineSecret

Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.

Fields
envMap	map (key: string, value: string (bytes format)) Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.
kmsKeyName	string Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects//locations//keyRings//cryptoKeys/

GoogleDevtoolsCloudbuildV1MavenArtifact

A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.

Fields
artifactId	string Maven artifactId value used when uploading the artifact to Artifact Registry.
groupId	string Maven groupId value used when uploading the artifact to Artifact Registry.
path	string Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar.
repository	string Artifact Registry repository, in the form "https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY" Artifact in the workspace specified by path will be uploaded to Artifact Registry with this location as a prefix.
version	string Maven version value used when uploading the artifact to Artifact Registry.

GoogleDevtoolsCloudbuildV1NpmPackage

Npm package to upload to Artifact Registry upon successful completion of all build steps.

Fields
packagePath	string Path to the package.json. e.g. workspace/path/to/package
repository	string Artifact Registry repository, in the form "https://$REGION-npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified by path will be zipped and uploaded to Artifact Registry with this location as a prefix.

GoogleDevtoolsCloudbuildV1PoolOption

Details about how a build should be executed on a WorkerPool. See running builds in a private pool for more information.

Fields
name	string The WorkerPool resource to execute the build on. You must have cloudbuild.workerpools.use on the project hosting the WorkerPool. Format projects/{project}/locations/{location}/workerPools/{workerPoolId}

GoogleDevtoolsCloudbuildV1PythonPackage

Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository.

Fields
paths[]	string Path globs used to match files in the build's workspace. For Python/ Twine, this is usually dist/*, and sometimes additionally an .asc file.
repository	string Artifact Registry repository, in the form "https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY" Files in the workspace matching any path pattern will be uploaded to Artifact Registry with this location as a prefix.

GoogleDevtoolsCloudbuildV1RepoSource

Location of the source in a Google Cloud Source Repository.

Fields
branchName	string Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
commitSha	string Explicit commit SHA to build.
dir	string Optional. Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's dir is specified and is an absolute path, this value is ignored for that step's execution.
invertRegex	boolean Optional. Only trigger a build if the revision regex does NOT match the revision regex.
projectId	string Optional. ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
repoName	string Required. Name of the Cloud Source Repository.
substitutions	map (key: string, value: string) Optional. Substitutions to use in a triggered build. Should only be used with RunBuildTrigger
tagName	string Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax

GoogleDevtoolsCloudbuildV1Results

Artifacts created by the build pipeline.

Fields
artifactManifest	string Path to the artifact manifest for non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage.
artifactTiming	object (GoogleDevtoolsCloudbuildV1TimeSpan) Time to push all non-container artifacts to Cloud Storage.
buildStepImages[]	string List of build step digests, in the order corresponding to build step indices.
buildStepOutputs[]	string (bytes format) List of build step outputs, produced by builder images, in the order corresponding to build step indices. Cloud Builders can produce this output by writing to $BUILDER_OUTPUT/output. Only the first 50KB of data is stored. Note that the $BUILDER_OUTPUT variable is read-only and can't be substituted.
images[]	object (GoogleDevtoolsCloudbuildV1BuiltImage) Container images that were built as a part of the build.
mavenArtifacts[]	object (GoogleDevtoolsCloudbuildV1UploadedMavenArtifact) Maven artifacts uploaded to Artifact Registry at the end of the build.
npmPackages[]	object (GoogleDevtoolsCloudbuildV1UploadedNpmPackage) Npm packages uploaded to Artifact Registry at the end of the build.
numArtifacts	string (int64 format) Number of non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage.
pythonPackages[]	object (GoogleDevtoolsCloudbuildV1UploadedPythonPackage) Python artifacts uploaded to Artifact Registry at the end of the build.

GoogleDevtoolsCloudbuildV1Secret

Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. Note: Use kmsKeyName with available_secrets instead of using kmsKeyName with secret. For instructions see: https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials.

Fields
kmsKeyName	string Cloud KMS key name to use to decrypt these envs.
secretEnv	map (key: string, value: string (bytes format)) Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.

GoogleDevtoolsCloudbuildV1SecretManagerSecret

Pairs a secret environment variable with a SecretVersion in Secret Manager.

Fields
env	string Environment variable name to associate with the secret. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step.
versionName	string Resource name of the SecretVersion. In format: projects//secrets//versions/*

GoogleDevtoolsCloudbuildV1Secrets

Secrets and secret environment variables.

Fields
inline[]	object (GoogleDevtoolsCloudbuildV1InlineSecret) Secrets encrypted with KMS key and the associated secret environment variable.
secretManager[]	object (GoogleDevtoolsCloudbuildV1SecretManagerSecret) Secrets in Secret Manager and associated secret environment variable.

GoogleDevtoolsCloudbuildV1Source

Location of the source in a supported storage service.

Fields
connectedRepository	object (GoogleDevtoolsCloudbuildV1ConnectedRepository) Optional. If provided, get the source from this 2nd-gen Google Cloud Build repository resource.
developerConnectConfig	object (GoogleDevtoolsCloudbuildV1DeveloperConnectConfig) If provided, get the source from this Developer Connect config.
gitSource	object (GoogleDevtoolsCloudbuildV1GitSource) If provided, get the source from this Git repository.
repoSource	object (GoogleDevtoolsCloudbuildV1RepoSource) If provided, get the source from this location in a Cloud Source Repository.
storageSource	object (GoogleDevtoolsCloudbuildV1StorageSource) If provided, get the source from this location in Cloud Storage.
storageSourceManifest	object (GoogleDevtoolsCloudbuildV1StorageSourceManifest) If provided, get the source from this manifest in Cloud Storage. This feature is in Preview; see description here.

GoogleDevtoolsCloudbuildV1SourceProvenance

Provenance of the source. Ways to find the original source, or verify that some source was used for this build.

Fields
fileHashes	map (key: string, value: object (GoogleDevtoolsCloudbuildV1FileHashes)) Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that FileHashes will only be populated if BuildOptions has requested a SourceProvenanceHash. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file.
resolvedConnectedRepository	object (GoogleDevtoolsCloudbuildV1ConnectedRepository) Output only. A copy of the build's source.connected_repository, if exists, with any revisions resolved.
resolvedGitSource	object (GoogleDevtoolsCloudbuildV1GitSource) Output only. A copy of the build's source.git_source, if exists, with any revisions resolved.
resolvedRepoSource	object (GoogleDevtoolsCloudbuildV1RepoSource) A copy of the build's source.repo_source, if exists, with any revisions resolved.
resolvedStorageSource	object (GoogleDevtoolsCloudbuildV1StorageSource) A copy of the build's source.storage_source, if exists, with any generations resolved.
resolvedStorageSourceManifest	object (GoogleDevtoolsCloudbuildV1StorageSourceManifest) A copy of the build's source.storage_source_manifest, if exists, with any revisions resolved. This feature is in Preview.

GoogleDevtoolsCloudbuildV1StorageSource

Location of the source in an archive file in Cloud Storage.

Fields
bucket	string Cloud Storage bucket containing the source (see Bucket Name Requirements).
generation	string (int64 format) Optional. Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
object	string Required. Cloud Storage object containing the source. This object must be a zipped (.zip) or gzipped archive file (.tar.gz) containing source to build.
sourceFetcher	enum Optional. Option to specify the tool to fetch the source file for the build.
Enum type. Can be one of the following:
SOURCE_FETCHER_UNSPECIFIED	Unspecified defaults to GSUTIL.
GSUTIL	Use the "gsutil" tool to download the source file.
GCS_FETCHER	Use the Cloud Storage Fetcher tool to download the source file.

GoogleDevtoolsCloudbuildV1StorageSourceManifest

Location of the source manifest in Cloud Storage. This feature is in Preview; see description here.

Fields
bucket	string Required. Cloud Storage bucket containing the source manifest (see Bucket Name Requirements).
generation	string (int64 format) Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
object	string Required. Cloud Storage object containing the source manifest. This object must be a JSON file.

GoogleDevtoolsCloudbuildV1TimeSpan

Start and end times for a build execution phase.

Fields
endTime	string (Timestamp format) End of time span.
startTime	string (Timestamp format) Start of time span.

GoogleDevtoolsCloudbuildV1UploadedMavenArtifact

A Maven artifact uploaded using the MavenArtifact directive.

Fields
fileHashes	object (GoogleDevtoolsCloudbuildV1FileHashes) Hash types and values of the Maven Artifact.
pushTiming	object (GoogleDevtoolsCloudbuildV1TimeSpan) Output only. Stores timing information for pushing the specified artifact.
uri	string URI of the uploaded artifact.

GoogleDevtoolsCloudbuildV1UploadedNpmPackage

An npm package uploaded to Artifact Registry using the NpmPackage directive.

Fields
fileHashes	object (GoogleDevtoolsCloudbuildV1FileHashes) Hash types and values of the npm package.
pushTiming	object (GoogleDevtoolsCloudbuildV1TimeSpan) Output only. Stores timing information for pushing the specified artifact.
uri	string URI of the uploaded npm package.

GoogleDevtoolsCloudbuildV1UploadedPythonPackage

Artifact uploaded using the PythonPackage directive.

Fields
fileHashes	object (GoogleDevtoolsCloudbuildV1FileHashes) Hash types and values of the Python Artifact.
pushTiming	object (GoogleDevtoolsCloudbuildV1TimeSpan) Output only. Stores timing information for pushing the specified artifact.
uri	string URI of the uploaded artifact.

GoogleDevtoolsCloudbuildV1Volume

Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.

Fields
name	string Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
path	string Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.

GoogleDevtoolsCloudbuildV1Warning

A non-fatal problem encountered during the execution of the build.

Fields
priority	enum The priority for this warning.
Enum type. Can be one of the following:
PRIORITY_UNSPECIFIED	Should not be used.
INFO	e.g. deprecation warnings and alternative feature highlights.
WARNING	e.g. automated detection of possible issues with the build.
ALERT	e.g. alerts that a feature used in the build is pending removal
text	string Explanation of the warning generated.

GoogleIamV1AuditConfig

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:[e-mail]" ] }, { "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:[e-mail]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [e-mail] from DATA_READ logging, and [e-mail] from DATA_WRITE logging.

Fields
auditLogConfigs[]	object (GoogleIamV1AuditLogConfig) The configuration for logging of each type of permission.
service	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.

GoogleIamV1AuditLogConfig

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[e-mail]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [e-mail] from DATA_READ logging.

Fields
exemptedMembers[]	string Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
logType	enum The log type that this config enables.
Enum type. Can be one of the following:
LOG_TYPE_UNSPECIFIED	Default case. Should never be this.
ADMIN_READ	Admin reads. Example: CloudIAM getIamPolicy
DATA_WRITE	Data writes. Example: CloudSQL Users create
DATA_READ	Data reads. Example: CloudSQL Users list

GoogleIamV1Binding

Associates members, or principals, with a role.

Fields
condition	object (GoogleTypeExpr) 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.
members[]	string 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, [e-mail] . * serviceAccount:{emailid}: An email address that represents a Google service account. For example, [e-mail]. * serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account. For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. * group:{emailid}: An email address that represents a Google group. For example, [e-mail]. * 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, [e-mail]?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, [e-mail]?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, [e-mail]?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.
role	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. For a list of the available pre-defined roles, see here.

GoogleIamV1Policy

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. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[e-mail]", "group:[e-mail]", "domain:google.com", "serviceAccount:[e-mail]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[e-mail]" ], "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:[e-mail] - group:[e-mail] - domain:google.com - serviceAccount:[e-mail] role: roles/resourcemanager.organizationAdmin - members: - user:[e-mail] 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.

Fields
auditConfigs[]	object (GoogleIamV1AuditConfig) Specifies cloud audit logging configuration for this policy.
bindings[]	object (GoogleIamV1Binding) 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:[e-mail], and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
etag	string (bytes format) 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	integer (int32 format) 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.

GoogleIamV1SetIamPolicyRequest

Request message for SetIamPolicy method.

Fields
policy	object (GoogleIamV1Policy) 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 Google Cloud services (such as Projects) might reject them.
updateMask	string (FieldMask format) 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"

GoogleIamV1TestIamPermissionsRequest

Request message for TestIamPermissions method.

Fields
permissions[]	string The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview.

GoogleIamV1TestIamPermissionsResponse

Response message for TestIamPermissions method.

Fields
permissions[]	string A subset of TestPermissionsRequest.permissions that the caller is allowed.

GoogleLongrunningListOperationsResponse

The response message for Operations.ListOperations.

Fields
nextPageToken	string The standard List next-page token.
operations[]	object (GoogleLongrunningOperation) A list of operations that matches the specified filter in the request.

GoogleLongrunningOperation

This resource represents a long-running operation that is the result of a network API call.

Fields
done	boolean 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	object (GoogleRpcStatus) The error result of the operation in case of failure or cancellation.
metadata	map (key: string, value: any) 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 long-running operation should document the metadata type, if any.
name	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}.
response	map (key: string, value: any) The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

GoogleLongrunningWaitOperationRequest

The request message for Operations.WaitOperation.

Fields
timeout	string (Duration format) The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

GoogleRpcStatus

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by 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.

Fields
code	integer (int32 format) The status code, which should be an enum value of google.rpc.Code.
details[]	object A list of messages that carry the error details. There is a common set of message types for APIs to use.
message	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.

GoogleTypeExpr

Represents a textual expression in the Common Expression Language (CEL) 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.

Fields
description	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	string Textual representation of an expression in Common Expression Language syntax.
location	string Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
title	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.

UtilStatusProto

Wire-format for a Status object

Fields
canonicalCode	integer (int32 format) The canonical error code (see codes.proto) that most closely corresponds to this status. This may be missing, and in the common case of the generic space, it definitely will be.
code	integer (int32 format) Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto
message	string Detail message
messageSet	object (Proto2BridgeMessageSet) message_set associates an arbitrary proto message with the status.
space	string The following are usually only present when code != 0 Space to which this status belongs