Package google.cloud.run.v1

Stay organized with collections Save and categorize content based on your preferences.

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.

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 Webmaster Central.

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.

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. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting 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.

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. See also: https://github.com/knative/specs/blob/main/specs/serving/overview.md#configuration

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.

CreateDomainMappingRequest

Fields
parent

string

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

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

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.services.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, and deletes in the background. Please see https://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.

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. Please see https://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

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}
  • 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.

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. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

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. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Optional. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

ExecutionSpec

Optional. Specification of the desired behavior of an execution. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

status

ExecutionStatus

Output only. Current status of an execution. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

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.

template

TaskTemplateSpec

Optional. Describes the task(s) that will be created when executing an 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. Based on: https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190

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.

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

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.services.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}
  • 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.executions.get

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. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

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. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Optional. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

JobSpec

Optional. Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

status

JobStatus

Output only. Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

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.

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

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.services.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.executions.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.

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}
  • 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.

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. The runtime contract is documented here: https://github.com/knative/specs/blob/main/specs/serving/runtime-contract.md

volumes[]

Volume

image_pull_secrets[]

LocalObjectReference

Not supported by Cloud Run.

RevisionStatus

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

Fields
observed_generation

int32

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

Condition

Conditions communicate information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world.

As a Revision is being prepared, it will incrementally update conditions. Revision-specific conditions include:

  • ResourcesAvailable: True when underlying resources have been provisioned.
  • ContainerHealthy: True when the Revision readiness check completes.
  • Active: True when the Revision may receive traffic.
log_url

string

Optional. Specifies the generated logging url for this particular revision based on the revision url template specified in the controller's config.

service_name

string

Not currently used by Cloud Run.

image_digest

string

ImageDigest holds the resolved digest for the image specified within .Spec.Container.Image. The digest is resolved during the creation of Revision. This field holds the digest value regardless of whether a tag or digest was originally specified in the Container object.

RevisionTemplate

RevisionTemplateSpec describes the data a revision should have when created from a template. Based on: https://github.com/kubernetes/api/blob/e771f807/core/v1/types.go#L3179-L3190

Fields
metadata

ObjectMeta

Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration.

The following annotation keys set properties of the created revision:

  • autoscaling.knative.dev/minScale sets the minimum number of instances.
  • autoscaling.knative.dev/maxScale sets the maximum number of instances.
  • run.googleapis.com/cloudsql-instances sets Cloud SQL connections. Multiple values should be comma separated.
  • run.googleapis.com/vpc-access-connector sets a Serverless VPC Access connector.
  • run.googleapis.com/vpc-access-egress sets VPC egress. Supported values are all-traffic, all (deprecated), and private-ranges-only. all-traffic and all provide the same functionality. all is deprecated but will continue to be supported. Prefer all-traffic.
spec

RevisionSpec

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

Route

Route is responsible for configuring ingress over a collection of Revisions. Some of the Revisions a Route distributes traffic over may be specified by referencing the Configuration responsible for creating them; in these cases the Route is additionally responsible for monitoring the Configuration for "latest ready" revision changes, and smoothly rolling out latest revisions. See also: https://github.com/knative/specs/blob/main/specs/serving/overview.md#route

Cloud Run currently supports referencing a single Configuration to automatically deploy the "latest ready" Revision from that Configuration.

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 "Route".

metadata

ObjectMeta

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

spec

RouteSpec

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

status

RouteStatus

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

RouteSpec

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

Fields
traffic[]

TrafficTarget

Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations. Cloud Run currently supports a single configurationName.

RouteStatus

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

Fields
observed_generation

int32

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 only has a configurationName 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[]

Condition

Conditions communicates information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world.

traffic[]

TrafficTarget

Traffic holds the configured traffic distribution. These entries will always contain RevisionName references. When ConfigurationName appears in the spec, this will hold the LatestReadyRevisionName that was last observed.

url

string

URL holds the url that will distribute traffic over the provided traffic targets. It generally has the form: https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app

address

Addressable

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

string

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

  • run.jobs.run

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.

See also: https://github.com/knative/serving/blob/main/docs/spec/overview.md#service

Fields
api_version

string

The API version for this call. It must be "serving.knative.dev/v1".

kind

string

The kind of resource. It must be "Service".

metadata

ObjectMeta

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

In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type.

