Types overview

Addressable

Information for connecting over HTTP(s).

Fields
url	string (No description provided)

AuditConfig

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 (AuditLogConfig) 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.

AuditLogConfig

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

AuthorizedDomain

A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Search Console.

Fields
id	string Relative name of the domain authorized for use. Example: example.com.
name	string Deprecated Read only. Full path to the AuthorizedDomain resource in the API. Example: projects/myproject/authorizedDomains/example.com.

Binding

Associates members, or principals, with a role.

Fields
condition	object (Expr) 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. * 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.
role	string Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.

ConfigMapEnvSource

Not supported by Cloud Run. ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.

Fields
localObjectReference	object (LocalObjectReference) This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead.
name	string The ConfigMap to select from.
optional	boolean Specify whether the ConfigMap must be defined.

ConfigMapKeySelector

Not supported by Cloud Run.

Fields
key	string Required. Not supported by Cloud Run.
localObjectReference	object (LocalObjectReference) Not supported by Cloud Run.
name	string Required. Not supported by Cloud Run.
optional	boolean Not supported by Cloud Run.

ConfigMapVolumeSource

Not supported by Cloud Run. Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths.

Fields
defaultMode	integer (int32 format) (Optional) Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. 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.
items[]	object (KeyToPath) (Optional) If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional.
name	string Name of the config.
optional	boolean (Optional) Specify whether the Secret or its keys must be defined.

Configuration

Configuration represents the "floating HEAD" of a linear history of Revisions, and optionally how the containers those revisions reference are built. Users create new Revisions by updating the Configuration's spec. The "latest created" revision's name is available under status, as is the "latest ready" revision's name.

Fields
apiVersion	string The API version for this call such as "serving.knative.dev/v1".
kind	string The kind of resource, in this case always "Configuration".
metadata	object (ObjectMeta) Metadata associated with this Configuration, including name, namespace, labels, and annotations.
spec	object (ConfigurationSpec) Spec holds the desired state of the Configuration (from the client).
status	object (ConfigurationStatus) Status communicates the observed state of the Configuration (from the controller).

ConfigurationSpec

ConfigurationSpec holds the desired state of the Configuration (from the client).

Fields
template	object (RevisionTemplate) Template holds the latest specification for the Revision to be stamped out.

ConfigurationStatus

ConfigurationStatus communicates the observed state of the Configuration (from the controller).

Fields
conditions[]	object (GoogleCloudRunV1Condition) Conditions communicate information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world.
latestCreatedRevisionName	string LatestCreatedRevisionName is the last revision that was created from this Configuration. It might not be ready yet, so for the latest ready revision, use LatestReadyRevisionName.
latestReadyRevisionName	string LatestReadyRevisionName holds the name of the latest Revision stamped out from this Configuration that has had its "Ready" condition become "True".
observedGeneration	integer (int32 format) ObservedGeneration is the 'Generation' of the Configuration that was last processed by the controller. The observed generation is updated even if the controller failed to process the spec and create the Revision. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation, and the Ready condition's status is True or False.

Container

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 may 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. Variable references are not supported in Cloud Run.
command[]	string Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
env[]	object (EnvVar) List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
envFrom[]	object (EnvFromSource) Not supported by Cloud Run.
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.
imagePullPolicy	string Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
livenessProbe	object (Probe) 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 (ContainerPort) 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.
readinessProbe	object (Probe) Not supported by Cloud Run.
resources	object (ResourceRequirements) Compute Resources required by this container.
securityContext	object (SecurityContext) Not supported by Cloud Run.
startupProbe	object (Probe) Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not receive traffic if the probe fails. If not provided, a default startup probe with TCP socket action is used.
terminationMessagePath	string Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log.
terminationMessagePolicy	string Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
volumeMounts[]	object (VolumeMount) Volume to mount into the container's filesystem. Only supports SecretVolumeSources. Pod volumes 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.

ContainerOverride

Per container override specification.

Fields
args[]	string Arguments to the entrypoint. The specified arguments replace and override any existing entrypoint arguments. Must be empty if clear_args is set to true.
clearArgs	boolean Optional. Set to True to clear all existing arguments.
env[]	object (EnvVar) List of environment variables to set in the container. All specified environment variables are merged with existing environment variables. When the specified environment variables exist, these values override any existing values.
name	string The name of the container specified as a DNS_LABEL.

ContainerPort

ContainerPort represents a network port in a single container.

Fields
containerPort	integer (int32 format) Port number the container listens on. If present, this must be a valid port number, 0 < x < 65536. If not present, it will default to port 8080. For more information, see https://cloud.google.com/run/docs/container-contract#port
name	string If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c".
protocol	string Protocol for port. Must be "TCP". Defaults to "TCP".

DomainMapping

Resource to hold the state and status of a user's domain mapping. NOTE: This resource is currently in Beta.

Fields
apiVersion	string The API version for this call such as "domains.cloudrun.com/v1".
kind	string The kind of resource, in this case "DomainMapping".
metadata	object (ObjectMeta) Metadata associated with this BuildTemplate.
spec	object (DomainMappingSpec) The spec for this DomainMapping.
status	object (DomainMappingStatus) The current status of the DomainMapping.

DomainMappingSpec

The desired state of the Domain Mapping.

Fields
certificateMode	enum The mode of the certificate.
Enum type. Can be one of the following:
CERTIFICATE_MODE_UNSPECIFIED	(No description provided)
NONE	Do not provision an HTTPS certificate.
AUTOMATIC	Automatically provisions an HTTPS certificate via GoogleCA.
forceOverride	boolean If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning.
routeName	string The name of the Knative Route that this DomainMapping applies to. The route must exist.

DomainMappingStatus

The current state of the Domain Mapping.

Fields
conditions[]	object (GoogleCloudRunV1Condition) Array of observed DomainMappingConditions, indicating the current state of the DomainMapping.
mappedRouteName	string The name of the route that the mapping currently points to.
observedGeneration	integer (int32 format) ObservedGeneration is the 'Generation' of the DomainMapping that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False.
resourceRecords[]	object (ResourceRecord) The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.
url	string Optional. Not supported by Cloud Run.

EmptyDirVolumeSource

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	string The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
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

EnvFromSource

Not supported by Cloud Run. EnvFromSource represents the source of a set of ConfigMaps

Fields
configMapRef	object (ConfigMapEnvSource) The ConfigMap to select from
prefix	string An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
secretRef	object (SecretEnvSource) The Secret to select from

EnvVar

EnvVar represents an environment variable present in a Container.

Fields
name	string Required. Name of the environment variable. Must be a C_IDENTIFIER.
value	string Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
valueFrom	object (EnvVarSource) Source for the environment variable's value. Only supports secret_key_ref. Cannot be used if value is not empty.

EnvVarSource

EnvVarSource represents a source for the value of an EnvVar.

Fields
configMapKeyRef	object (ConfigMapKeySelector) Not supported by Cloud Run. Not supported in Cloud Run.
secretKeyRef	object (SecretKeySelector) Selects a key (version) of a secret in Secret Manager.

ExecAction

Not supported by Cloud Run. ExecAction describes a "run in container" action.

Fields

command[]

string Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

Execution

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

Fields
apiVersion	string Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.
kind	string Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase.
metadata	object (ObjectMeta) Optional. Standard object's metadata.
spec	object (ExecutionSpec) Optional. Specification of the desired behavior of an execution.
status	object (ExecutionStatus) Output only. Current status of an execution.

ExecutionReference

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

Fields
completionTimestamp	string (Timestamp format) Optional. Completion timestamp of the execution.
creationTimestamp	string (Timestamp format) Optional. Creation timestamp of the execution.
name	string Optional. Name of the execution.

ExecutionSpec

ExecutionSpec describes how the execution will look.

Fields
parallelism	integer (int32 format) Optional. 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, i.e. when the work left to do is less than max parallelism.
taskCount	integer (int32 format) Optional. 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 (TaskTemplateSpec) Optional. The template used to create tasks for this execution.

ExecutionStatus

ExecutionStatus represents the current state of an Execution.

Fields
cancelledCount	integer (int32 format) Optional. The number of tasks which reached phase Cancelled.
completionTime	string (Timestamp format) Optional. Represents the time that the execution was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. +optional
conditions[]	object (GoogleCloudRunV1Condition) Optional. Conditions communicate information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. Execution-specific conditions include: * ResourcesAvailable: True when underlying resources have been provisioned. * Started: True when the execution has started to execute. * Completed: True when the execution has succeeded. False when the execution has failed.
failedCount	integer (int32 format) Optional. The number of tasks which reached phase Failed.
logUri	string Optional. URI where logs for this execution can be found in Cloud Console.
observedGeneration	integer (int32 format) Optional. The 'generation' of the execution that was last processed by the controller.
retriedCount	integer (int32 format) Optional. The number of tasks which have retried at least once.
runningCount	integer (int32 format) Optional. The number of actively running tasks.
startTime	string (Timestamp format) Optional. Represents the time that the execution started to run. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
succeededCount	integer (int32 format) Optional. The number of tasks which reached phase Succeeded.

ExecutionTemplateSpec

ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job.

Fields
metadata	object (ObjectMeta) Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution: * run.googleapis.com/cloudsql-instances sets Cloud SQL connections. Multiple values should be comma separated. * run.googleapis.com/vpc-access-connector sets a Serverless VPC Access connector. * run.googleapis.com/vpc-access-egress sets VPC egress. Supported values are all-traffic, all (deprecated), and private-ranges-only. all-traffic and all provide the same functionality. all is deprecated but will continue to be supported. Prefer all-traffic.
spec	object (ExecutionSpec) Required. ExecutionSpec holds the desired configuration for executions of this job.

Expr

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.

GRPCAction

GRPCAction describes an action involving a GRPC port.

Fields
port	integer (int32 format) Port number of the gRPC service. Number must be in the range 1 to 65535.
service	string Service is the name of the service to place in the gRPC HealthCheckRequest. If this is not specified, the default behavior is defined by gRPC.

GoogleCloudRunV1Condition

Conditions show the status of reconciliation progress on a given resource. Most resource use a top-level condition type "Ready" or "Completed" to show overall status with other conditions to checkpoint each stage of reconciliation. Note that if metadata.Generation does not equal status.ObservedGeneration, the conditions shown may not be relevant for the current spec.

Fields
lastTransitionTime	string (Timestamp format) Optional. Last time the condition transitioned from one status to another.
message	string Optional. Human readable message indicating details about the current status.
reason	string Optional. One-word CamelCase reason for the condition's last transition. These are intended to be stable, unique values which the client may use to trigger error handling logic, whereas messages which may be changed later by the server.
severity	string Optional. How to interpret this condition. One of Error, Warning, or Info. Conditions of severity Info do not contribute to resource readiness.
status	string Status of the condition, one of True, False, Unknown.
type	string type is used to communicate the status of the reconciliation process. Types common to all resources include: * "Ready" or "Completed": True when the Resource is ready.

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.

HTTPGetAction

HTTPGetAction describes an action based on HTTP Get requests.

Fields
host	string Not supported by Cloud Run.
httpHeaders[]	object (HTTPHeader) Custom headers to set in the request. HTTP allows repeated headers.
path	string Path to access on the HTTP server.
port	integer (int32 format) Port number to access on the container. Number must be in the range 1 to 65535.
scheme	string Not supported by Cloud Run.

HTTPHeader

HTTPHeader describes a custom header to be used in HTTP probes

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

Job

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

Fields
apiVersion	string Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.
kind	string Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase.
metadata	object (ObjectMeta) Optional. Standard object's metadata.
spec	object (JobSpec) Optional. Specification of the desired behavior of a job.
status	object (JobStatus) Output only. Current status of a job.

JobSpec

JobSpec describes how the job will look.

Fields
template	object (ExecutionTemplateSpec) Optional. Describes the execution that will be created when running a job.

JobStatus

JobStatus represents the current state of a Job.

Fields
conditions[]	object (GoogleCloudRunV1Condition) Conditions communicate information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. Job-specific conditions include: * Ready: True when the job is ready to be executed.
executionCount	integer (int32 format) Number of executions created for this job.
latestCreatedExecution	object (ExecutionReference) A pointer to the most recently created execution for this job. This is set regardless of the eventual state of the execution.
observedGeneration	integer (int32 format) The 'generation' of the job that was last processed by the controller.

KeyToPath

Maps a string key to a path within a volume.

Fields
key	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. The key to project.
mode	integer (int32 format) (Optional) 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 The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

ListAuthorizedDomainsResponse

A list of Authorized Domains.

Fields
domains[]	object (AuthorizedDomain) The authorized domains belonging to the user.
nextPageToken	string Continuation token for fetching the next page of results.

ListConfigurationsResponse

ListConfigurationsResponse is a list of Configuration resources.

Fields
apiVersion	string The API version for this call such as "serving.knative.dev/v1".
items[]	object (Configuration) List of Configurations.
kind	string The kind of this resource, in this case "ConfigurationList".
metadata	object (ListMeta) Metadata associated with this Configuration list.
unreachable[]	string Locations that could not be reached.

ListDomainMappingsResponse

ListDomainMappingsResponse is a list of DomainMapping resources.

Fields
apiVersion	string The API version for this call such as "domains.cloudrun.com/v1".
items[]	object (DomainMapping) List of DomainMappings.
kind	string The kind of this resource, in this case "DomainMappingList".
metadata	object (ListMeta) Metadata associated with this DomainMapping list.
unreachable[]	string Locations that could not be reached.

ListExecutionsResponse

ListExecutionsResponse is a list of Executions resources.

Fields
apiVersion	string The API version for this call such as "run.googleapis.com/v1".
items[]	object (Execution) List of Executions.
kind	string The kind of this resource, in this case "ExecutionsList".
metadata	object (ListMeta) Metadata associated with this executions list.
unreachable[]	string Locations that could not be reached.

ListJobsResponse

ListJobsResponse is a list of Jobs resources.

Fields
apiVersion	string The API version for this call such as "run.googleapis.com/v1".
items[]	object (Job) List of Jobs.
kind	string The kind of this resource, in this case "JobsList".
metadata	object (ListMeta) Metadata associated with this jobs list.
unreachable[]	string Locations that could not be reached.

ListLocationsResponse

The response message for Locations.ListLocations.

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

ListMeta

Metadata for synthetic resources like List. In Cloud Run, all List Resources Responses will have a ListMeta instead of ObjectMeta.

Fields
continue	string Continuation token is a value emitted when the count of items is larger than the user/system limit. To retrieve the next page of items, pass the value of continue as the next request's page_token.
resourceVersion	string Opaque string that identifies the server's internal version of this object. It can be used by clients to determine when objects have changed. If the message is passed back to the server, it must be left unmodified.
selfLink	string URL representing this object.

ListRevisionsResponse

ListRevisionsResponse is a list of Revision resources.

Fields
apiVersion	string The API version for this call such as "serving.knative.dev/v1".
items[]	object (Revision) List of Revisions.
kind	string The kind of this resource, in this case "RevisionList".
metadata	object (ListMeta) Metadata associated with this revision list.
unreachable[]	string Locations that could not be reached.

ListRoutesResponse

ListRoutesResponse is a list of Route resources.

Fields
apiVersion	string The API version for this call such as "serving.knative.dev/v1".
items[]	object (Route) List of Routes.
kind	string The kind of this resource, in this case always "RouteList".
metadata	object (ListMeta) Metadata associated with this Route list.
unreachable[]	string Locations that could not be reached.

ListServicesResponse

A list of Service resources.

Fields
apiVersion	string The API version for this call; returns "serving.knative.dev/v1".
items[]	object (Service) List of Services.
kind	string The kind of this resource; returns "ServiceList".
metadata	object (ListMeta) Metadata associated with this Service list.
unreachable[]	string For calls against the global endpoint, returns the list of Cloud locations that could not be reached. For regional calls, this field is not used.

ListTasksResponse

ListTasksResponse is a list of Tasks resources.

Fields
apiVersion	string The API version for this call such as "run.googleapis.com/v1".
items[]	object (Task) List of Tasks.
kind	string The kind of this resource, in this case "TasksList".
metadata	object (ListMeta) Metadata associated with this tasks list.
unreachable[]	string Locations that could not be reached.

LocalObjectReference

Not supported by Cloud Run. LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

Fields
name	string Name of the referent.

Location

A resource that represents a Google Cloud location.

Fields
displayName	string The friendly name for this location, typically a nearby city name. For example, "Tokyo".
labels	map (key: string, value: string) Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
locationId	string The canonical id for this location. For example: "us-east1".
metadata	map (key: string, value: any) Service-specific metadata. For example the available capacity at the given location.
name	string Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"

ObjectMeta

google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Fields
annotations	map (key: string, value: string) Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * autoscaling.knative.dev/maxScale: Revision. * autoscaling.knative.dev/minScale: Revision. * run.googleapis.com/binary-authorization-breakglass: Service, Job, * run.googleapis.com/binary-authorization: Service, Job, Execution. * run.googleapis.com/client-name: All resources. * run.googleapis.com/cloudsql-instances: Revision, Execution. * run.googleapis.com/container-dependencies: Revision. * run.googleapis.com/cpu-throttling: Revision. * run.googleapis.com/custom-audiences: Service. * run.googleapis.com/description: Service. * run.googleapis.com/disable-default-uri: Service. * run.googleapis.com/encryption-key-shutdown-hours: Revision * run.googleapis.com/encryption-key: Revision, Execution. * run.googleapis.com/execution-environment: Revision, Execution. * run.googleapis.com/gc-traffic-tags: Service. * run.googleapis.com/ingress: Service. * run.googleapis.com/launch-stage: Service, Job. * run.googleapis.com/network-interfaces: Revision, Execution. * run.googleapis.com/post-key-revocation-action-type: Revision. * run.googleapis.com/secrets: Revision, Execution. * run.googleapis.com/secure-session-agent: Revision. * run.googleapis.com/sessionAffinity: Revision. * run.googleapis.com/startup-cpu-boost: Revision. * run.googleapis.com/vpc-access-connector: Revision, Execution. * run.googleapis.com/vpc-access-egress: Revision, Execution.
clusterName	string Not supported by Cloud Run
creationTimestamp	string (Timestamp format) UTC timestamp representing the server time when this object was created.
deletionGracePeriodSeconds	integer (int32 format) Not supported by Cloud Run
deletionTimestamp	string (Timestamp format) The read-only soft deletion timestamp for this resource. In Cloud Run, users are not able to set this field. Instead, they must call the corresponding Delete API.
finalizers[]	string Not supported by Cloud Run
generateName	string Not supported by Cloud Run
generation	integer (int32 format) A system-provided sequence number representing a specific generation of the desired state.
labels	map (key: string, value: string) Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.
name	string Required. The name of the resource. Name is required when creating top-level resources (Service, Job), must be unique within a Cloud Run project/region, and cannot be changed once created.
namespace	string Required. Defines the space within each name must be unique within a Cloud Run region. In Cloud Run, it must be project ID or number.
ownerReferences[]	object (OwnerReference) Not supported by Cloud Run
resourceVersion	string Opaque, system-generated value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server or omit the value to disable conflict-detection.
selfLink	string URL representing this object.
uid	string Unique, system-generated identifier for this resource.

Overrides

RunJob Overrides that contains Execution fields to be overridden on the go.

Fields
containerOverrides[]	object (ContainerOverride) Per container override specification.
taskCount	integer (int32 format) The desired number of tasks the execution should run. Will replace existing task_count value.
timeoutSeconds	integer (int32 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.

OwnerReference

This is not supported or used by Cloud Run.

Fields
apiVersion	string This is not supported or used by Cloud Run.
blockOwnerDeletion	boolean This is not supported or used by Cloud Run.
controller	boolean This is not supported or used by Cloud Run.
kind	string This is not supported or used by Cloud Run.
name	string This is not supported or used by Cloud Run.
uid	string This is not supported or used by Cloud Run.

Policy

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 (AuditConfig) Specifies cloud audit logging configuration for this policy.
bindings[]	object (Binding) 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.

Probe

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

Fields
exec	object (ExecAction) Not supported by Cloud Run.
failureThreshold	integer (int32 format) Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
grpc	object (GRPCAction) GRPCAction specifies an action involving a GRPC port.
httpGet	object (HTTPGetAction) HTTPGet specifies the http request to perform.
initialDelaySeconds	integer (int32 format) 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) 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.
successThreshold	integer (int32 format) Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set.
tcpSocket	object (TCPSocketAction) TCPSocket specifies an action involving a TCP port.
timeoutSeconds	integer (int32 format) 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; if period_seconds is not set, must be less or equal than 10.

ResourceRecord

A DNS resource record.

Fields
name	string Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
rrdata	string Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
type	enum Resource record type. Example: AAAA.
Enum type. Can be one of the following:
RECORD_TYPE_UNSPECIFIED	An unknown resource record.
A	An A resource record. Data is an IPv4 address.
AAAA	An AAAA resource record. Data is an IPv6 address.
CNAME	A CNAME resource record. Data is a domain name to be aliased.

ResourceRequirements

ResourceRequirements describes the compute resource requirements.

Fields
limits	map (key: string, value: string) Limits describes the maximum amount of compute resources allowed. Only 'cpu' and 'memory' keys are supported. * For supported 'cpu' values, 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
requests	map (key: string, value: string) Requests describes the minimum amount of compute resources required. Only cpu and memory are supported. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. * For supported 'cpu' values, 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

Revision

Revision is an immutable snapshot of code and configuration. A revision references a container image. Revisions are created by updates to a Configuration. See also: https://github.com/knative/specs/blob/main/specs/serving/overview.md#revision

Fields
apiVersion	string The API version for this call such as "serving.knative.dev/v1".
kind	string The kind of this resource, in this case "Revision".
metadata	object (ObjectMeta) Metadata associated with this Revision, including name, namespace, labels, and annotations.
spec	object (RevisionSpec) Spec holds the desired state of the Revision (from the client).
status	object (RevisionStatus) Status communicates the observed state of the Revision (from the controller).

RevisionSpec

RevisionSpec holds the desired state of the Revision (from the client).

