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 \ V2Methods
__construct
Constructor.
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
↳ 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
↳ 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
↳ volumes
↳ 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
↳ 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
↳ gpu_zonal_redundancy_disabled
bool
Optional. True if GPU zonal redundancy is disabled on this revision.
getRevision
Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name.
string
setRevision
Optional. The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name.
var
string
$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.
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.
$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.
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.
$this
getScaling
Optional. Scaling settings for this Revision.
hasScaling
clearScaling
setScaling
Optional. Scaling settings for this Revision.
$this
getVpcAccess
Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc .
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 .
$this
getTimeout
Optional. Max allowed time for an instance to respond to a request.
hasTimeout
clearTimeout
setTimeout
Optional. Max allowed time for an instance to respond to a request.
$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.
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.
var
string
$this
getContainers
Holds the single container that defines the unit of execution for this Revision.
setContainers
Holds the single container that defines the unit of execution for this Revision.
$this
getVolumes
Optional. A list of Volumes to make available to containers.
setVolumes
Optional. A list of Volumes to make available to containers.
$this
getExecutionEnvironment
Optional. The sandbox environment to host this Revision.
int
setExecutionEnvironment
Optional. The sandbox environment to host this Revision.
var
int
$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
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
var
string
$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
.
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
.
var
int
$this
getServiceMesh
Optional. Enables service mesh connectivity.
hasServiceMesh
clearServiceMesh
setServiceMesh
Optional. Enables service mesh connectivity.
$this
getEncryptionKeyRevocationAction
Optional. The action to take if the encryption key is revoked.
int
setEncryptionKeyRevocationAction
Optional. The action to take if the encryption key is revoked.
var
int
$this
getEncryptionKeyShutdownDuration
Optional. If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.
hasEncryptionKeyShutdownDuration
clearEncryptionKeyShutdownDuration
setEncryptionKeyShutdownDuration
Optional. If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.
$this
getSessionAffinity
Optional. Enable session affinity.
bool
setSessionAffinity
Optional. Enable session affinity.
var
bool
$this
getHealthCheckDisabled
Optional. Disables health checking containers during deployment.
bool
setHealthCheckDisabled
Optional. Disables health checking containers during deployment.
var
bool
$this
getNodeSelector
Optional. The node selector for the revision template.
hasNodeSelector
clearNodeSelector
setNodeSelector
Optional. The node selector for the revision template.
$this
getGpuZonalRedundancyDisabled
Optional. True if GPU zonal redundancy is disabled on this revision.
bool
hasGpuZonalRedundancyDisabled
clearGpuZonalRedundancyDisabled
setGpuZonalRedundancyDisabled
Optional. True if GPU zonal redundancy is disabled on this revision.
var
bool
$this
