Google Cloud Run V2 Client - Class Service (0.7.2)

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

Service acts as a top-level container that manages a set of configurations and revision templates 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.

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

Namespace

Google \ Cloud \ Run \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id}

↳ description string

User-provided description of the Service. This field currently has a 512-character limit.

↳ uid string

Output only. Server assigned unique identifier for the trigger. 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. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.

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

↳ 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 in new resources. All system annotations in v1 now have a corresponding field in v2 Service.

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

↳ 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. The deletion time.

↳ expire_time Google\Protobuf\Timestamp

Output only. For a deleted resource, the time after which it will be permamently deleted.

↳ creator string

Output only. Email address of the authenticated creator.

↳ last_modifier string

Output only. Email address of the last authenticated modifier.

↳ client string

Arbitrary identifier for the API client.

↳ client_version string

Arbitrary version identifier for the API client.

↳ ingress int

Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active.

↳ launch_stage int

The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.

For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.

↳ binary_authorization Google\Cloud\Run\V2\BinaryAuthorization

Settings for the Binary Authorization feature.

↳ template Google\Cloud\Run\V2\RevisionTemplate

Required. The template used to create revisions for this Service.

↳ traffic array<Google\Cloud\Run\V2\TrafficTarget>

Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest Ready Revision.

↳ observed_generation int|string

Output only. The generation of this Service currently serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.

↳ terminal_condition Google\Cloud\Run\V2\Condition

Output only. The Condition of this Service, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

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

Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Service does not reach its Serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

↳ latest_ready_revision string

Output only. Name of the latest revision that is serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run.

↳ latest_created_revision string

Output only. Name of the last created revision. See comments in reconciling for additional information on reconciliation process in Cloud Run.

↳ traffic_statuses array<Google\Cloud\Run\V2\TrafficTargetStatus>

Output only. Detailed status information for corresponding traffic targets. See comments in reconciling for additional information on reconciliation process in Cloud Run.

↳ uri string

Output only. The main URI in which this Service is serving traffic.

↳ custom_audiences array

One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.

↳ satisfies_pzs bool

Output only. Reserved for future use.

↳ reconciling bool

Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state. When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, observed_generation, latest_ready_revison, traffic_statuses, and uri will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Service, or there was an error, and reconciliation failed. This state can be found in terminal_condition.state. If reconciliation succeeded, the following fields will match: traffic and traffic_statuses, observed_generation and generation, latest_ready_revision and latest_created_revision. If reconciliation failed, traffic_statuses, observed_generation, and latest_ready_revision will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in terminal_condition and conditions.

↳ etag string

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

getName

The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id.

Format: projects/{project}/locations/{location}/services/{service_id}

Returns
TypeDescription
string

setName

The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id.

Format: projects/{project}/locations/{location}/services/{service_id}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

User-provided description of the Service. This field currently has a 512-character limit.

Returns
TypeDescription
string

setDescription

User-provided description of the Service. This field currently has a 512-character limit.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUid

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

Returns
TypeDescription
string

setUid

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getGeneration

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

Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.

Returns
TypeDescription
int|string

setGeneration

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

Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$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 Service.

Returns
TypeDescription
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 Service.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$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 in new resources. All system annotations in v1 now have a corresponding field in v2 Service.

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

Returns
TypeDescription
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 in new resources. All system annotations in v1 now have a corresponding field in v2 Service.

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

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getCreateTime

Output only. The creation time.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The creation time.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

Output only. The last-modified time.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The last-modified time.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getDeleteTime

Output only. The deletion time.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. The deletion time.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getExpireTime

Output only. For a deleted resource, the time after which it will be permamently deleted.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasExpireTime

clearExpireTime

setExpireTime

Output only. For a deleted resource, the time after which it will be permamently deleted.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getCreator

Output only. Email address of the authenticated creator.

Returns
TypeDescription
string

setCreator

Output only. Email address of the authenticated creator.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLastModifier

Output only. Email address of the last authenticated modifier.

Returns
TypeDescription
string

setLastModifier

Output only. Email address of the last authenticated modifier.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getClient

Arbitrary identifier for the API client.

Returns
TypeDescription
string

setClient

Arbitrary identifier for the API client.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getClientVersion

Arbitrary version identifier for the API client.

Returns
TypeDescription
string

setClientVersion

Arbitrary version identifier for the API client.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getIngress

Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active.

Returns
TypeDescription
int