Fields
containerConcurrency	integer (int32 format) ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80.
containers[]	object (Container) Containers holds the single container that defines the unit of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. In Cloud Run, only a single container may be provided.
enableServiceLinks	boolean Not supported by Cloud Run.
imagePullSecrets[]	object (LocalObjectReference) Not supported by Cloud Run.
serviceAccountName	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. If not provided, the revision will use the project's default service account.
timeoutSeconds	integer (int32 format) TimeoutSeconds holds the max duration the instance is allowed for responding to a request. Cloud Run: defaults to 300 seconds (5 minutes). Maximum allowed value is 3600 seconds (1 hour).
volumes[]	object (Volume) (No description provided)

RevisionStatus

RevisionStatus communicates the observed state of the Revision (from the controller).

Fields
conditions[]	object (GoogleCloudRunV1Condition) Conditions communicate information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. As a Revision is being prepared, it will incrementally update conditions. Revision-specific conditions include: * ResourcesAvailable: True when underlying resources have been provisioned. * ContainerHealthy: True when the Revision readiness check completes. * Active: True when the Revision may receive traffic.
imageDigest	string ImageDigest holds the resolved digest for the image specified within .Spec.Container.Image. The digest is resolved during the creation of Revision. This field holds the digest value regardless of whether a tag or digest was originally specified in the Container object.
logUrl	string Optional. Specifies the generated logging url for this particular revision based on the revision url template specified in the controller's config.
observedGeneration	integer (int32 format) ObservedGeneration is the 'Generation' of the Revision that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation, and the Ready condition's status is True or False.
serviceName	string Not currently used by Cloud Run.

RevisionTemplate

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

Fields
metadata	object (ObjectMeta) Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * autoscaling.knative.dev/minScale sets the minimum number of instances. * autoscaling.knative.dev/maxScale sets the maximum number of instances. * run.googleapis.com/cloudsql-instances sets Cloud SQL connections. Multiple values should be comma separated. * run.googleapis.com/vpc-access-connector sets a Serverless VPC Access connector. * run.googleapis.com/vpc-access-egress sets VPC egress. Supported values are all-traffic, all (deprecated), and private-ranges-only. all-traffic and all provide the same functionality. all is deprecated but will continue to be supported. Prefer all-traffic.
spec	object (RevisionSpec) RevisionSpec holds the desired state of the Revision (from the client).

Route

Route is responsible for configuring ingress over a collection of Revisions. Some of the Revisions a Route distributes traffic over may be specified by referencing the Configuration responsible for creating them; in these cases the Route is additionally responsible for monitoring the Configuration for "latest ready" revision changes, and smoothly rolling out latest revisions. Cloud Run currently supports referencing a single Configuration to automatically deploy the "latest ready" Revision from that Configuration.

Fields
apiVersion	string The API version for this call such as "serving.knative.dev/v1".
kind	string The kind of this resource, in this case always "Route".
metadata	object (ObjectMeta) Metadata associated with this Route, including name, namespace, labels, and annotations.
spec	object (RouteSpec) Spec holds the desired state of the Route (from the client).
status	object (RouteStatus) Status communicates the observed state of the Route (from the controller).

RouteSpec

RouteSpec holds the desired state of the Route (from the client).

Fields
traffic[]	object (TrafficTarget) Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations. Cloud Run currently supports a single configurationName.

RouteStatus

RouteStatus communicates the observed state of the Route (from the controller).

Fields
address	object (Addressable) Similar to url, information on where the service is available on HTTP.
conditions[]	object (GoogleCloudRunV1Condition) Conditions communicates information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world.
observedGeneration	integer (int32 format) ObservedGeneration is the 'Generation' of the Route that was last processed by the controller. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False. Note that providing a TrafficTarget that has latest_revision=True will result in a Route that does not increment either its metadata.generation or its observedGeneration, as new "latest ready" revisions from the Configuration are processed without an update to the Route's spec.
traffic[]	object (TrafficTarget) Traffic holds the configured traffic distribution. These entries will always contain RevisionName references. When ConfigurationName appears in the spec, this will hold the LatestReadyRevisionName that was last observed.
url	string URL holds the url that will distribute traffic over the provided traffic targets. It generally has the form: https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app

RunJobRequest

Request message for creating a new execution of a job.

Fields
overrides	object (Overrides) Optional. Overrides existing job configuration for one specific new job execution only, using the specified values to update the job configuration for the new execution.

SecretEnvSource

Not supported by Cloud Run. SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables.

Fields
localObjectReference	object (LocalObjectReference) This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead.
name	string The Secret to select from.
optional	boolean Specify whether the Secret must be defined

SecretKeySelector

SecretKeySelector selects a key of a Secret.

