Google Cloud Run V2 Client - Class RevisionTemplate (1.5.1)

Reference documentation and code samples for the Google Cloud Run V2 Client class RevisionTemplate.

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

Generated from protobuf message google.cloud.run.v2.RevisionTemplate

Namespace

Google \ Cloud \ Run \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ revision string

Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name.
↳ labels array|Google\Protobuf\Internal\MapField

Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 RevisionTemplate.
↳ annotations array|Google\Protobuf\Internal\MapField

Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 RevisionTemplate.

This field follows Kubernetes annotations' namespacing, limits, and rules.
↳ scaling RevisionScaling

Optional. Scaling settings for this Revision.
↳ vpc_access VpcAccess

Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.
↳ timeout Google\Protobuf\Duration

Optional. Max allowed time for an instance to respond to a request.
↳ service_account string

Optional. 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 array<Container>

Holds the single container that defines the unit of execution for this Revision.
↳ volumes array<Volume>

Optional. A list of Volumes to make available to containers.
↳ execution_environment int

Optional. The sandbox environment to host this Revision.
↳ encryption_key string

A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
↳ max_instance_request_concurrency int

Optional. Sets the maximum number of requests that each serving instance can receive. If not specified or 0, concurrency defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
↳ service_mesh ServiceMesh

Optional. Enables service mesh connectivity.
↳ encryption_key_revocation_action int

Optional. The action to take if the encryption key is revoked.
↳ encryption_key_shutdown_duration Google\Protobuf\Duration

Optional. If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.
↳ session_affinity bool

Optional. Enable session affinity.
↳ health_check_disabled bool

Optional. Disables health checking containers during deployment.
↳ node_selector NodeSelector

Optional. The node selector for the revision template.

getRevision

Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name.

Returns
Type Description
string

setRevision

Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name.

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 RevisionTemplate.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 RevisionTemplate.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getAnnotations

Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 RevisionTemplate.

This field follows Kubernetes annotations' namespacing, limits, and rules.

Returns
Type Description
Google\Protobuf\Internal\MapField

setAnnotations

Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 RevisionTemplate.

This field follows Kubernetes annotations' namespacing, limits, and rules.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getScaling

Optional. Scaling settings for this Revision.

Returns
Type Description
RevisionScaling|null

hasScaling

clearScaling

setScaling

Optional. Scaling settings for this Revision.

Parameter
Name Description
var RevisionScaling
Returns
Type Description
$this

getVpcAccess

Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.

Returns
Type Description
VpcAccess|null

hasVpcAccess

clearVpcAccess

setVpcAccess

Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.

Parameter
Name Description
var VpcAccess
Returns
Type Description
$this

getTimeout

Optional. Max allowed time for an instance to respond to a request.

Returns
Type Description
Google\Protobuf\Duration|null

hasTimeout

clearTimeout

setTimeout

Optional. Max allowed time for an instance to respond to a request.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getServiceAccount

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

Returns
Type Description
string

setServiceAccount

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

Parameter
Name Description
var string
Returns
Type Description
$this

getContainers

Holds the single container that defines the unit of execution for this Revision.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setContainers

Holds the single container that defines the unit of execution for this Revision.

Parameter
Name Description
var array<Container>
Returns
Type Description
$this

getVolumes

Optional. A list of Volumes to make available to containers.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setVolumes

Optional. A list of Volumes to make available to containers.

Parameter
Name Description
var array<Volume>
Returns
Type Description
$this

getExecutionEnvironment

Optional. The sandbox environment to host this Revision.

Returns
Type Description
int

setExecutionEnvironment

Optional. The sandbox environment to host this Revision.

Parameter
Name Description
var int
Returns
Type Description
$this

getEncryptionKey

A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek

Returns
Type Description
string

setEncryptionKey

A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek

Parameter
Name Description
var string
Returns
Type Description
$this

getMaxInstanceRequestConcurrency

Optional. Sets the maximum number of requests that each serving instance can receive. If not specified or 0, concurrency defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.

Returns
Type Description
int

setMaxInstanceRequestConcurrency

Optional. Sets the maximum number of requests that each serving instance can receive. If not specified or 0, concurrency defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.

Parameter
Name Description
var int
Returns
Type Description
$this

getServiceMesh

Optional. Enables service mesh connectivity.

Returns
Type Description
ServiceMesh|null

hasServiceMesh

clearServiceMesh

setServiceMesh

Optional. Enables service mesh connectivity.

Parameter
Name Description
var ServiceMesh
Returns
Type Description
$this

getEncryptionKeyRevocationAction

Optional. The action to take if the encryption key is revoked.

Returns
Type Description
int

setEncryptionKeyRevocationAction

Optional. The action to take if the encryption key is revoked.

Parameter
Name Description
var int
Returns
Type Description
$this

getEncryptionKeyShutdownDuration

Optional. If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.

Returns
Type Description
Google\Protobuf\Duration|null

hasEncryptionKeyShutdownDuration

clearEncryptionKeyShutdownDuration

setEncryptionKeyShutdownDuration

Optional. If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getSessionAffinity

Optional. Enable session affinity.

Returns
Type Description
bool

setSessionAffinity

Optional. Enable session affinity.

Parameter
Name Description
var bool
Returns
Type Description
$this

getHealthCheckDisabled

Optional. Disables health checking containers during deployment.

Returns
Type Description
bool

setHealthCheckDisabled

Optional. Disables health checking containers during deployment.

Parameter
Name Description
var bool
Returns
Type Description
$this

getNodeSelector

Optional. The node selector for the revision template.

Returns
Type Description
NodeSelector|null

hasNodeSelector

clearNodeSelector

setNodeSelector

Optional. The node selector for the revision template.

Parameter
Name Description
var NodeSelector
Returns
Type Description
$this