setIngress

Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getLaunchStage

The launch stage as defined by Google Cloud Platform Launch Stages.

Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.

For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.

Returns
TypeDescription
int

setLaunchStage

The launch stage as defined by Google Cloud Platform Launch Stages.

Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.

For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getBinaryAuthorization

Settings for the Binary Authorization feature.

Returns
TypeDescription
Google\Cloud\Run\V2\BinaryAuthorization|null

hasBinaryAuthorization

clearBinaryAuthorization

setBinaryAuthorization

Settings for the Binary Authorization feature.

Parameter
NameDescription
var Google\Cloud\Run\V2\BinaryAuthorization
Returns
TypeDescription
$this

getTemplate

Required. The template used to create revisions for this Service.

Returns
TypeDescription
Google\Cloud\Run\V2\RevisionTemplate|null

hasTemplate

clearTemplate

setTemplate

Required. The template used to create revisions for this Service.

Parameter
NameDescription
var Google\Cloud\Run\V2\RevisionTemplate
Returns
TypeDescription
$this

getTraffic

Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest Ready Revision.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setTraffic

Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest Ready Revision.

Parameter
NameDescription
var array<Google\Cloud\Run\V2\TrafficTarget>
Returns
TypeDescription
$this

getObservedGeneration

Output only. The generation of this Service currently serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value.

As with most Google APIs, its JSON representation will be a string instead of an integer.

Returns
TypeDescription
int|string

setObservedGeneration

Output only. The generation of this Service currently serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value.

As with most Google APIs, its JSON representation will be a string instead of an integer.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getTerminalCondition

Output only. The Condition of this Service, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

Returns
TypeDescription
Google\Cloud\Run\V2\Condition|null

hasTerminalCondition

clearTerminalCondition

setTerminalCondition

Output only. The Condition of this Service, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

Parameter
NameDescription
var Google\Cloud\Run\V2\Condition
Returns
TypeDescription
$this

getConditions

Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Service does not reach its Serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setConditions

Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Service does not reach its Serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

Parameter
NameDescription
var array<Google\Cloud\Run\V2\Condition>
Returns
TypeDescription
$this

getLatestReadyRevision

Output only. Name of the latest revision that is serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run.

Returns
TypeDescription
string

setLatestReadyRevision

Output only. Name of the latest revision that is serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLatestCreatedRevision

Output only. Name of the last created revision. See comments in reconciling for additional information on reconciliation process in Cloud Run.

Returns
TypeDescription
string

setLatestCreatedRevision

Output only. Name of the last created revision. See comments in reconciling for additional information on reconciliation process in Cloud Run.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTrafficStatuses

Output only. Detailed status information for corresponding traffic targets.

See comments in reconciling for additional information on reconciliation process in Cloud Run.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setTrafficStatuses

Output only. Detailed status information for corresponding traffic targets.

See comments in reconciling for additional information on reconciliation process in Cloud Run.

Parameter
NameDescription
var array<Google\Cloud\Run\V2\TrafficTargetStatus>
Returns
TypeDescription
$this

getUri

Output only. The main URI in which this Service is serving traffic.

Returns
TypeDescription
string

setUri

Output only. The main URI in which this Service is serving traffic.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCustomAudiences

One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setCustomAudiences

One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getSatisfiesPzs

Output only. Reserved for future use.

Returns
TypeDescription
bool

setSatisfiesPzs

Output only. Reserved for future use.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getReconciling

Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state.

When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, observed_generation, latest_ready_revison, traffic_statuses, and uri will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Service, or there was an error, and reconciliation failed. This state can be found in terminal_condition.state. If reconciliation succeeded, the following fields will match: traffic and traffic_statuses, observed_generation and generation, latest_ready_revision and latest_created_revision. If reconciliation failed, traffic_statuses, observed_generation, and latest_ready_revision will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in terminal_condition and conditions.

Returns
TypeDescription
bool

setReconciling

Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state.

When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, observed_generation, latest_ready_revison, traffic_statuses, and uri will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Service, or there was an error, and reconciliation failed. This state can be found in terminal_condition.state. If reconciliation succeeded, the following fields will match: traffic and traffic_statuses, observed_generation and generation, latest_ready_revision and latest_created_revision. If reconciliation failed, traffic_statuses, observed_generation, and latest_ready_revision will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in terminal_condition and conditions.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getEtag

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

Returns
TypeDescription
string

setEtag

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this