Fields
key	string Required. A Cloud Secret Manager secret version. Must be 'latest' for the latest version, an integer for a specific version, or a version alias. The key of the secret to select from. Must be a valid secret key.
localObjectReference	object (LocalObjectReference) This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead.
name	string The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project. If the secret is in another project, you must define an alias. An alias definition has the form: :projects//secrets/. If multiple alias definitions are needed, they must be separated by commas. The alias definitions must be set on the run.googleapis.com/secrets annotation. The name of the secret in the pod's namespace to select from.
optional	boolean Specify whether the Secret or its key must be defined.

SecretVolumeSource

A volume representing a secret stored in Google Secret Manager. 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_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names.

Fields
defaultMode	integer (int32 format) Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default 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.
items[]	object (KeyToPath) A list of secret versions to mount in the volume. If no items are specified, the volume will expose a file with the same name as the secret name. The contents of the file will be the data in the latest version of the secret. If items are 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 both a key and a path.
optional	boolean Not supported by Cloud Run.
secretName	string The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project. If the secret is in another project, you must define an alias. An alias definition has the form: :projects//secrets/. If multiple alias definitions are needed, they must be separated by commas. The alias definitions must be set on the run.googleapis.com/secrets annotation. Name of the secret in the container's namespace to use.

SecurityContext

Not supported by Cloud Run. SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

Fields
runAsUser	integer (int32 format) The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

Service

Service acts as a top-level container that manages a set of Routes and Configurations 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. Service acts only as an orchestrator of the underlying Routes and Configurations (much as a kubernetes Deployment orchestrates ReplicaSets). The Service's controller will track the statuses of its owned Configuration and Route, reflecting their statuses and conditions as its own.

Fields
apiVersion	string The API version for this call. It must be "serving.knative.dev/v1".
kind	string The kind of resource. It must be "Service".
metadata	object (ObjectMeta) Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * run.googleapis.com/binary-authorization-breakglass * run.googleapis.com/binary-authorization * run.googleapis.com/client-name * run.googleapis.com/custom-audiences * run.googleapis.com/description * run.googleapis.com/disable-default-uri * run.googleapis.com/gc-traffic-tags * run.googleapis.com/ingress * run.googleapis.com/ingress sets the ingress settings for the Service. See the ingress settings documentation for details on configuring ingress settings. * run.googleapis.com/ingress-status is output-only and contains the currently active ingress settings for the Service. run.googleapis.com/ingress-status may differ from run.googleapis.com/ingress while the system is processing a change to run.googleapis.com/ingress or if the system failed to process a change to run.googleapis.com/ingress. When the system has processed all changes successfully run.googleapis.com/ingress-status and run.googleapis.com/ingress are equal.
spec	object (ServiceSpec) Holds the desired state of the Service (from the client).
status	object (ServiceStatus) Communicates the system-controlled state of the Service.

ServiceSpec

ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s).

Fields
template	object (RevisionTemplate) Holds the latest specification for the Revision to be stamped out.
traffic[]	object (TrafficTarget) Specifies how to distribute traffic over a collection of Knative Revisions and Configurations to the Service's main URL.

ServiceStatus

The current state of the Service. Output only.

Fields
address	object (Addressable) Similar to url, information on where the service is available on HTTP.
conditions[]	object (GoogleCloudRunV1Condition) Conditions communicate information about ongoing/complete reconciliation processes that bring the spec inline with the observed state of the world. Service-specific conditions include: * ConfigurationsReady: True when the underlying Configuration is ready. * RoutesReady: True when the underlying Route is ready. * Ready: True when all underlying resources are ready.
latestCreatedRevisionName	string Name of the last revision that was created from this Service's Configuration. It might not be ready yet, for that use LatestReadyRevisionName.
latestReadyRevisionName	string Name of the latest Revision from this Service's Configuration that has had its Ready condition become True.
observedGeneration	integer (int32 format) Returns the generation last fully processed by the system. This will only match metadata.generation when reconciliation is complete. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False.
traffic[]	object (TrafficTarget) Holds the configured traffic distribution. These entries will always contain RevisionName references. When ConfigurationName appears in the spec, this will hold the LatestReadyRevisionName that we last observed.
url	string URL that will distribute traffic over the provided traffic targets. It generally has the form https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app

SetIamPolicyRequest

Request message for SetIamPolicy method.

Fields
policy	object (Policy) 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"

Status

Status is a return value for calls that don't return other objects.

Fields
code	integer (int32 format) Suggested HTTP return code for this status, 0 if not set.
details	object (StatusDetails) Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
message	string A human-readable description of the status of this operation.
metadata	object (ListMeta) Standard list metadata.
reason	string A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
status	string Status of the operation. One of: "Success" or "Failure".