The following Cloud Run-specific annotations are accepted in Service.metadata.annotations.

  • run.googleapis.com/binary-authorization-breakglass
  • run.googleapis.com/binary-authorization
  • run.googleapis.com/client-name
  • run.googleapis.com/custom-audiences
  • run.googleapis.com/description
  • run.googleapis.com/gc-traffic-tags
  • run.googleapis.com/ingress
  • run.googleapis.com/ingress sets the ingress settings for the Service. See the ingress settings documentation for details on configuring ingress settings.

  • run.googleapis.com/ingress-status is output-only and contains the currently active ingress settings for the Service. run.googleapis.com/ingress-status may differ from run.googleapis.com/ingress while the system is processing a change to run.googleapis.com/ingress or if the system failed to process a change to run.googleapis.com/ingress. When the system has processed all changes successfully run.googleapis.com/ingress-status and run.googleapis.com/ingress are equal.
spec

ServiceSpec

Holds the desired state of the Service (from the client).

status

ServiceStatus

Communicates the system-controlled state of the Service.

ServiceSpec

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

Fields
template

RevisionTemplate

Holds the latest specification for the Revision to be stamped out.

traffic[]

TrafficTarget

Specifies how to distribute traffic over a collection of Knative Revisions and Configurations to the Service's main URL.

ServiceStatus

The current state of the Service. Output only.

Fields
observed_generation

int32

Returns the generation last fully processed by the system. This will only match metadata.generation when reconciliation is complete. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False.

conditions[]

Condition

Conditions communicate information about ongoing/complete reconciliation processes that bring the spec inline with the observed state of the world.

Service-specific conditions include:

  • ConfigurationsReady: True when the underlying Configuration is ready.
  • RoutesReady: True when the underlying Route is ready.
  • Ready: True when all underlying resources are ready.
latest_ready_revision_name

string

Name of the latest Revision from this Service's Configuration that has had its Ready condition become True.

latest_created_revision_name

string

Name of the last revision that was created from this Service's Configuration. It might not be ready yet, for that use LatestReadyRevisionName.

traffic[]

TrafficTarget

Holds the configured traffic distribution. These entries will always contain RevisionName references. When ConfigurationName appears in the spec, this will hold the LatestReadyRevisionName that we last observed.

url

string

URL that will distribute traffic over the provided traffic targets. It generally has the form https://{route-hash}-{project-hash}-{cluster-level-suffix}.a.run.app

address

Addressable

Similar to url, information on where the service is available on HTTP.

Task

Task represents a single run of a container 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. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

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. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Optional. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

TaskSpec

Optional. Specification of the desired behavior of a task. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

status

TaskStatus

Output only. Current status of a task. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

TaskAttemptResult

Result of a task attempt.

Fields
status

Status

Optional. The status of this attempt. If the status code is OK, then the attempt succeeded.

exit_code

int32

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

Volume

Optional. List of volumes that can be mounted by containers belonging to the task. More info: https://kubernetes.io/docs/concepts/storage/volumes

containers[]

Container

Optional. List of containers belonging to the task. We disallow a number of fields on this Container. Only a single container may be provided.

timeout_seconds

int64

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.

service_account_name

string

Optional. Email address of the IAM service account associated with the task of a job execution. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account.

max_retries

int32

Optional. Number of retries allowed per task, before marking this job failed.

TaskStatus

TaskStatus represents the status of a task.

Fields
observed_generation

int32

Optional. The 'generation' of the task 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.

Task-specific conditions include:

  • Started: True when the task has started to execute.
  • Completed: True when the task has succeeded. False when the task has failed.
index

int32

Required. Index of the task, unique per execution, and beginning at 0.

start_time

Timestamp

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

Timestamp

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

int32

Optional. The number of times this task was retried. Instances are retried when they fail up to the maxRetries limit.

last_attempt_result

TaskAttemptResult

Optional. Result of the last attempt of this task.

log_uri

string

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

TaskSpec

Optional. Specification of the desired behavior of the task. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

TrafficTarget

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

Fields
configuration_name

string

ConfigurationName of a configuration to whose latest revision which will be sent this portion of traffic. When the "status.latestReadyRevisionName" of the referenced configuration changes, traffic will automatically migrate from the prior "latest ready" revision to the new one. This field is never set in Route's status, only its spec. This is mutually exclusive with RevisionName.

Cloud Run currently supports a single ConfigurationName.

revision_name

string

RevisionName of a specific revision to which to send this portion of traffic. This is mutually exclusive with ConfigurationName.

percent

int32

Percent specifies percent of the traffic to this Revision or Configuration. This defaults to zero if unspecified.

tag

string

Optional. Tag is used to expose a dedicated url for referencing this target exclusively.

latest_revision

bool

Optional. LatestRevision may be provided to indicate that the latest ready Revision of the Configuration should be used for this traffic target. When provided LatestRevision must be true if RevisionName is empty; it must be false when RevisionName is non-empty.

url

string

Output only. URL displays the URL for accessing tagged traffic targets. URL is displayed in status, and is disallowed on spec. URL must contain a scheme (e.g. https://) and a hostname, but may not contain anything else (e.g. basic auth, url path, etc.)