Google Cloud Run V2 Client - Class Revision (0.4.0)

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

A Revision is an immutable snapshot of code and configuration. A Revision references a container image. Revisions are only created by updates to its parent Service.

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

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Output only. The unique name of this Revision.

↳ uid
string

Output only. Server assigned unique identifier for the Revision. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

↳ generation
int|string

Output only. A number that monotonically increases every time the user modifies the desired state.

↳ labels
array| Google\Protobuf\Internal\MapField

Output only. 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 .

↳ annotations
array| Google\Protobuf\Internal\MapField

Output only. 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.

↳ create_time
Google\Protobuf\Timestamp

Output only. The creation time.

↳ update_time
Google\Protobuf\Timestamp

Output only. The last-modified time.

↳ delete_time
Google\Protobuf\Timestamp

Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.

↳ expire_time
Google\Protobuf\Timestamp

Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request.

↳ launch_stage
int

The least stable launch stage needed to create this resource, as defined by Google Cloud Platform Launch Stages . Cloud Run supports ALPHA , BETA , and GA .

Note that this value might not be what was used as input. For example, if ALPHA was provided as input in the parent resource, but only BETA and GA-level features are were, this field will be BETA.

↳ service
string

Output only. The name of the parent service.

↳ scaling
Google\Cloud\Run\V2\RevisionScaling

Scaling settings for this revision.

↳ vpc_access
Google\Cloud\Run\V2\VpcAccess

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

↳ max_instance_request_concurrency
int

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

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

↳ 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 execution environment being used 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

↳ encryption_key_revocation_action
int

The action to take if the encryption key is revoked.

↳ encryption_key_shutdown_duration
Google\Protobuf\Duration

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

↳ reconciling
bool

Output only. Indicates whether the resource's reconciliation is still in progress. See comments in Service.reconciling for additional information on reconciliation process in Cloud Run.

↳ conditions
array< Google\Cloud\Run\V2\Condition >

Output only. The Condition of this Revision, containing its readiness status, and detailed error information in case it did not reach a serving state.

↳ observed_generation
int|string

Output only. The generation of this Revision currently serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run.

↳ log_uri
string

Output only. The Google Console URI to obtain logs for the Revision.

↳ satisfies_pzs
bool

Output only. Reserved for future use.

↳ session_affinity
bool

Enable session affinity.

↳ etag
string

Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

getName

Output only. The unique name of this Revision.

Returns
Type
Description
string

setName

Output only. The unique name of this Revision.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getUid

Output only. Server assigned unique identifier for the Revision. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

Returns
Type
Description
string

setUid

Output only. Server assigned unique identifier for the Revision. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getGeneration

Output only. A number that monotonically increases every time the user modifies the desired state.

Returns
Type
Description
int|string

setGeneration

Output only. A number that monotonically increases every time the user modifies the desired state.

Parameter
Name
Description
var
int|string
Returns
Type
Description
$this

getLabels

Output only. 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 .

Returns
Type
Description

setLabels

Output only. 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 .

Parameter
Name
Description
Returns
Type
Description
$this

getAnnotations

Output only. 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.

Returns
Type
Description

setAnnotations

Output only. 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.

Parameter
Name
Description
Returns
Type
Description
$this

getCreateTime

Output only. The creation time.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. The creation time.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. The last-modified time.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The last-modified time.

Parameter
Name
Description
Returns
Type
Description
$this

getDeleteTime

Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.

Returns
Type
Description

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.

Parameter
Name
Description
Returns
Type
Description
$this

getExpireTime

Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request.

Returns
Type
Description

hasExpireTime

clearExpireTime

setExpireTime

Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request.

Parameter
Name
Description
Returns
Type
Description
$this

getLaunchStage

The least stable launch stage needed to create this resource, as defined by Google Cloud Platform Launch Stages . Cloud Run supports ALPHA , BETA , and GA .

Note that this value might not be what was used as input. For example, if ALPHA was provided as input in the parent resource, but only BETA and GA-level features are were, this field will be BETA.

Returns
Type
Description
int

setLaunchStage

The least stable launch stage needed to create this resource, as defined by Google Cloud Platform Launch Stages . Cloud Run supports ALPHA , BETA , and GA .

Note that this value might not be what was used as input. For example, if ALPHA was provided as input in the parent resource, but only BETA and GA-level features are were, this field will be BETA.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getService

Output only. The name of the parent service.

Returns
Type
Description
string

setService

Output only. The name of the parent service.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getScaling

Scaling settings for this revision.

Returns
Type
Description

hasScaling

clearScaling

setScaling

Scaling settings for this revision.

Parameter
Name
Description
Returns
Type
Description
$this

getVpcAccess

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

Returns
Type
Description

hasVpcAccess

clearVpcAccess

setVpcAccess

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

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

getTimeout

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

Returns
Type
Description

hasTimeout

clearTimeout

setTimeout

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

Parameter
Name
Description
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.

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.

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

setContainers

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

Parameter
Name
Description
Returns
Type
Description
$this

getVolumes

A list of Volumes to make available to containers.

Returns
Type
Description

setVolumes

A list of Volumes to make available to containers.

Parameter
Name
Description
Returns
Type
Description
$this

getExecutionEnvironment

The execution environment being used to host this Revision.

Returns
Type
Description
int

setExecutionEnvironment

The execution environment being used 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

getEncryptionKeyRevocationAction

The action to take if the encryption key is revoked.

Returns
Type
Description
int

setEncryptionKeyRevocationAction

The action to take if the encryption key is revoked.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getEncryptionKeyShutdownDuration

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

Returns
Type
Description

hasEncryptionKeyShutdownDuration

clearEncryptionKeyShutdownDuration

setEncryptionKeyShutdownDuration

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

Parameter
Name
Description
Returns
Type
Description
$this

getReconciling

Output only. Indicates whether the resource's reconciliation is still in progress. See comments in Service.reconciling for additional information on reconciliation process in Cloud Run.

Returns
Type
Description
bool

setReconciling

Output only. Indicates whether the resource's reconciliation is still in progress. See comments in Service.reconciling for additional information on reconciliation process in Cloud Run.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getConditions

Output only. The Condition of this Revision, containing its readiness status, and detailed error information in case it did not reach a serving state.

Returns
Type
Description

setConditions

Output only. The Condition of this Revision, containing its readiness status, and detailed error information in case it did not reach a serving state.

Parameter
Name
Description
Returns
Type
Description
$this

getObservedGeneration

Output only. The generation of this Revision currently serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run.

Returns
Type
Description
int|string

setObservedGeneration

Output only. The generation of this Revision currently serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run.

Parameter
Name
Description
var
int|string
Returns
Type
Description
$this

getLogUri

Output only. The Google Console URI to obtain logs for the Revision.

Returns
Type
Description
string

setLogUri

Output only. The Google Console URI to obtain logs for the Revision.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getSatisfiesPzs

Output only. Reserved for future use.

Returns
Type
Description
bool

setSatisfiesPzs

Output only. Reserved for future use.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getSessionAffinity

Enable session affinity.

Returns
Type
Description
bool

setSessionAffinity

Enable session affinity.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getEtag

Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

Returns
Type
Description
string

setEtag

Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: