Index
AuthorizedDomains(interface)Configurations(interface)DomainMappings(interface)Executions(interface)Jobs(interface)Revisions(interface)Routes(interface)Services(interface)Tasks(interface)Addressable(message)AuthorizedDomain(message)CSIVolumeSource(message)CancelExecutionRequest(message)CertificateMode(enum)Condition(message)ConfigMapEnvSource(message)ConfigMapKeySelector(message)ConfigMapVolumeSource(message)Configuration(message)ConfigurationSpec(message)ConfigurationStatus(message)Container(message)ContainerPort(message)CreateDomainMappingRequest(message)CreateJobRequest(message)CreateServiceRequest(message)DeleteDomainMappingRequest(message)DeleteExecutionRequest(message)DeleteJobRequest(message)DeleteRevisionRequest(message)DeleteServiceRequest(message)DomainMapping(message)DomainMappingSpec(message)DomainMappingStatus(message)EmptyDirVolumeSource(message)EnvFromSource(message)EnvVar(message)EnvVarSource(message)ExecAction(message)Execution(message)ExecutionReference(message)ExecutionReference.CompletionStatus(enum)ExecutionSpec(message)ExecutionStatus(message)ExecutionTemplateSpec(message)GRPCAction(message)GetConfigurationRequest(message)GetDomainMappingRequest(message)GetExecutionRequest(message)GetJobRequest(message)GetRevisionRequest(message)GetRouteRequest(message)GetServiceRequest(message)GetTaskRequest(message)HTTPGetAction(message)HTTPHeader(message)Job(message)JobSpec(message)JobStatus(message)KeyToPath(message)ListAuthorizedDomainsRequest(message)ListAuthorizedDomainsResponse(message)ListConfigurationsRequest(message)ListConfigurationsResponse(message)ListDomainMappingsRequest(message)ListDomainMappingsResponse(message)ListExecutionsRequest(message)ListExecutionsResponse(message)ListJobsRequest(message)ListJobsResponse(message)ListRevisionsRequest(message)ListRevisionsResponse(message)ListRoutesRequest(message)ListRoutesResponse(message)ListServicesRequest(message)ListServicesResponse(message)ListTasksRequest(message)ListTasksResponse(message)LocalObjectReference(message)NFSVolumeSource(message)Probe(message)ReplaceJobRequest(message)ReplaceServiceRequest(message)ResourceRecord(message)ResourceRecord.RecordType(enum)ResourceRequirements(message)Revision(message)RevisionSpec(message)RevisionStatus(message)RevisionTemplate(message)Route(message)RouteSpec(message)RouteStatus(message)RunJobRequest(message)RunJobRequest.Overrides(message)RunJobRequest.Overrides.ContainerOverride(message)SecretEnvSource(message)SecretKeySelector(message)SecretVolumeSource(message)SecurityContext(message)Service(message)ServiceSpec(message)ServiceStatus(message)TCPSocketAction(message)Task(message)TaskAttemptResult(message)TaskSpec(message)TaskStatus(message)TaskTemplateSpec(message)TrafficTarget(message)Volume(message)VolumeMount(message)
AuthorizedDomains
The AuthorizedDomains API allows you to list Authorized Domain resources within a Google Cloud Platform project.
| ListAuthorizedDomains |
|---|
|
List authorized domains.
|
Configurations
The Cloud Run Configurations API allows you to manage Cloud Run configurations.
| GetConfiguration |
|---|
|
Get information about a configuration.
|
| ListConfigurations |
|---|
|
List configurations. Results are sorted by creation time, descending.
|
DomainMappings
The Cloud Run DomainMappings API allows you to manage Cloud Run domain mappings. NOTE: This API is currently in Beta.
| CreateDomainMapping |
|---|
|
Create a new domain mapping.
|
| DeleteDomainMapping |
|---|
|
Delete a domain mapping.
|
| GetDomainMapping |
|---|
|
Get information about a domain mapping.
|
| ListDomainMappings |
|---|
|
List all domain mappings.
|
Executions
The Cloud Run Executions API allows you to manage Cloud Run job executions.
| CancelExecution |
|---|
|
Cancel an execution.
|
| DeleteExecution |
|---|
|
Delete an execution.
|
| GetExecution |
|---|
|
Get information about an execution.
|
| ListExecutions |
|---|
|
List executions. Results are sorted by creation time, descending.
|
Jobs
The Cloud Run Jobs API allows you to manage Cloud Run jobs.
| CreateJob |
|---|
|
Create a job.
|
| DeleteJob |
|---|
|
Delete a job.
|
| GetIamPolicy |
|---|
|
Get the IAM Access Control policy currently in effect for the given job. This result does not include any inherited policies.
|
| GetJob |
|---|
|
Get information about a job.
|
| ListJobs |
|---|
|
List jobs. Results are sorted by creation time, descending.
|
| ReplaceJob |
|---|
|
Replace a job. Only the spec and metadata labels and annotations are modifiable. After the Replace request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.
|
| RunJob |
|---|
|
Trigger creation of a new execution of this job.
|
| SetIamPolicy |
|---|
|
Sets the IAM Access control policy for the specified job. Overwrites any existing policy.
|
| TestIamPermissions |
|---|
|
Returns permissions that a caller has on the specified job. There are no permissions required for making this API call.
|
Revisions
The Cloud Run Revisions API allows you to manage Cloud Run revisions.
| DeleteRevision |
|---|
|
Delete a revision.
|
| GetRevision |
|---|
|
Get information about a revision.
|
| ListRevisions |
|---|
|
List revisions. Results are sorted by creation time, descending.
|
Routes
The Cloud Run Routes API allows you to manage Cloud Run routes.
| GetRoute |
|---|
|
Get information about a route.
|
| ListRoutes |
|---|
|
List routes. Results are sorted by creation time, descending.
|
Services
The Cloud Run Services API allows you to manage Cloud Run services.
| CreateService |
|---|
|
Creates a new Service. Service creation will trigger a new deployment. Use GetService, and check service.status to determine if the Service is ready.
|
| DeleteService |
|---|
|
Deletes the provided service. This will cause the Service to stop serving traffic and will delete all associated Revisions.
|
| GetIamPolicy |
|---|
|
Gets the IAM Access Control policy currently in effect for the given Cloud Run service. This result does not include any inherited policies.
|
| GetService |
|---|
|
Gets information about a service.
|
| ListServices |
|---|
|
Lists services for the given project and region. Results are sorted by creation time, descending.
|
| ReplaceService |
|---|
|
Replaces a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.
|
| SetIamPolicy |
|---|
|
Sets the IAM Access control policy for the specified Service. Overwrites any existing policy.
|
| TestIamPermissions |
|---|
|
Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call.
|
Tasks
The Cloud Run Tasks API allows you to view Cloud Run job execution tasks.
| GetTask |
|---|
|
Get information about a task.
|
| ListTasks |
|---|
|
List tasks.
|
Addressable
Information for connecting over HTTP(s).
| Fields | |
|---|---|
url |
|
AuthorizedDomain
A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Search Console.
| Fields | |
|---|---|
name |
Deprecated Read only. Full path to the |
id |
Relative name of the domain authorized for use. Example: |
CSIVolumeSource
Storage volume source using the Container Storage Interface.
| Fields | |
|---|---|
driver |
name of the CSI driver for the requested storage system. Cloud Run supports the following drivers: * gcsfuse.run.googleapis.com : Mount a Cloud Storage Bucket as a volume. |
read_only |
If true, mount the volume as read only. Defaults to false. |
volume_attributes |
stores driver specific attributes. For Google Cloud Storage volumes, the following attributes are supported: * bucketName: the name of the Cloud Storage bucket to mount. The Cloud Run Service identity must have access to this bucket. |
CancelExecutionRequest
Request message for cancelling an execution.
| Fields | |
|---|---|
name |
Required. The name of the execution to cancel. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Authorization requires the following IAM permission on the specified resource
|
CertificateMode
SSL management type. If AUTOMATIC or a type is omitted, a managed certificate is automatically provisioned. If None, the system will not provision a certificate.
| Enums | |
|---|---|
CERTIFICATE_MODE_UNSPECIFIED |
|
NONE |
Do not provision an HTTPS certificate. |
AUTOMATIC |
Automatically provisions an HTTPS certificate via GoogleCA. |
Condition
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 | |
|---|---|
type |
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. |
status |
Status of the condition, one of True, False, Unknown. |
reason |
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. |
message |
Optional. Human readable message indicating details about the current status. |
last_transition_time |
Optional. Last time the condition transitioned from one status to another. |
severity |
Optional. How to interpret this condition. One of Error, Warning, or Info. Conditions of severity Info do not contribute to resource readiness. |
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 | |
|---|---|
local_object_reference |
This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
optional |
Specify whether the ConfigMap must be defined. |
name |
The ConfigMap to select from. |
ConfigMapKeySelector
Not supported by Cloud Run.
| Fields | |
|---|---|
local_object_reference |
Not supported by Cloud Run. |
key |
Required. Not supported by Cloud Run. |
optional |
Not supported by Cloud Run. |
name |
Required. 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 | |
|---|---|
name |
Name of the config. |
items[] |
(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. |
default_mode |
(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
|
optional |
(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 | |
|---|---|
api_version |
The API version for this call such as "serving.knative.dev/v1". |
kind |
The kind of resource, in this case always "Configuration". |
metadata |
Metadata associated with this Configuration, including name, namespace, labels, and annotations. |
spec |
Spec holds the desired state of the Configuration (from the client). |
status |
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 |
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 | |
|---|---|
observed_generation |
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. |
latest_created_revision_name |
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. |
latest_ready_revision_name |
LatestReadyRevisionName holds the name of the latest Revision stamped out from this Configuration that has had its "Ready" condition become "True". |
conditions[] |
Conditions communicate information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. |
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 | |
|---|---|
name |
Name of the container specified as a DNS_LABEL (RFC 1123). |
image |
Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed. |
command[] |
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. |
args[] |
Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. |
env[] |
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. |
resources |
Compute Resources required by this container. |
working_dir |
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. |
ports[] |
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. |
env_from[] |
Not supported by Cloud Run. |
volume_mounts[] |
Volume to mount into the container's filesystem. Only supports SecretVolumeSources. Pod volumes to mount into the container's filesystem. |
liveness_probe |
Periodic probe of container liveness. Container will be restarted if the probe fails. |
readiness_probe |
Not supported by Cloud Run. |
startup_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. |
termination_message_path |
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. |
termination_message_policy |
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. |
image_pull_policy |
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. |
security_context |
Not supported by Cloud Run. |
ContainerPort
ContainerPort represents a network port in a single container.
| Fields | |
|---|---|
name |
If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c". |
container_port |
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 |
protocol |
Protocol for port. Must be "TCP". Defaults to "TCP". |
CreateDomainMappingRequest
| Fields | |
|---|---|
parent |
Required. The namespace in which the domain mapping should be created. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Authorization requires the following IAM permission on the specified resource
|
domain_mapping |
The domain mapping instance to create. |
dry_run |
Indicates that the server should validate the request and populate default values without persisting the request. Supported values: |
CreateJobRequest
Request message for creating a job.
| Fields | |
|---|---|
parent |
Required. The namespace in which the job should be created. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Authorization requires the following IAM permission on the specified resource
|
job |
Required. The job to create. |
CreateServiceRequest
Request message for creating a service.
| Fields | |
|---|---|
parent |
Required. The resource's parent. In Cloud Run, it may be one of the following:
Authorization requires the following IAM permission on the specified resource
|
service |
Required. The service instance to create. |
dry_run |
Indicates that the server should validate the request and populate default values without persisting the request. Supported values: |
DeleteDomainMappingRequest
Request message for deleting a domain mapping.
| Fields | |
|---|---|
name |
Required. The name of the domain mapping to delete. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Authorization requires the following IAM permission on the specified resource
|
propagation_policy |
Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/architecture/garbage-collection/ for more information. |
kind |
Cloud Run currently ignores this parameter. |
api_version |
Cloud Run currently ignores this parameter. |
dry_run |
Indicates that the server should validate the request and populate default values without persisting the request. Supported values: |
DeleteExecutionRequest
Request message for deleting an execution.
| Fields | |
|---|---|
name |
Required. The name of the execution to delete. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Authorization requires the following IAM permission on the specified resource
|
propagation_policy |
Optional. Specifies the propagation policy of delete. Cloud Run currently ignores this setting. |
kind |
Optional. Cloud Run currently ignores this parameter. |
api_version |
Optional. Cloud Run currently ignores this parameter. |
DeleteJobRequest
Request message for deleting a job.
| Fields | |
|---|---|
name |
Required. The name of the job to delete. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Authorization requires the following IAM permission on the specified resource
|
propagation_policy |
Optional. Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. |
kind |
Optional. Cloud Run currently ignores this parameter. |
api_version |
Optional. Cloud Run currently ignores this parameter. |
DeleteRevisionRequest
Request message for deleting a revision.
| Fields | |
|---|---|
name |
The name of the revision to delete. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Authorization requires the following IAM permission on the specified resource
|
propagation_policy |
Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. |
kind |
Cloud Run currently ignores this parameter. |
api_version |
Cloud Run currently ignores this parameter. |
dry_run |
Indicates that the server should validate the request and populate default values without persisting the request. Supported values: |
DeleteServiceRequest
Request message for deleting a service.
| Fields | |
|---|---|
name |
Required. The fully qualified name of the service to delete. It can be any of the following forms:
Authorization requires the following IAM permission on the specified resource
|
propagation_policy |
Not supported, and ignored by Cloud Run. |
kind |
Not supported, and ignored by Cloud Run. |
api_version |
Not supported, and ignored by Cloud Run. |
dry_run |
Indicates that the server should validate the request and populate default values without persisting the request. Supported values: |
DomainMapping
Resource to hold the state and status of a user's domain mapping. NOTE: This resource is currently in Beta.
| Fields | |
|---|---|
api_version |
The API version for this call such as "domains.cloudrun.com/v1". |
kind |
The kind of resource, in this case "DomainMapping". |
metadata |
Metadata associated with this BuildTemplate. |
spec |
The spec for this DomainMapping. |
status |
The current status of the DomainMapping. |
DomainMappingSpec
The desired state of the Domain Mapping.
| Fields | |
|---|---|
route_name |
The name of the Knative Route that this DomainMapping applies to. The route must exist. |
certificate_mode |
The mode of the certificate. |
force_override |
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. |
DomainMappingStatus
The current state of the Domain Mapping.
| Fields | |
|---|---|
conditions[] |
Array of observed DomainMappingConditions, indicating the current state of the DomainMapping. |
observed_generation |
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. |
resource_records[] |
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. |
mapped_route_name |
The name of the route that the mapping currently points to. |
url |
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 |
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 |
size_limit |
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 | |
|---|---|
prefix |
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. |
config_map_ref |
The ConfigMap to select from |
secret_ref |
The Secret to select from |
EnvVar
EnvVar represents an environment variable present in a Container.
| Fields | |
|---|---|
name |
Required. Name of the environment variable. |
value |
Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run. |
value_from |
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 | |
|---|---|
config_map_key_ref |
Not supported by Cloud Run. Not supported in Cloud Run. |
secret_key_ref |
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[] |
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 | |
|---|---|
api_version |
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 |
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 |
Optional. Standard object's metadata. |
spec |
Optional. Specification of the desired behavior of an execution. |
status |
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 | |
|---|---|
name |
Optional. Name of the execution. |
create_time |
Optional. Creation timestamp of the execution. |
completion_time |
Optional. Completion timestamp of the execution. |
delete_time |
Optional. The read-only soft deletion timestamp of the execution. |
completion_status |
Optional. Status for the execution completion. |
CompletionStatus
Possible execution completion status.
| Enums | |
|---|---|
COMPLETION_STATUS_UNSPECIFIED |
The default value. This value is used if the state is omitted. |
EXECUTION_SUCCEEDED |
Job execution has succeeded. |
EXECUTION_FAILED |
Job execution has failed. |
EXECUTION_RUNNING |
Job execution is running normally. |
EXECUTION_PENDING |
Waiting for backing resources to be provisioned. |
EXECUTION_CANCELLED |
Job execution has been cancelled by the user. |
ExecutionSpec
ExecutionSpec describes how the execution will look.
| Fields | |
|---|---|
parallelism |
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. |
task_count |
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 |
Optional. The template used to create tasks for this execution. |
ExecutionStatus
ExecutionStatus represents the current state of an Execution.
| Fields | |
|---|---|
observed_generation |
Optional. The 'generation' of the execution that was last processed by the controller. |
conditions[] |
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:
|
start_time |
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. |
completion_time |
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 |
running_count |
Optional. The number of actively running tasks. |
succeeded_count |
Optional. The number of tasks which reached phase Succeeded. |
failed_count |
Optional. The number of tasks which reached phase Failed. |
cancelled_count |
Optional. The number of tasks which reached phase Cancelled. |
retried_count |
Optional. The number of tasks which have retried at least once. |
log_uri |
Optional. URI where logs for this execution can be found in Cloud Console. |
ExecutionTemplateSpec
ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job.
| Fields | |
|---|---|
metadata |
Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution:
|
spec |
Required. ExecutionSpec holds the desired configuration for executions of this job. |
GRPCAction
GRPCAction describes an action involving a GRPC port.
| Fields | |
|---|---|
port |
Port number of the gRPC service. Number must be in the range 1 to 65535. |
service |
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. |
GetConfigurationRequest
Request message for retrieving a configuration.
| Fields | |
|---|---|
name |
The name of the configuration to retrieve. For Cloud Run, replace {namespace_id} with the project ID or number. Authorization requires the following IAM permission on the specified resource
|
GetDomainMappingRequest
Response message for retrieving a domain mapping.
| Fields | |
|---|---|
name |
Required. The name of the domain mapping to retrieve. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Authorization requires the following IAM permission on the specified resource
|
GetExecutionRequest
Request message for retrieving an execution.
| Fields | |
|---|---|
name |
Required. The name of the execution to retrieve. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Authorization requires the following IAM permission on the specified resource
|
GetJobRequest
Request message for retrieving a job.
| Fields | |
|---|---|
name |
Required. The name of the job to retrieve. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Authorization requires the following IAM permission on the specified resource
|
GetRevisionRequest
Request message for retrieving a revision
| Fields | |
|---|---|
name |
The name of the revision to retrieve. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Authorization requires the following IAM permission on the specified resource
|
GetRouteRequest
Request message for retrieving a route.
| Fields | |
|---|---|
name |
The name of the route to retrieve. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Authorization requires the following IAM permission on the specified resource
|
GetServiceRequest
Request message for retrieving a service.
| Fields | |
|---|---|
name |
Required. The fully qualified name of the service to retrieve. It can be any of the following forms:
Authorization requires the following IAM permission on the specified resource
|
GetTaskRequest
Request message for retrieving a task.
| Fields | |
|---|---|
name |
Required. The name of the task to retrieve. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Authorization requires the following IAM permission on the specified resource
|
HTTPGetAction
HTTPGetAction describes an action based on HTTP Get requests.
| Fields | |
|---|---|
path |
Path to access on the HTTP server. |
host |
Not supported by Cloud Run. |
scheme |
Not supported by Cloud Run. |
http_headers[] |
Custom headers to set in the request. HTTP allows repeated headers. |
port |
Port number to access on the container. Number must be in the range 1 to 65535. |
HTTPHeader
HTTPHeader describes a custom header to be used in HTTP probes
| Fields | |
|---|---|
name |
Required. The header field name |
value |
The header field value |
Job
Job represents the configuration of a single job, which references a container image which is run to completion.
| Fields | |
|---|---|
api_version |
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 |
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 |
Optional. Standard object's metadata. |
spec |
Optional. Specification of the desired behavior of a job. |
status |
Output only. Current status of a job. |
JobSpec
JobSpec describes how the job will look.
| Fields | |
|---|---|
template |
Optional. Describes the execution that will be created when running a job. |
Union field
|
|
start_execution_token |
A unique string used as a suffix for 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. |
run_execution_token |
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. |
JobStatus
JobStatus represents the current state of a Job.
| Fields | |
|---|---|
observed_generation |
The 'generation' of the job that was last processed by the controller. |
conditions[] |
Conditions communicate information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. Job-specific conditions include:
|
execution_count |
Number of executions created for this job. |
latest_created_execution |
A pointer to the most recently created execution for this job. This is set regardless of the eventual state of the execution. |
KeyToPath
Maps a string key to a path within a volume.
| Fields | |
|---|---|
key |
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. |
path |
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 '..'. |
mode |
(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
|
ListAuthorizedDomainsRequest
Request message for listing authorized domains.
| Fields | |
|---|---|
parent |
Name of the parent Project resource. Example: Authorization requires the following IAM permission on the specified resource
|
page_size |
Maximum results to return per page. |
page_token |
Continuation token for fetching the next page of results. |
ListAuthorizedDomainsResponse
A list of Authorized Domains.
| Fields | |
|---|---|
domains[] |
The authorized domains belonging to the user. |
next_page_token |
Continuation token for fetching the next page of results. |
ListConfigurationsRequest
Request message for listing configurations.
| Fields | |
|---|---|
parent |
The namespace from which the configurations should be listed. For Cloud Run, replace {namespace_id} with the project ID or number. Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. The maximum number of the records that should be returned. |
include_uninitialized |
Not supported by Cloud Run. |
field_selector |
Not supported by Cloud Run. |
label_selector |
Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. |
resource_version |
Not supported by Cloud Run. |
watch |
Not supported by Cloud Run. |
page_token |
Optional. Encoded string to continue paging. |
ListConfigurationsResponse
ListConfigurationsResponse is a list of Configuration resources.
| Fields | |
|---|---|
api_version |
The API version for this call such as "serving.knative.dev/v1". |
kind |
The kind of this resource, in this case "ConfigurationList". |
metadata |
Metadata associated with this Configuration list. |
items[] |
List of Configurations. |
unreachable[] |
Locations that could not be reached. |
ListDomainMappingsRequest
Request message for listing domain mappings.
| Fields | |
|---|---|
parent |
Required. The namespace from which the domain mappings should be listed. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. The maximum number of records that should be returned. |
include_uninitialized |
Not currently used by Cloud Run. |
field_selector |
Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. |
label_selector |
Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. |
resource_version |
The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. |
watch |
Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. |
page_token |
Optional. Encoded string to continue paging. |
ListDomainMappingsResponse
ListDomainMappingsResponse is a list of DomainMapping resources.
| Fields | |
|---|---|
api_version |
The API version for this call such as "domains.cloudrun.com/v1". |
kind |
The kind of this resource, in this case "DomainMappingList". |
metadata |
Metadata associated with this DomainMapping list. |
items[] |
List of DomainMappings. |
unreachable[] |
Locations that could not be reached. |
ListExecutionsRequest
Request message for listing executions.
| Fields | |
|---|---|
parent |
Required. The namespace from which the executions should be listed. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. The maximum number of the records that should be returned. |
include_uninitialized |
Optional. Not supported by Cloud Run. |
field_selector |
Optional. Not supported by Cloud Run. |
label_selector |
Optional. Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. |
resource_version |
Optional. Not supported by Cloud Run. |
watch |
Optional. Not supported by Cloud Run. |
page_token |
Optional. Optional encoded string to continue paging. |
ListExecutionsResponse
ListExecutionsResponse is a list of Executions resources.
| Fields | |
|---|---|
items[] |
List of Executions. |
api_version |
The API version for this call such as "run.googleapis.com/v1". |
kind |
The kind of this resource, in this case "ExecutionsList". |
metadata |
Metadata associated with this executions list. |
unreachable[] |
Locations that could not be reached. |
ListJobsRequest
Request message for listing jobs.
| Fields | |
|---|---|
parent |
Required. The namespace from which the jobs should be listed. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. The maximum number of records that should be returned. |
include_uninitialized |
Optional. Not supported by Cloud Run. |
field_selector |
Optional. Not supported by Cloud Run. |
label_selector |
Optional. Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. |
resource_version |
Optional. Not supported by Cloud Run. |
watch |
Optional. Not supported by Cloud Run. |
page_token |
Optional. Optional encoded string to continue paging. |
ListJobsResponse
ListJobsResponse is a list of Jobs resources.
| Fields | |
|---|---|
items[] |
List of Jobs. |
api_version |
The API version for this call such as "run.googleapis.com/v1". |
kind |
The kind of this resource, in this case "JobsList". |
metadata |
Metadata associated with this jobs list. |
unreachable[] |
Locations that could not be reached. |
ListRevisionsRequest
Request message for listing revisions.
| Fields | |
|---|---|
parent |
The namespace from which the revisions should be listed. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. The maximum number of records that should be returned. |
include_uninitialized |
Not currently used by Cloud Run. |
field_selector |
Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. |
label_selector |
Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. |
resource_version |
The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. |
watch |
Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. |
page_token |
Optional. Encoded string to continue paging. |
ListRevisionsResponse
ListRevisionsResponse is a list of Revision resources.
| Fields | |
|---|---|
api_version |
The API version for this call such as "serving.knative.dev/v1". |
kind |
The kind of this resource, in this case "RevisionList". |
metadata |
Metadata associated with this revision list. |
items[] |
List of Revisions. |
unreachable[] |
Locations that could not be reached. |
ListRoutesRequest
Request message for listing routes.
| Fields | |
|---|---|
parent |
The namespace from which the routes should be listed. For Cloud Run (fully managed), replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. The maximum number of records that should be returned. |
include_uninitialized |
Not currently used by Cloud Run. |
field_selector |
Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. |
label_selector |
Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. |
resource_version |
The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. |
watch |
Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. |
page_token |
Optional. Encoded string to continue paging. |
ListRoutesResponse
ListRoutesResponse is a list of Route resources.
| Fields | |
|---|---|
api_version |
The API version for this call such as "serving.knative.dev/v1". |
kind |
The kind of this resource, in this case always "RouteList". |
metadata |
Metadata associated with this Route list. |
items[] |
List of Routes. |
unreachable[] |
Locations that could not be reached. |
ListServicesRequest
Request message for listing services.
| Fields | |
|---|---|
parent |
Required. The parent from where the resources should be listed. In Cloud Run, it may be one of the following:
Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of records that should be returned. |
include_uninitialized |
Not supported, and ignored by Cloud Run. |
field_selector |
Not supported, and ignored by Cloud Run. |
label_selector |
Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. |
resource_version |
Not supported, and ignored by Cloud Run. |
watch |
Not supported, and ignored by Cloud Run. |
page_token |
Encoded string to continue paging. |
ListServicesResponse
A list of Service resources.
| Fields | |
|---|---|
api_version |
The API version for this call; returns "serving.knative.dev/v1". |
kind |
The kind of this resource; returns "ServiceList". |
metadata |
Metadata associated with this Service list. |
items[] |
List of Services. |
unreachable[] |
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. |
ListTasksRequest
Request message for listing tasks.
| Fields | |
|---|---|
parent |
Required. The namespace from which the tasks should be listed. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. The maximum number of records that should be returned. |
include_uninitialized |
Optional. Not supported by Cloud Run. |
field_selector |
Optional. Not supported by Cloud Run. |
label_selector |
Optional. Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. For example, to list all tasks of execution "foo" in succeeded state: Supported states are:
|
resource_version |
Optional. Not supported by Cloud Run. |
watch |
Optional. Not supported by Cloud Run. |
page_token |
Optional. Optional encoded string to continue paging. |
ListTasksResponse
ListTasksResponse is a list of Tasks resources.
| Fields | |
|---|---|
items[] |
List of Tasks. |
api_version |
The API version for this call such as "run.googleapis.com/v1". |
kind |
The kind of this resource, in this case "TasksList". |
metadata |
Metadata associated with this tasks list. |
unreachable[] |
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 |
Name of the referent. |
NFSVolumeSource
Represents a persistent volume that will be mounted using NFS.
This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down.
| Fields | |
|---|---|
server |
Hostname or IP address of the NFS server. |
path |
Path that is exported by the NFS server. |
read_only |
If true, mount the NFS volume as read only. Defaults to false. |
Probe
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
| Fields | |
|---|---|
initial_delay_seconds |
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. |
timeout_seconds |
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. |
period_seconds |
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. |
success_threshold |
Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set. |
failure_threshold |
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
exec |
Not supported by Cloud Run. |
http_get |
HTTPGet specifies the http request to perform. |
tcp_socket |
TCPSocket specifies an action involving a TCP port. |
grpc |
GRPCAction specifies an action involving a GRPC port. |
ReplaceJobRequest
Request message for replacing a job.
| Fields | |
|---|---|
name |
Required. The name of the job being replaced. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Authorization requires the following IAM permission on the specified resource
|
job |
Required. The desired job after replacing. The spec and metadata labels and annotations will override the ones of the existing job without merging. |
ReplaceServiceRequest
Request message for replacing a service.
| Fields | |
|---|---|
name |
Required. The fully qualified name of the service to replace. It can be any of the following forms:
Authorization requires the following IAM permission on the specified resource
|
service |
The service object being replaced. |
dry_run |
Indicates that the server should validate the request and populate default values without persisting the request. Supported values: |
ResourceRecord
A DNS resource record.
| Fields | |
|---|---|
name |
Relative name of the object affected by this record. Only applicable for |
rrdata |
Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1). |
type |
Resource record type. Example: |
RecordType
A resource record type.
| Enums | |
|---|---|
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 |
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 |
Requests describes the minimum amount of compute resources required. Only |
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 | |
|---|---|
api_version |
The API version for this call such as "serving.knative.dev/v1". |
kind |
The kind of this resource, in this case "Revision". |
metadata |
Metadata associated with this Revision, including name, namespace, labels, and annotations. |
spec |
Spec holds the desired state of the Revision (from the client). |
status |
Status communicates the observed state of the Revision (from the controller). |
RevisionSpec
RevisionSpec holds the desired state of the Revision (from the client).
| Fields | |
|---|---|
container_concurrency |
ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. |
timeout_seconds |
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). |
service_account_name |
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. |
containers[] |
Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. |
volumes[] |
|
runtime_class_name |
Runtime. Leave unset for default. |
enable_service_links |
Not supported by Cloud Run. |
image_pull_secrets[] |
Not supported by Cloud Run. |
node_selector |
Optional. The Node Selector configuration. Map of selector key to a value which matches a node. |
RevisionStatus
RevisionStatus communicates the observed state of the Revision (from the controller).
| Fields | |
|---|---|
observed_generation |
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. |
conditions[] |
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:
|
log_url |
Optional. Specifies the generated logging url for this particular revision based on the revision url template specified in the controller's config. |
service_name |
Not currently used by Cloud Run. |
image_digest |
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. |
desired_replicas |
Output only. The configured number of instances running this revision. For Cloud Run, this only includes instances provisioned using the minScale annotation. It does not include instances created by autoscaling. |
RevisionTemplate
RevisionTemplateSpec describes the data a revision should have when created from a template.
| Fields | |
|---|---|
metadata |
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:
|
spec |
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 | |
|---|---|
api_version |
The API version for this call such as "serving.knative.dev/v1". |
kind |
The kind of this resource, in this case always "Route". |
metadata |
Metadata associated with this Route, including name, namespace, labels, and annotations. |
spec |
Spec holds the desired state of the Route (from the client). |
status |
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[] |
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 | |
|---|---|
observed_generation |
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. |
conditions[] |
Conditions communicates information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. |
traffic[] |
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 |
URL holds the url that will distribute traffic over the provided traffic targets. It generally has the form: |
address |
Similar to url, information on where the service is available on HTTP. |
RunJobRequest
Request message for creating a new execution of a job.
| Fields | |
|---|---|
name |
Required. The name of the job to run. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID Authorization requires the following IAM permission on the specified resource
|
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. Authorization requires the following IAM permission on the specified resource
|
Overrides
RunJob Overrides that contains Execution fields to be overridden on the go.
| Fields | |
|---|---|
container_overrides[] |
Per container override specification. |
task_count |
The desired number of tasks the execution should run. Will replace existing task_count value. |
timeout_seconds |
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. |
ContainerOverride
Per container override specification.
| Fields | |
|---|---|
name |
The name of the container specified as a DNS_LABEL. |
args[] |
Arguments to the entrypoint. The specified arguments replace and override any existing entrypoint arguments. Must be empty if |
env[] |
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. |
clear_args |
Optional. Set to True to clear all existing arguments. |
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 | |
|---|---|
local_object_reference |
This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
optional |
Specify whether the Secret must be defined |
name |
The Secret to select from. |
SecretKeySelector
SecretKeySelector selects a key of a Secret.
| Fields | |
|---|---|
local_object_reference |
This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead. |
key |
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. |
optional |
Specify whether the Secret or its key must be defined. |
name |
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: The name of the secret in the pod's namespace to select from. |
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 | |
|---|---|
secret_name |
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: Name of the secret in the container's namespace to use. |
items[] |
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. |
default_mode |
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
|
optional |
Not supported by Cloud Run. |
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 | |
|---|---|
run_as_user |
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 | |
|---|---|
api_version |
The API version for this call. It must be "serving.knative.dev/v1". |
kind |
The kind of resource. It must be "Service". |
metadata |
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.
|
spec |
Holds the desired state of the Service (from the client). |
status |
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 |
Holds the latest specification for the Revision to be stamped out. |
traffic[] |
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 | |
|---|---|
observed_generation |
Returns the generation last seen by the system. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False. |
conditions[] |
Conditions communicate information about ongoing/complete reconciliation processes that bring the Service-specific conditions include:
|
latest_ready_revision_name |
Name of the latest Revision from this Service's Configuration that has had its |
latest_created_revision_name |
Name of the last revision that was created from this Service's Configuration. It might not be ready yet, for that use LatestReadyRevisionName. |
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 we last observed. |
url |
URL that will distribute traffic over the provided traffic targets. It generally has the form |
address |
Similar to url, information on where the service is available on HTTP. |
TCPSocketAction
TCPSocketAction describes an action based on opening a socket
| Fields | |
|---|---|
port |
Port number to access on the container. Number must be in the range 1 to 65535. |
host |
Not supported by Cloud Run. |
Task
Task represents a single run of a container to completion.
| Fields | |
|---|---|
api_version |
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 |
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 |
Optional. Standard object's metadata. |
spec |
Optional. Specification of the desired behavior of a task. |
status |
Output only. Current status of a task. |
TaskAttemptResult
Result of a task attempt.
| Fields | |
|---|---|
status |
Optional. The status of this attempt. If the status code is OK, then the attempt succeeded. |
exit_code |
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. |
TaskSpec
TaskSpec is a description of a task.
| Fields | |
|---|---|
volumes[] |
Optional. List of volumes that can be mounted by containers belonging to the task. |
containers[] |
Optional. List of containers belonging to the task. We disallow a number of fields on this Container. |
timeout_seconds |
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. |
service_account_name |
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. |
Union field
|
|
max_retries |
Optional. Number of retries allowed per task, before marking this job failed. Defaults to 3. |
TaskStatus
TaskStatus represents the status of a task.
| Fields | |
|---|---|
observed_generation |
Optional. The 'generation' of the task that was last processed by the controller. |
conditions[] |
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:
|
index |
Required. Index of the task, unique per execution, and beginning at 0. |
start_time |
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. |
completion_time |
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. |
retried |
Optional. The number of times this task was retried. Instances are retried when they fail up to the maxRetries limit. |
last_attempt_result |
Optional. Result of the last attempt of this task. |
log_uri |
Optional. URI where logs for this task can be found in Cloud Console. |
TaskTemplateSpec
TaskTemplateSpec describes the data a task should have when created from a template.
| Fields | |
|---|---|
spec |
Optional. Specification of the desired behavior of the task. |
TrafficTarget
TrafficTarget holds a single entry of the routing table for a Route.
| Fields | |
|---|---|
configuration_name |
[Deprecated] Not supported in Cloud Run. It must be empty. |
revision_name |
Points this traffic target to a specific Revision. This field is mutually exclusive with latest_revision. |
percent |
Percent specifies percent of the traffic to this Revision or Configuration. This defaults to zero if unspecified. |
tag |
Tag is used to expose a dedicated url for referencing this target exclusively. |
latest_revision |
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. |
url |
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 | |
|---|---|
name |
Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. |
secret |
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. |
config_map |
Not supported in Cloud Run. |
empty_dir |
Ephemeral storage used as a shared volume. |
nfs |
|
csi |
Volume specified by the Container Storage Interface driver |
VolumeMount
VolumeMount describes a mounting of a Volume within a container.
| Fields | |
|---|---|
name |
Required. The name of the volume. There must be a corresponding Volume with the same name. |
read_only |
Sets the mount to be read-only or read-write. Not used by Cloud Run. |
mount_path |
Required. Path within the container at which the volume should be mounted. Must not contain ':'. |
sub_path |
Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). |