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 Configurations API allows you to manage serverless Configurations within a Google Cloud Platform project.

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

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 domain mappings.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

Revisions

The Revisions API allows you to manage serverless Revisions within a Google Cloud Platform project.

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 Routes API allows you to manage Route resources within a Google Cloud Platform project.

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 Services API allows you to manage serverless services within a Google Cloud Platform project.

CreateService

rpc CreateService(CreateServiceRequest) returns (Service)

Create a service.

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)

Delete a service. This will cause the Service to stop serving traffic and will delete the child entities like Routes, Configurations and 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)

Get 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)

Get 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)

List services.

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)

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

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

string

Read only. Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/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 LetsEncrypt.

Condition

Condition defines a generic condition for a Resource

Fields
type

string

type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": 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.

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 failures of this condition, one of Error, Warning, Info

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/serving/blob/master/docs/spec/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

Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. To set minimum instances for this revision, use the "autoscaling.knative.dev/minScale" annotation key. (Cloud Run for Anthos only). To set maximum instances for this revision, use the "autoscaling.knative.dev/maxScale" annotation key. To set Cloud SQL connections for the revision, use the "run.googleapis.com/cloudsql-instances" annotation key. Values should be comma separated.

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, for that 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 communicates information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world.

CreateDomainMappingRequest

Fields
parent

string

The project ID or project number in which this domain mapping should be created.

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

  • run.services.create
domain_mapping

DomainMapping

The domain mapping instance to create.

CreateServiceRequest

Request message for creating a service.

Fields
parent

string

The project ID or project number in which this service should be created.

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

  • run.services.create
service

Service

The service instance to create.

DeleteDomainMappingRequest

Request message for deleting a domain mapping.

Fields
name

string

The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID.

Authorization requires the following Google 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/workloads/controllers/garbage-collection/ for more information.

kind

string

Cloud Run currently ignores this parameter.

api_version

string

Cloud Run currently ignores this parameter.

DeleteRevisionRequest

Request message for deleting a revision.

Fields
name

string

The name of the revision being deleted. If needed, replace {namespace_id} with the project ID.

Authorization requires the following Google 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 kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information.

kind

string

Cloud Run currently ignores this parameter.

api_version

string

Cloud Run currently ignores this parameter.

DeleteServiceRequest

Request message for deleting a service.

Fields
name

string

The name of the service being deleted. If needed, replace {namespace_id} with the project ID.

Authorization requires the following Google 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/workloads/controllers/garbage-collection/ for more information.

kind

string

Cloud Run currently ignores this parameter.

api_version

string

Cloud Run currently ignores this parameter.

DomainMapping

Resource to hold the state and status of a user's domain mapping.

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.

GetConfigurationRequest

Response message for retrieving a configuration.

Fields
name

string

The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID.

Authorization requires the following Google 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 being retrieved. If needed, replace {namespace_id} with the project ID.

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

  • run.services.get

GetRevisionRequest

Request message for retrieving a revision

Fields
name

string

The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID.

Authorization requires the following Google 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 being retrieved. If needed, replace {namespace_id} with the project ID.

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

  • run.routes.get

GetServiceRequest

Request message for retrieving a service.

Fields
name

string

The name of the service being retrieved. If needed, replace {namespace_id} with the project ID.

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

  • run.services.get

ListAuthorizedDomainsRequest

Request message for listing authorized domains.

Fields
parent

string

Name of the parent Application resource. Example: apps/myapp.

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 project ID or project number from which the configurations should be listed.

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

  • run.configurations.list
page_size

int32

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.

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 project ID or project number from which the domain mappings should be listed.

Authorization requires the following Google 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 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.

ListRevisionsRequest

Request message for listing revisions.

Fields
parent

string

The project ID or project number from which the revisions should be listed.

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

  • run.revisions.list
page_size

int32

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 project ID or project number from which the routes should be listed.

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

  • run.routes.list
page_size

int32

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

The project ID or project number from which the services should be listed.

Authorization requires the following Google 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 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.

ListServicesResponse

A list of Service 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 "ServiceList".

metadata

ListMeta

Metadata associated with this Service list.

items[]

Service

List of Services.

unreachable[]

string

Locations that could not be reached.

ReplaceServiceRequest

Request message for replacing a service.

Fields
name

string

The name of the service being replaced. If needed, replace {namespace_id} with the project ID.

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

  • run.services.update
service

Service

The service object being replaced.

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/serving/blob/master/docs/spec/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

(Optional)

ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision.

Cloud Run fully managed: supported, defaults to 80

Cloud Run for Anthos: supported, defaults to 0, which means concurrency to the application is not limited, and the system decides the target concurrency for the autoscaler.
timeout_seconds

int32

TimeoutSeconds holds the max duration the instance is allowed for responding to a request. Not currently used by Cloud Run.

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/serving/blob/master/docs/runtime-contract.md

volumes[]

Volume

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 communicates 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

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

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. To set minimum instances for this revision, use the "autoscaling.knative.dev/minScale" annotation key. To set maximum instances for this revision, use the "autoscaling.knative.dev/maxScale" annotation key. To set Cloud SQL connections for the revision, use the "run.googleapis.com/cloudsql-instances" annotation key.

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/serving/blob/master/docs/spec/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 we 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.

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/master/docs/spec/overview.md#service

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

metadata

ObjectMeta

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

spec

ServiceSpec

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

status

ServiceStatus

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

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

Template holds the latest specification for the Revision to be stamped out.

traffic[]

TrafficTarget

Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations.

ServiceStatus

The current state of the Service. Output only.

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

Condition

Conditions communicates 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 both the underlying Route and Configuration are ready.

latest_ready_revision_name

string

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

latest_created_revision_name

string

From ConfigurationStatus. LatestCreatedRevisionName is the last revision that was created from this Service's Configuration. It might not be ready yet, for that use LatestReadyRevisionName.

traffic[]

TrafficTarget

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

url

string

From RouteStatus. 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

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

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 we will send this portion of traffic. When the "status.latestReadyRevisionName" of the referenced configuration changes, we will automatically migrate traffic 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.

Providing RevisionName in spec is not currently supported by Cloud Run.
percent

int32

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

Cloud Run currently requires 100 percent for a single ConfigurationName TrafficTarget entry.
tag

string

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

Not currently supported in Cloud Run. +optional
latest_revision

bool

LatestRevision may be optionally 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.

+optional
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. http://) and a hostname, but may not contain anything else (e.g. basic auth, url path, etc.

Not currently supported in Cloud Run.
Was this page helpful? Let us know how we did:

Send feedback about...

This page
Documentation feedback
Cloud Run
Product feedback