Google Cloud Run V2 Client - Class RevisionTemplate (1.0.0)

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

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

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

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 Google\Cloud\Run\V2\RevisionScaling

Scaling settings for this Revision.

↳ vpc_access Google\Cloud\Run\V2\VpcAccess

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

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

↳ service_account 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 array<Google\Cloud\Run\V2\Container>

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

↳ volumes array<Google\Cloud\Run\V2\Volume>

A list of Volumes to make available to containers.

↳ execution_environment int

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

Sets the maximum number of requests that each serving instance can receive.

↳ session_affinity bool

Optional. Enable session affinity.

↳ health_check_disabled bool

Optional. Disables health checking containers during deployment.

getRevision

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

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

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

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

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

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

Scaling settings for this Revision.

Returns
Type Description
Google\Cloud\Run\V2\RevisionScaling|null

hasScaling

clearScaling

setScaling

Scaling settings for this Revision.

Parameter
Name Description
var Google\Cloud\Run\V2\RevisionScaling
Returns
Type Description
$this

getVpcAccess

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

Returns
Type Description
Google\Cloud\Run\V2\VpcAccess|null

hasVpcAccess

clearVpcAccess

setVpcAccess

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 Google\Cloud\Run\V2\VpcAccess
Returns
Type Description
$this

getTimeout

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

Returns
Type Description
Google\Protobuf\Duration|null

hasTimeout

clearTimeout

setTimeout

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

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

getServiceAccount

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

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<Google\Cloud\Run\V2\Container>
Returns
Type Description
$this

getVolumes

A list of Volumes to make available to containers.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setVolumes

A list of Volumes to make available to containers.

Parameter
Name Description
var array<Google\Cloud\Run\V2\Volume>
Returns
Type Description
$this

getExecutionEnvironment

The sandbox environment to host this Revision.

Returns
Type Description
int

setExecutionEnvironment

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

Sets the maximum number of requests that each serving instance can receive.

Returns
Type Description
int

setMaxInstanceRequestConcurrency

Sets the maximum number of requests that each serving instance can receive.

Parameter
Name Description
var int
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