StatusCause

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

Fields
field	string The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"
message	string A human-readable description of the cause of the error. This field may be presented as-is to a reader.
reason	string A machine-readable description of the cause of the error. If this value is empty there is no information available.

StatusDetails

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

Fields
causes[]	object (StatusCause) The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
group	string The group attribute of the resource associated with the status StatusReason.
kind	string The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind.
name	string The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
retryAfterSeconds	integer (int32 format) If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
uid	string UID of the resource. (when there is a single resource which can be described).

TCPSocketAction

TCPSocketAction describes an action based on opening a socket

Fields
host	string Not supported by Cloud Run.
port	integer (int32 format) Port number to access on the container. Number must be in the range 1 to 65535.

Task

Task represents a single run of a container to completion.

Fields
apiVersion	string Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.
kind	string Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase.
metadata	object (ObjectMeta) Optional. Standard object's metadata.
spec	object (TaskSpec) Optional. Specification of the desired behavior of a task.
status	object (TaskStatus) Output only. Current status of a task.

TaskAttemptResult

Result of a task attempt.

Fields
exitCode	integer (int32 format) Optional. 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) Optional. The status of this attempt. If the status code is OK, then the attempt succeeded.

TaskSpec

TaskSpec is a description of a task.

Fields
containers[]	object (Container) Optional. List of containers belonging to the task. We disallow a number of fields on this Container. Only a single container may be provided.
maxRetries	integer (int32 format) Optional. Number of retries allowed per task, before marking this job failed. Defaults to 3.
serviceAccountName	string Optional. Email address of the IAM service account associated with the task of a job execution. 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.
timeoutSeconds	string (int64 format) Optional. Duration in seconds 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 (Volume) Optional. List of volumes that can be mounted by containers belonging to the task.

TaskStatus

TaskStatus represents the status of a task.

Fields
completionTime	string (Timestamp format) Optional. Represents time when the task was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
conditions[]	object (GoogleCloudRunV1Condition) Optional. Conditions communicate information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. Task-specific conditions include: * Started: True when the task has started to execute. * Completed: True when the task has succeeded. False when the task has failed.
index	integer (int32 format) Required. Index of the task, unique per execution, and beginning at 0.
lastAttemptResult	object (TaskAttemptResult) Optional. Result of the last attempt of this task.
logUri	string Optional. URI where logs for this task can be found in Cloud Console.
observedGeneration	integer (int32 format) Optional. The 'generation' of the task that was last processed by the controller.
retried	integer (int32 format) Optional. The number of times this task was retried. Instances are retried when they fail up to the maxRetries limit.
startTime	string (Timestamp format) Optional. Represents time when the task started to run. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.

TaskTemplateSpec

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

Fields
spec	object (TaskSpec) Optional. Specification of the desired behavior of the task.

TestIamPermissionsRequest

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.

TestIamPermissionsResponse

Response message for TestIamPermissions method.

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

TrafficTarget

TrafficTarget holds a single entry of the routing table for a Route.

Fields
configurationName	string [Deprecated] Not supported in Cloud Run. It must be empty.
latestRevision	boolean Uses the "status.latestReadyRevisionName" of the Service to determine the traffic target. When it changes, traffic will automatically migrate from the prior "latest ready" revision to the new one. This field must be false if RevisionName is set. This field defaults to true otherwise. If the field is set to true on Status, this means that the Revision was resolved from the Service's latest ready revision.
percent	integer (int32 format) Percent specifies percent of the traffic to this Revision or Configuration. This defaults to zero if unspecified.
revisionName	string Points this traffic target to a specific Revision. This field is mutually exclusive with latest_revision.
tag	string Tag is used to expose a dedicated url for referencing this target exclusively.
url	string Output only. URL displays the URL for accessing tagged traffic targets. URL is displayed in status, and is disallowed on spec. URL must contain a scheme (e.g. https://) and a hostname, but may not contain anything else (e.g. basic auth, url path, etc.)

Volume

Volume represents a named volume in a container.

Fields
configMap	object (ConfigMapVolumeSource) Not supported in Cloud Run.
emptyDir	object (EmptyDirVolumeSource) Ephemeral storage used as a shared volume.
name	string Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved.
secret	object (SecretVolumeSource) 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 secretName.

VolumeMount

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 ':'.
name	string Required. The name of the volume. There must be a corresponding Volume with the same name.
readOnly	boolean Only true is accepted for Secret Volumes. Defaults to true for Secrets Volumes.
subPath	string Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).