Google Cloud Run V2 Client - Class Service (1.0.0)

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
Name	Description
`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` 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 Service.
`↳ 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 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.
`↳ scaling`	`Google\Cloud\Run\V2\ServiceScaling` Optional. Specifies service-level scaling settings
`↳ default_uri_disabled`	`bool` Optional. Disables public resolution of the default URI of this service.
`↳ 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
Type	Description
`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
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

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

Returns
Type	Description
`string`

setDescription

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`string`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`int\|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 Service.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

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

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

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getCreateTime

Output only. The creation time.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. The creation time.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. The last-modified time.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The last-modified time.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getDeleteTime

Output only. The deletion time.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. The deletion time.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getExpireTime

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

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasExpireTime

clearExpireTime

setExpireTime

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

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getCreator

Output only. Email address of the authenticated creator.

Returns
Type	Description
`string`

setCreator

Output only. Email address of the authenticated creator.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLastModifier

Output only. Email address of the last authenticated modifier.

Returns
Type	Description
`string`

setLastModifier

Output only. Email address of the last authenticated modifier.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getClient

Arbitrary identifier for the API client.

Returns
Type	Description
`string`

setClient

Arbitrary identifier for the API client.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getClientVersion

Arbitrary version identifier for the API client.

Returns
Type	Description
`string`

setClientVersion

Arbitrary version identifier for the API client.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`int`

Returns
Type	Description
`$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
Type	Description
`int`

setLaunchStage

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

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

Returns
Type	Description
`$this`

getBinaryAuthorization

Settings for the Binary Authorization feature.

Returns
Type	Description
`Google\Cloud\Run\V2\BinaryAuthorization\|null`

hasBinaryAuthorization

clearBinaryAuthorization

setBinaryAuthorization

Settings for the Binary Authorization feature.

Parameter
Name	Description
`var`	`Google\Cloud\Run\V2\BinaryAuthorization`

Returns
Type	Description
`$this`

getTemplate

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

Returns
Type	Description
`Google\Cloud\Run\V2\RevisionTemplate\|null`

hasTemplate

clearTemplate

setTemplate

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

Parameter
Name	Description
`var`	`Google\Cloud\Run\V2\RevisionTemplate`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`array<Google\Cloud\Run\V2\TrafficTarget>`

Returns
Type	Description
`$this`

getScaling

Optional. Specifies service-level scaling settings

Returns
Type	Description
`Google\Cloud\Run\V2\ServiceScaling\|null`

hasScaling

clearScaling

setScaling

Optional. Specifies service-level scaling settings

Parameter
Name	Description
`var`	`Google\Cloud\Run\V2\ServiceScaling`

Returns
Type	Description
`$this`

getDefaultUriDisabled

Optional. Disables public resolution of the default URI of this service.

Returns
Type	Description
`bool`

setDefaultUriDisabled

Optional. Disables public resolution of the default URI of this service.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$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
Type	Description
`int\|string`

setObservedGeneration

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

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$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
Type	Description
`Google\Cloud\Run\V2\Condition\|null`

hasTerminalCondition

clearTerminalCondition

setTerminalCondition

Parameter
Name	Description
`var`	`Google\Cloud\Run\V2\Condition`

Returns
Type	Description
`$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
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setConditions

Parameter
Name	Description
`var`	`array<Google\Cloud\Run\V2\Condition>`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLatestCreatedRevision

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

Returns
Type	Description
`string`

setLatestCreatedRevision

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`array<Google\Cloud\Run\V2\TrafficTargetStatus>`

Returns
Type	Description
`$this`

getUri

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

Returns
Type	Description
`string`

setUri

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setCustomAudiences

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`

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
Type	Description
`bool`

setReconciling

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

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`