Package google.cloud.run.v1

Index

AuthorizedDomains

The AuthorizedDomains API allows you to list Authorized Domain resources within a Google Cloud Platform project.

ListAuthorizedDomains

rpc ListAuthorizedDomains(ListAuthorizedDomainsRequest) returns (ListAuthorizedDomainsResponse)

List authorized domains.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Configurations

The Cloud Run Configurations API allows you to manage Cloud Run configurations.

GetConfiguration

rpc GetConfiguration(GetConfigurationRequest) returns (Configuration)

Get information about a configuration.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListConfigurations

rpc ListConfigurations(ListConfigurationsRequest) returns (ListConfigurationsResponse)

List configurations.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DomainMappings

The Cloud Run DomainMappings API allows you to manage Cloud Run domain mappings. NOTE: This API is currently in Beta.

CreateDomainMapping

rpc CreateDomainMapping(CreateDomainMappingRequest) returns (DomainMapping)

Create a new domain mapping.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteDomainMapping

rpc DeleteDomainMapping(DeleteDomainMappingRequest) returns (Status)

Delete a domain mapping.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetDomainMapping

rpc GetDomainMapping(GetDomainMappingRequest) returns (DomainMapping)

Get information about a domain mapping.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListDomainMappings

rpc ListDomainMappings(ListDomainMappingsRequest) returns (ListDomainMappingsResponse)

List all domain mappings.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Executions

The Cloud Run Executions API allows you to manage Cloud Run job executions.

CancelExecution

rpc CancelExecution(CancelExecutionRequest) returns (Execution)

Cancel an execution.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteExecution

rpc DeleteExecution(DeleteExecutionRequest) returns (Status)

Delete an execution.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetExecution

rpc GetExecution(GetExecutionRequest) returns (Execution)

Get information about an execution.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListExecutions

rpc ListExecutions(ListExecutionsRequest) returns (ListExecutionsResponse)

List executions.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Jobs

The Cloud Run Jobs API allows you to manage Cloud Run jobs.

CreateJob

rpc CreateJob(CreateJobRequest) returns (Job)

Create a job.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteJob

rpc DeleteJob(DeleteJobRequest) returns (Status)

Delete a job.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetIamPolicy

rpc GetIamPolicy(GetIamPolicyRequest) returns (Policy)

Get the IAM Access Control policy currently in effect for the given job. This result does not include any inherited policies.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetJob

rpc GetJob(GetJobRequest) returns (Job)

Get information about a job.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListJobs

rpc ListJobs(ListJobsRequest) returns (ListJobsResponse)

List jobs.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ReplaceJob

rpc ReplaceJob(ReplaceJobRequest) returns (Job)

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.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

RunJob

rpc RunJob(RunJobRequest) returns (Execution)

Trigger creation of a new execution of this job.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

SetIamPolicy

rpc SetIamPolicy(SetIamPolicyRequest) returns (Policy)

Sets the IAM Access control policy for the specified job. Overwrites any existing policy.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

TestIamPermissions

rpc TestIamPermissions(TestIamPermissionsRequest) returns (TestIamPermissionsResponse)

Returns permissions that a caller has on the specified job.

There are no permissions required for making this API call.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Revisions

The Cloud Run Revisions API allows you to manage Cloud Run revisions.

DeleteRevision

rpc DeleteRevision(DeleteRevisionRequest) returns (Status)

Delete a revision.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetRevision

rpc GetRevision(GetRevisionRequest) returns (Revision)

Get information about a revision.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListRevisions

rpc ListRevisions(ListRevisionsRequest) returns (ListRevisionsResponse)

List revisions.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Routes

The Cloud Run Routes API allows you to manage Cloud Run routes.

GetRoute

rpc GetRoute(GetRouteRequest) returns (Route)

Get information about a route.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListRoutes

rpc ListRoutes(ListRoutesRequest) returns (ListRoutesResponse)

List routes.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Services

The Cloud Run Services API allows you to manage Cloud Run services.

CreateService

rpc CreateService(CreateServiceRequest) returns (Service)

Creates a new Service. Service creation will trigger a new deployment. Use GetService, and check service.status to determine if the Service is ready.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteService

rpc DeleteService(DeleteServiceRequest) returns (Status)

Deletes the provided service. This will cause the Service to stop serving traffic and will delete all associated Revisions.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetIamPolicy

rpc GetIamPolicy(GetIamPolicyRequest) returns (Policy)

Gets the IAM Access Control policy currently in effect for the given Cloud Run service. This result does not include any inherited policies.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetService

rpc GetService(GetServiceRequest) returns (Service)

Gets information about a service.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListServices

rpc ListServices(ListServicesRequest) returns (ListServicesResponse)

Lists services for the given project and region.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ReplaceService

rpc ReplaceService(ReplaceServiceRequest) returns (Service)

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.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

SetIamPolicy

rpc SetIamPolicy(SetIamPolicyRequest) returns (Policy)

Sets the IAM Access control policy for the specified Service. Overwrites any existing policy.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

TestIamPermissions

rpc TestIamPermissions(TestIamPermissionsRequest) returns (TestIamPermissionsResponse)

Returns permissions that a caller has on the specified Project.

There are no permissions required for making this API call.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Tasks

The Cloud Run Tasks API allows you to view Cloud Run job execution tasks.

GetTask

rpc GetTask(GetTaskRequest) returns (Task)

Get information about a task.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListTasks

rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)

List tasks.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Addressable

Information for connecting over HTTP(s).

Fields
url

string

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)

string

Deprecated Read only. Full path to the AuthorizedDomain resource in the API. Example: projects/myproject/authorizedDomains/example.com.

id

string

Relative name of the domain authorized for use. Example: example.com.

CancelExecutionRequest

Request message for cancelling an execution.

Fields
name

string

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 name:

  • run.jobs.run

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

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.

status

string

Status of the condition, one of True, False, Unknown.

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.

message

string

Optional. Human readable message indicating details about the current status.

last_transition_time

Timestamp

Optional. Last time the condition transitioned from one status to another.

severity

string

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
(deprecated)

LocalObjectReference

This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead.

optional

bool

Specify whether the ConfigMap must be defined.

name

string

The ConfigMap to select from.

ConfigMapKeySelector

Not supported by Cloud Run.

Fields
local_object_reference
(deprecated)

LocalObjectReference

Not supported by Cloud Run.

key

string

Required. Not supported by Cloud Run.

optional

bool

Not supported by Cloud Run.

name

string

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

string

Name of the config.

items[]

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.

default_mode

int32

(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.
optional

bool

(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

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

ObjectMeta

Metadata associated with this Configuration, including name, namespace, labels, and annotations.

spec

ConfigurationSpec

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

status

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

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
observed_generation

int32

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

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.

latest_ready_revision_name

string

LatestReadyRevisionName holds the name of the latest Revision stamped out from this Configuration that has had its "Ready" condition become "True".

conditions[]

Condition

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

string

Name of the container specified as a DNS_LABEL (RFC 1123).

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.

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.

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.

env[]

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.

resources

ResourceRequirements

Compute Resources required by this container.

working_dir

string

Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.

ports[]

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.

env_from[]

EnvFromSource

Not supported by Cloud Run.

volume_mounts[]

VolumeMount

Volume to mount into the container's filesystem. Only supports SecretVolumeSources.

Pod volumes to mount into the container's filesystem.

liveness_probe

Probe

Periodic probe of container liveness. Container will be restarted if the probe fails.

readiness_probe

Probe

Not supported by Cloud Run.

startup_probe

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

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.

termination_message_policy

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.

image_pull_policy

string

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.

security_context

SecurityContext

Not supported by Cloud Run.

ContainerPort

ContainerPort represents a network port in a single container.

Fields
name

string

If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c".

container_port

int32

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

string

Protocol for port. Must be "TCP". Defaults to "TCP".

CreateDomainMappingRequest

Fields
parent

string

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 parent:

  • run.domainmappings.create
domain_mapping

DomainMapping

The domain mapping instance to create.

dry_run

string

Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

CreateJobRequest

Request message for creating a job.

Fields
parent

string

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 parent:

  • run.jobs.create
job

Job

Required. The job to create.

CreateServiceRequest

Request message for creating a service.

Fields
parent

string

Required. The resource's parent. In Cloud Run, it may be one of the following:

  • {project_id_or_number}
  • namespaces/{project_id_or_number}
  • namespaces/{project_id_or_number}/services
  • projects/{project_id_or_number}/locations/{region}
  • projects/{project_id_or_number}/regions/{region}

Authorization requires the following IAM permission on the specified resource parent:

  • run.services.create
service

Service

Required. The service instance to create.

dry_run

string

Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

DeleteDomainMappingRequest

Request message for deleting a domain mapping.

Fields
name

string

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 name:

  • run.domainmappings.delete
propagation_policy

string

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

string

Cloud Run currently ignores this parameter.

api_version

string

Cloud Run currently ignores this parameter.

dry_run

string

Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

DeleteExecutionRequest

Request message for deleting an execution.

Fields
name

string

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 name:

  • run.executions.delete
propagation_policy

string

Optional. Specifies the propagation policy of delete. Cloud Run currently ignores this setting.

kind

string

Optional. Cloud Run currently ignores this parameter.

api_version

string

Optional. Cloud Run currently ignores this parameter.

DeleteJobRequest

Request message for deleting a job.

Fields
name

string

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 name:

  • run.jobs.delete
propagation_policy

string

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

string

Optional. Cloud Run currently ignores this parameter.

api_version

string

Optional. Cloud Run currently ignores this parameter.

DeleteRevisionRequest

Request message for deleting a revision.

Fields
name

string

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 name:

  • run.revisions.delete
propagation_policy

string

Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background.

kind

string

Cloud Run currently ignores this parameter.

api_version

string

Cloud Run currently ignores this parameter.

dry_run

string

Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

DeleteServiceRequest

Request message for deleting a service.

Fields
name

string

Required. The fully qualified name of the service to delete. It can be any of the following forms:

  • namespaces/{project_id_or_number}/services/{service_name} (only when the endpoint is regional)
  • projects/{project_id_or_number}/locations/{region}/services/{service_name}
  • projects/{project_id_or_number}/regions/{region}/services/{service_name}

Authorization requires the following IAM permission on the specified resource name:

  • run.services.delete
propagation_policy

string

Not supported, and ignored by Cloud Run.

kind

string

Not supported, and ignored by Cloud Run.

api_version

string

Not supported, and ignored by Cloud Run.

dry_run

string

Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

DomainMapping

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

Fields
api_version

string

The API version for this call such as "domains.cloudrun.com/v1".

kind

string

The kind of resource, in this case "DomainMapping".

metadata

ObjectMeta

Metadata associated with this BuildTemplate.

spec

DomainMappingSpec

The spec for this DomainMapping.

status

DomainMappingStatus

The current status of the DomainMapping.

DomainMappingSpec

The desired state of the Domain Mapping.

Fields
route_name

string

The name of the Knative Route that this DomainMapping applies to. The route must exist.

certificate_mode

CertificateMode

The mode of the certificate.

force_override

bool

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[]

Condition

Array of observed DomainMappingConditions, indicating the current state of the DomainMapping.

observed_generation

int32

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[]

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.

mapped_route_name

string

The name of the route that the mapping currently points to.

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

size_limit

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
prefix

string

An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

config_map_ref

ConfigMapEnvSource

The ConfigMap to select from

secret_ref

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.

value

string

Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.

value_from

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
config_map_key_ref

ConfigMapKeySelector

Not supported by Cloud Run.

Not supported in Cloud Run.

secret_key_ref

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
api_version

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

ObjectMeta

Optional. Standard object's metadata.

spec

ExecutionSpec

Optional. Specification of the desired behavior of an execution.

status

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
name

string

Optional. Name of the execution.

create_time

Timestamp

Optional. Creation timestamp of the execution.

completion_time

Timestamp

Optional. Completion timestamp of the execution.

ExecutionSpec

ExecutionSpec describes how the execution will look.

Fields
parallelism

int32

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

int32

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

TaskTemplateSpec

Optional. The template used to create tasks for this execution.

ExecutionStatus

ExecutionStatus represents the current state of an Execution.

Fields
observed_generation

int32

Optional. The 'generation' of the execution that was last processed by the controller.

conditions[]

Condition

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.
start_time

Timestamp

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

Timestamp

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

int32

Optional. The number of actively running tasks.

succeeded_count

int32

Optional. The number of tasks which reached phase Succeeded.

failed_count

int32

Optional. The number of tasks which reached phase Failed.

cancelled_count

int32

Optional. The number of tasks which reached phase Cancelled.

retried_count

int32

Optional. The number of tasks which have retried at least once.

log_uri

string

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

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

ExecutionSpec

Required. ExecutionSpec holds the desired configuration for executions of this job.

GRPCAction

GRPCAction describes an action involving a GRPC port.

Fields
port

int32

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.

GetConfigurationRequest

Request message for retrieving a configuration.

Fields
name

string

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 name:

  • run.configurations.get

GetDomainMappingRequest

Response message for retrieving a domain mapping.

Fields
name

string

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 name:

  • run.domainmappings.get

GetExecutionRequest

Request message for retrieving an execution.

Fields
name

string

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 name:

  • run.executions.get

GetJobRequest

Request message for retrieving a job.

Fields
name

string

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 name:

  • run.jobs.get

GetRevisionRequest

Request message for retrieving a revision

Fields
name

string

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 name:

  • run.revisions.get

GetRouteRequest

Request message for retrieving a route.

Fields
name

string

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 name:

  • run.routes.get

GetServiceRequest

Request message for retrieving a service.

Fields
name

string

Required. The fully qualified name of the service to retrieve. It can be any of the following forms:

  • namespaces/{project_id_or_number}/services/{service_name} (only when the endpoint is regional)
  • projects/{project_id_or_number}/locations/{region}/services/{service_name}
  • projects/{project_id_or_number}/regions/{region}/services/{service_name}

Authorization requires the following IAM permission on the specified resource name:

  • run.services.get

GetTaskRequest

Request message for retrieving a task.

Fields
name

string

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 name:

  • run.tasks.get

HTTPGetAction

HTTPGetAction describes an action based on HTTP Get requests.

Fields
path

string

Path to access on the HTTP server.

host

string

Not supported by Cloud Run.

scheme

string

Not supported by Cloud Run.

http_headers[]

HTTPHeader

Custom headers to set in the request. HTTP allows repeated headers.

port

int32

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

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
api_version

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

ObjectMeta

Optional. Standard object's metadata.

spec

JobSpec

Optional. Specification of the desired behavior of a job.

status

JobStatus

Output only. Current status of a job.

JobSpec

JobSpec describes how the job will look.

Fields
template

ExecutionTemplateSpec

Optional. Describes the execution that will be created when running a job.

JobStatus

JobStatus represents the current state of a Job.

Fields
observed_generation

int32

The 'generation' of the job that was last processed by the controller.

conditions[]

Condition

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.
execution_count

int32

Number of executions created for this job.

latest_created_execution

ExecutionReference

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

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.

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 '..'.

mode

int32

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

ListAuthorizedDomainsRequest

Request message for listing authorized domains.

Fields
parent

string

Name of the parent Project resource. Example: projects/myproject.

Authorization requires the following IAM permission on the specified resource parent:

  • run.authorizeddomains.list
page_size

int32

Maximum results to return per page.

page_token

string

Continuation token for fetching the next page of results.

ListAuthorizedDomainsResponse

A list of Authorized Domains.

Fields
domains[]

AuthorizedDomain

The authorized domains belonging to the user.

next_page_token

string

Continuation token for fetching the next page of results.

ListConfigurationsRequest

Request message for listing configurations.

Fields
parent

string

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 parent:

  • run.configurations.list
page_size

int32

Optional. The maximum number of the records that should be returned.

include_uninitialized

bool

Not supported by Cloud Run.

field_selector

string

Not supported by Cloud Run.

label_selector

string

Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn.

resource_version

string

Not supported by Cloud Run.

watch

bool

Not supported by Cloud Run.

page_token

string

Optional. Encoded string to continue paging.

ListConfigurationsResponse

ListConfigurationsResponse is a list of Configuration resources.

Fields
api_version

string

The API version for this call such as "serving.knative.dev/v1".

kind

string

The kind of this resource, in this case "ConfigurationList".

metadata

ListMeta

Metadata associated with this Configuration list.

items[]

Configuration

List of Configurations.

unreachable[]

string

Locations that could not be reached.

ListDomainMappingsRequest

Request message for listing domain mappings.

Fields
parent

string

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 parent:

  • run.domainmappings.list
page_size

int32

Optional. The maximum number of records that should be returned.

include_uninitialized

bool

Not currently used by Cloud Run.

field_selector

string

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

string

Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn.

resource_version

string

The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.

watch

bool

Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.

page_token

string

Optional. Encoded string to continue paging.

ListDomainMappingsResponse

ListDomainMappingsResponse is a list of DomainMapping resources.

Fields
api_version

string

The API version for this call such as "domains.cloudrun.com/v1".

kind

string

The kind of this resource, in this case "DomainMappingList".

metadata

ListMeta

Metadata associated with this DomainMapping list.

items[]

DomainMapping

List of DomainMappings.

unreachable[]

string

Locations that could not be reached.

ListExecutionsRequest

Request message for listing executions.

Fields
parent

string

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 parent:

  • run.executions.list
page_size

int32

Optional. The maximum number of the records that should be returned.

include_uninitialized

bool

Optional. Not supported by Cloud Run.

field_selector

string

Optional. Not supported by Cloud Run.

label_selector

string

Optional. Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn.

resource_version

string

Optional. Not supported by Cloud Run.

watch

bool

Optional. Not supported by Cloud Run.

page_token

string

Optional. Optional encoded string to continue paging.

ListExecutionsResponse

ListExecutionsResponse is a list of Executions resources.

Fields
items[]

Execution

List of Executions.

api_version

string

The API version for this call such as "run.googleapis.com/v1".

kind

string

The kind of this resource, in this case "ExecutionsList".

metadata

ListMeta

Metadata associated with this executions list.

unreachable[]

string

Locations that could not be reached.

ListJobsRequest

Request message for listing jobs.

Fields
parent

string

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 parent:

  • run.jobs.list
page_size

int32

Optional. The maximum number of records that should be returned.

include_uninitialized

bool

Optional. Not supported by Cloud Run.

field_selector

string

Optional. Not supported by Cloud Run.

label_selector

string

Optional. Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn.

resource_version

string

Optional. Not supported by Cloud Run.

watch

bool

Optional. Not supported by Cloud Run.

page_token

string

Optional. Optional encoded string to continue paging.

ListJobsResponse

ListJobsResponse is a list of Jobs resources.

Fields
items[]

Job

List of Jobs.

api_version

string

The API version for this call such as "run.googleapis.com/v1".

kind

string

The kind of this resource, in this case "JobsList".

metadata

ListMeta

Metadata associated with this jobs list.

unreachable[]

string

Locations that could not be reached.

ListRevisionsRequest

Request message for listing revisions.

Fields
parent

string

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 parent:

  • run.revisions.list
page_size

int32

Optional. The maximum number of records that should be returned.

include_uninitialized

bool

Not currently used by Cloud Run.

field_selector

string

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

string

Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn.

resource_version

string

The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.

watch

bool

Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.

page_token

string

Optional. Encoded string to continue paging.

ListRevisionsResponse

ListRevisionsResponse is a list of Revision resources.

Fields
api_version

string

The API version for this call such as "serving.knative.dev/v1".

kind

string

The kind of this resource, in this case "RevisionList".

metadata

ListMeta

Metadata associated with this revision list.

items[]

Revision

List of Revisions.

unreachable[]

string

Locations that could not be reached.

ListRoutesRequest

Request message for listing routes.

Fields
parent

string

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 parent:

  • run.routes.list
page_size

int32

Optional. The maximum number of records that should be returned.

include_uninitialized

bool

Not currently used by Cloud Run.

field_selector

string

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

string

Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn.

resource_version

string

The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run.

watch

bool

Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run.

page_token

string

Optional. Encoded string to continue paging.

ListRoutesResponse

ListRoutesResponse is a list of Route resources.

Fields
api_version

string

The API version for this call such as "serving.knative.dev/v1".

kind

string

The kind of this resource, in this case always "RouteList".

metadata

ListMeta

Metadata associated with this Route list.

items[]

Route

List of Routes.

unreachable[]

string

Locations that could not be reached.

ListServicesRequest

Request message for listing services.

Fields
parent

string

Required. The parent from where the resources should be listed. In Cloud Run, it may be one of the following:

  • {project_id_or_number}
  • namespaces/{project_id_or_number}
  • namespaces/{project_id_or_number}/services
  • projects/{project_id_or_number}/locations/{region}
  • projects/{project_id_or_number}/regions/{region}

Authorization requires the following IAM permission on the specified resource parent:

  • run.services.list
page_size

int32

The maximum number of records that should be returned.

include_uninitialized

bool

Not supported, and ignored by Cloud Run.

field_selector

string

Not supported, and ignored by Cloud Run.

label_selector

string

Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn.

resource_version

string

Not supported, and ignored by Cloud Run.

watch

bool

Not supported, and ignored by Cloud Run.

page_token

string

Encoded string to continue paging.

ListServicesResponse

A list of Service resources.

Fields
api_version

string

The API version for this call; returns "serving.knative.dev/v1".

kind

string

The kind of this resource; returns "ServiceList".

metadata

ListMeta

Metadata associated with this Service list.

items[]

Service

List of Services.

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.

ListTasksRequest

Request message for listing tasks.

Fields
parent

string

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 parent:

  • run.tasks.list
page_size

int32

Optional. The maximum number of records that should be returned.

include_uninitialized

bool

Optional. Not supported by Cloud Run.

field_selector

string

Optional. Not supported by Cloud Run.

label_selector

string

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: run.googleapis.com/execution=foo,run.googleapis.com/runningState=Succeeded.

Supported states are:

  • Pending: Initial state of all tasks. The task has not yet started but eventually will.
  • Running: Container instances for this task are running or will be running shortly.
  • Succeeded: No more container instances to run for the task, and the last attempt succeeded.
  • Failed: No more container instances to run for the task, and the last attempt failed. This task has run out of retry attempts.
  • Cancelled: Task was running but got stopped because its parent execution has been aborted.
  • Abandoned: The task has not yet started and never will because its parent execution has been aborted.
resource_version

string

Optional. Not supported by Cloud Run.

watch

bool

Optional. Not supported by Cloud Run.

page_token

string

Optional. Optional encoded string to continue paging.

ListTasksResponse

ListTasksResponse is a list of Tasks resources.

Fields
items[]

Task

List of Tasks.

api_version

string

The API version for this call such as "run.googleapis.com/v1".

kind

string

The kind of this resource, in this case "TasksList".

metadata

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.

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

int32

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

int32

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

int32

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

int32

Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set.

failure_threshold

int32

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

exec

ExecAction

Not supported by Cloud Run.

http_get

HTTPGetAction

HTTPGet specifies the http request to perform.

tcp_socket

TCPSocketAction

TCPSocket specifies an action involving a TCP port.

grpc

GRPCAction

GRPCAction specifies an action involving a GRPC port.

ReplaceJobRequest

Request message for replacing a job.

Fields
name

string

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 name:

  • run.jobs.update
job

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

string

Required. The fully qualified name of the service to replace. It can be any of the following forms:

  • namespaces/{project_id_or_number}/services/{service_name} (only when the endpoint is regional)
  • projects/{project_id_or_number}/locations/{region}/services/{service_name}
  • projects/{project_id_or_number}/regions/{region}/services/{service_name}

Authorization requires the following IAM permission on the specified resource name:

  • run.services.update
service

Service

The service object being replaced.

dry_run

string

Indicates that the server should validate the request and populate default values without persisting the request. Supported values: all

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

RecordType

Resource record type. Example: AAAA.

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

map<string, 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<string, 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
api_version

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

ObjectMeta

Metadata associated with this Revision, including name, namespace, labels, and annotations.

spec

RevisionSpec

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

status

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
container_concurrency

int32

ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80.

timeout_seconds

int32

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

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.

containers[]

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.

volumes[]

Volume

image_pull_secrets[]

LocalObjectReference

Not supported by Cloud Run.

RevisionStatus