Class Service.Builder (0.23.0)

public static final class Service.Builder extends GeneratedMessageV3.Builder<Service.Builder> implements ServiceOrBuilder

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.

Protobuf type google.cloud.run.v2.Service

Implements

ServiceOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllConditions(Iterable<? extends Condition> values)

public Service.Builder addAllConditions(Iterable<? extends Condition> values)

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.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.run.v2.Condition>
Returns
TypeDescription
Service.Builder

addAllCustomAudiences(Iterable<String> values)

public Service.Builder addAllCustomAudiences(Iterable<String> values)

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.

repeated string custom_audiences = 37;

Parameter
NameDescription
valuesIterable<String>

The customAudiences to add.

Returns
TypeDescription
Service.Builder

This builder for chaining.

addAllTraffic(Iterable<? extends TrafficTarget> values)

public Service.Builder addAllTraffic(Iterable<? extends TrafficTarget> values)

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.

repeated .google.cloud.run.v2.TrafficTarget traffic = 19;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.run.v2.TrafficTarget>
Returns
TypeDescription
Service.Builder

addAllTrafficStatuses(Iterable<? extends TrafficTargetStatus> values)

public Service.Builder addAllTrafficStatuses(Iterable<? extends TrafficTargetStatus> values)

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

repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.run.v2.TrafficTargetStatus>
Returns
TypeDescription
Service.Builder

addConditions(Condition value)

public Service.Builder addConditions(Condition value)

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.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueCondition
Returns
TypeDescription
Service.Builder

addConditions(Condition.Builder builderForValue)

public Service.Builder addConditions(Condition.Builder builderForValue)

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.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueCondition.Builder
Returns
TypeDescription
Service.Builder

addConditions(int index, Condition value)

public Service.Builder addConditions(int index, Condition value)

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.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
valueCondition
Returns
TypeDescription
Service.Builder

addConditions(int index, Condition.Builder builderForValue)

public Service.Builder addConditions(int index, Condition.Builder builderForValue)

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.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
builderForValueCondition.Builder
Returns
TypeDescription
Service.Builder

addConditionsBuilder()

public Condition.Builder addConditionsBuilder()

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.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Condition.Builder

addConditionsBuilder(int index)

public Condition.Builder addConditionsBuilder(int index)

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.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
Condition.Builder

addCustomAudiences(String value)

public Service.Builder addCustomAudiences(String value)

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.

repeated string custom_audiences = 37;

Parameter
NameDescription
valueString

The customAudiences to add.

Returns
TypeDescription
Service.Builder

This builder for chaining.

addCustomAudiencesBytes(ByteString value)

public Service.Builder addCustomAudiencesBytes(ByteString value)

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.

repeated string custom_audiences = 37;

Parameter
NameDescription
valueByteString

The bytes of the customAudiences to add.

Returns
TypeDescription
Service.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Service.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Service.Builder
Overrides

addTraffic(TrafficTarget value)

public Service.Builder addTraffic(TrafficTarget value)

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.

repeated .google.cloud.run.v2.TrafficTarget traffic = 19;

Parameter
NameDescription
valueTrafficTarget
Returns
TypeDescription
Service.Builder

addTraffic(TrafficTarget.Builder builderForValue)

public Service.Builder addTraffic(TrafficTarget.Builder builderForValue)

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.

repeated .google.cloud.run.v2.TrafficTarget traffic = 19;

Parameter
NameDescription
builderForValueTrafficTarget.Builder
Returns
TypeDescription
Service.Builder

addTraffic(int index, TrafficTarget value)

public Service.Builder addTraffic(int index, TrafficTarget value)

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.

repeated .google.cloud.run.v2.TrafficTarget traffic = 19;

Parameters
NameDescription
indexint
valueTrafficTarget
Returns
TypeDescription
Service.Builder

addTraffic(int index, TrafficTarget.Builder builderForValue)

public Service.Builder addTraffic(int index, TrafficTarget.Builder builderForValue)

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.

repeated .google.cloud.run.v2.TrafficTarget traffic = 19;

Parameters
NameDescription
indexint
builderForValueTrafficTarget.Builder
Returns
TypeDescription
Service.Builder

addTrafficBuilder()

public TrafficTarget.Builder addTrafficBuilder()

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.

repeated .google.cloud.run.v2.TrafficTarget traffic = 19;

Returns
TypeDescription
TrafficTarget.Builder

addTrafficBuilder(int index)

public TrafficTarget.Builder addTrafficBuilder(int index)

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.

repeated .google.cloud.run.v2.TrafficTarget traffic = 19;

Parameter
NameDescription
indexint
Returns
TypeDescription
TrafficTarget.Builder

addTrafficStatuses(TrafficTargetStatus value)

public Service.Builder addTrafficStatuses(TrafficTargetStatus value)

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

repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTrafficTargetStatus
Returns
TypeDescription
Service.Builder

addTrafficStatuses(TrafficTargetStatus.Builder builderForValue)

public Service.Builder addTrafficStatuses(TrafficTargetStatus.Builder builderForValue)

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

repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueTrafficTargetStatus.Builder
Returns
TypeDescription
Service.Builder

addTrafficStatuses(int index, TrafficTargetStatus value)

public Service.Builder addTrafficStatuses(int index, TrafficTargetStatus value)

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

repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
valueTrafficTargetStatus
Returns
TypeDescription
Service.Builder

addTrafficStatuses(int index, TrafficTargetStatus.Builder builderForValue)

public Service.Builder addTrafficStatuses(int index, TrafficTargetStatus.Builder builderForValue)

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

repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
builderForValueTrafficTargetStatus.Builder
Returns
TypeDescription
Service.Builder

addTrafficStatusesBuilder()

public TrafficTargetStatus.Builder addTrafficStatusesBuilder()

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

repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TrafficTargetStatus.Builder

addTrafficStatusesBuilder(int index)

public TrafficTargetStatus.Builder addTrafficStatusesBuilder(int index)

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

repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
TrafficTargetStatus.Builder

build()

public Service build()
Returns
TypeDescription
Service

buildPartial()

public Service buildPartial()
Returns
TypeDescription
Service

clear()

public Service.Builder clear()
Returns
TypeDescription
Service.Builder
Overrides

clearAnnotations()

public Service.Builder clearAnnotations()
Returns
TypeDescription
Service.Builder

clearBinaryAuthorization()

public Service.Builder clearBinaryAuthorization()

Settings for the Binary Authorization feature.

.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17;

Returns
TypeDescription
Service.Builder

clearClient()

public Service.Builder clearClient()

Arbitrary identifier for the API client.

string client = 13;

Returns
TypeDescription
Service.Builder

This builder for chaining.

clearClientVersion()

public Service.Builder clearClientVersion()

Arbitrary version identifier for the API client.

string client_version = 14;

Returns
TypeDescription
Service.Builder

This builder for chaining.

clearConditions()

public Service.Builder clearConditions()

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.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Service.Builder

clearCreateTime()

public Service.Builder clearCreateTime()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Service.Builder

clearCreator()

public Service.Builder clearCreator()

Output only. Email address of the authenticated creator.

string creator = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Service.Builder

This builder for chaining.

clearCustomAudiences()

public Service.Builder clearCustomAudiences()

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.

repeated string custom_audiences = 37;

Returns
TypeDescription
Service.Builder

This builder for chaining.

clearDeleteTime()

public Service.Builder clearDeleteTime()

Output only. The deletion time.

.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Service.Builder

clearDescription()

public Service.Builder clearDescription()

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

string description = 2;

Returns
TypeDescription
Service.Builder

This builder for chaining.

clearEtag()

public Service.Builder clearEtag()

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

string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Service.Builder

This builder for chaining.

clearExpireTime()

public Service.Builder clearExpireTime()

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

.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Service.Builder

clearField(Descriptors.FieldDescriptor field)

public Service.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Service.Builder
Overrides

clearGeneration()

public Service.Builder clearGeneration()

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.

int64 generation = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Service.Builder

This builder for chaining.

clearIngress()

public Service.Builder clearIngress()

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

.google.cloud.run.v2.IngressTraffic ingress = 15;

Returns
TypeDescription
Service.Builder

This builder for chaining.

clearLabels()

public Service.Builder clearLabels()
Returns
TypeDescription
Service.Builder

clearLastModifier()

public Service.Builder clearLastModifier()

Output only. Email address of the last authenticated modifier.

string last_modifier = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Service.Builder

This builder for chaining.

clearLatestCreatedRevision()

public Service.Builder clearLatestCreatedRevision()

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

string latest_created_revision = 34 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
Service.Builder

This builder for chaining.

clearLatestReadyRevision()

public Service.Builder clearLatestReadyRevision()

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

string latest_ready_revision = 33 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
Service.Builder

This builder for chaining.

clearLaunchStage()

public Service.Builder clearLaunchStage()

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. <p> For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.

.google.api.LaunchStage launch_stage = 16;

Returns
TypeDescription
Service.Builder

This builder for chaining.

clearName()

public Service.Builder clearName()

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}

string name = 1;

Returns
TypeDescription
Service.Builder

This builder for chaining.

clearObservedGeneration()

public Service.Builder clearObservedGeneration()

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.

int64 observed_generation = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Service.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Service.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Service.Builder
Overrides

clearReconciling()

public Service.Builder clearReconciling()

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.

bool reconciling = 98 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Service.Builder

This builder for chaining.

clearSatisfiesPzs()

public Service.Builder clearSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Service.Builder

This builder for chaining.

clearTemplate()

public Service.Builder clearTemplate()

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

.google.cloud.run.v2.RevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Service.Builder

clearTerminalCondition()

public Service.Builder clearTerminalCondition()

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.

.google.cloud.run.v2.Condition terminal_condition = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Service.Builder

clearTraffic()

public Service.Builder clearTraffic()

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.

repeated .google.cloud.run.v2.TrafficTarget traffic = 19;

Returns
TypeDescription
Service.Builder

clearTrafficStatuses()

public Service.Builder clearTrafficStatuses()

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

repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Service.Builder

clearUid()

public Service.Builder clearUid()

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.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Service.Builder

This builder for chaining.

clearUpdateTime()

public Service.Builder clearUpdateTime()

Output only. The last-modified time.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Service.Builder

clearUri()

public Service.Builder clearUri()

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

string uri = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Service.Builder

This builder for chaining.

clone()

public Service.Builder clone()
Returns
TypeDescription
Service.Builder
Overrides

containsAnnotations(String key)

public boolean containsAnnotations(String key)

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.

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

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

map<string, string> annotations = 6;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsLabels(String key)

public boolean containsLabels(String key)

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.

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

map<string, string> labels = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getAnnotations()

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
TypeDescription
Map<String,String>

getAnnotationsCount()

public int getAnnotationsCount()

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.

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

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

map<string, string> annotations = 6;

Returns
TypeDescription
int

getAnnotationsMap()

public Map<String,String> getAnnotationsMap()

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.

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

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

map<string, string> annotations = 6;

Returns
TypeDescription
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public String getAnnotationsOrDefault(String key, String defaultValue)

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.

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

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

map<string, string> annotations = 6;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getAnnotationsOrThrow(String key)

public String getAnnotationsOrThrow(String key)

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.

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

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

map<string, string> annotations = 6;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getBinaryAuthorization()

public BinaryAuthorization getBinaryAuthorization()

Settings for the Binary Authorization feature.

.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17;

Returns
TypeDescription
BinaryAuthorization

The binaryAuthorization.

getBinaryAuthorizationBuilder()

public BinaryAuthorization.Builder getBinaryAuthorizationBuilder()

Settings for the Binary Authorization feature.

.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17;

Returns
TypeDescription
BinaryAuthorization.Builder

getBinaryAuthorizationOrBuilder()

public BinaryAuthorizationOrBuilder getBinaryAuthorizationOrBuilder()

Settings for the Binary Authorization feature.

.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17;

Returns
TypeDescription
BinaryAuthorizationOrBuilder

getClient()

public String getClient()

Arbitrary identifier for the API client.

string client = 13;

Returns
TypeDescription
String

The client.

getClientBytes()

public ByteString getClientBytes()

Arbitrary identifier for the API client.

string client = 13;

Returns
TypeDescription
ByteString

The bytes for client.

getClientVersion()

public String getClientVersion()

Arbitrary version identifier for the API client.

string client_version = 14;

Returns
TypeDescription
String

The clientVersion.

getClientVersionBytes()

public ByteString getClientVersionBytes()

Arbitrary version identifier for the API client.

string client_version = 14;

Returns
TypeDescription
ByteString

The bytes for clientVersion.

getConditions(int index)

public Condition getConditions(int index)

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.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
Condition

getConditionsBuilder(int index)

public Condition.Builder getConditionsBuilder(int index)

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.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
Condition.Builder

getConditionsBuilderList()

public List<Condition.Builder> getConditionsBuilderList()

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.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<Builder>

getConditionsCount()

public int getConditionsCount()

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.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

getConditionsList()

public List<Condition> getConditionsList()

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.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<Condition>

getConditionsOrBuilder(int index)

public ConditionOrBuilder getConditionsOrBuilder(int index)

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.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
ConditionOrBuilder

getConditionsOrBuilderList()

public List<? extends ConditionOrBuilder> getConditionsOrBuilderList()

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.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<? extends com.google.cloud.run.v2.ConditionOrBuilder>

getCreateTime()

public Timestamp getCreateTime()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getCreator()

public String getCreator()

Output only. Email address of the authenticated creator.

string creator = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The creator.

getCreatorBytes()

public ByteString getCreatorBytes()

Output only. Email address of the authenticated creator.

string creator = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for creator.

getCustomAudiences(int index)

public String getCustomAudiences(int index)

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.

repeated string custom_audiences = 37;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The customAudiences at the given index.

getCustomAudiencesBytes(int index)

public ByteString getCustomAudiencesBytes(int index)

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.

repeated string custom_audiences = 37;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the customAudiences at the given index.

getCustomAudiencesCount()

public int getCustomAudiencesCount()

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.

repeated string custom_audiences = 37;

Returns
TypeDescription
int

The count of customAudiences.

getCustomAudiencesList()

public ProtocolStringList getCustomAudiencesList()

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.

repeated string custom_audiences = 37;

Returns
TypeDescription
ProtocolStringList

A list containing the customAudiences.

getDefaultInstanceForType()

public Service getDefaultInstanceForType()
Returns
TypeDescription
Service

getDeleteTime()

public Timestamp getDeleteTime()

Output only. The deletion time.

.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The deleteTime.

getDeleteTimeBuilder()

public Timestamp.Builder getDeleteTimeBuilder()

Output only. The deletion time.

.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Builder

getDeleteTimeOrBuilder()

public TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. The deletion time.

.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDescription()

public String getDescription()

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

string description = 2;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

string description = 2;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEtag()

public String getEtag()

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

string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

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

string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for etag.

getExpireTime()

public Timestamp getExpireTime()

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

.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The expireTime.

getExpireTimeBuilder()

public Timestamp.Builder getExpireTimeBuilder()

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

.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Builder

getExpireTimeOrBuilder()

public TimestampOrBuilder getExpireTimeOrBuilder()

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

.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getGeneration()

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

int64 generation = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
long

The generation.

getIngress()

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

.google.cloud.run.v2.IngressTraffic ingress = 15;

Returns
TypeDescription
IngressTraffic

The ingress.

getIngressValue()

public int getIngressValue()

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

.google.cloud.run.v2.IngressTraffic ingress = 15;

Returns
TypeDescription
int

The enum numeric value on the wire for ingress.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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.

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

map<string, string> labels = 5;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

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.

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

map<string, string> labels = 5;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

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.

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

map<string, string> labels = 5;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

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.

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

map<string, string> labels = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getLastModifier()

public String getLastModifier()

Output only. Email address of the last authenticated modifier.

string last_modifier = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The lastModifier.

getLastModifierBytes()

public ByteString getLastModifierBytes()

Output only. Email address of the last authenticated modifier.

string last_modifier = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for lastModifier.

getLatestCreatedRevision()

public String getLatestCreatedRevision()

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

string latest_created_revision = 34 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The latestCreatedRevision.

getLatestCreatedRevisionBytes()

public ByteString getLatestCreatedRevisionBytes()

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

string latest_created_revision = 34 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for latestCreatedRevision.

getLatestReadyRevision()

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

string latest_ready_revision = 33 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The latestReadyRevision.

getLatestReadyRevisionBytes()

public ByteString getLatestReadyRevisionBytes()

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

string latest_ready_revision = 33 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for latestReadyRevision.

getLaunchStage()

public LaunchStage 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. <p> For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.

.google.api.LaunchStage launch_stage = 16;

Returns
TypeDescription
com.google.api.LaunchStage

The launchStage.

getLaunchStageValue()

public int getLaunchStageValue()

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. <p> For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.

.google.api.LaunchStage launch_stage = 16;

Returns
TypeDescription
int

The enum numeric value on the wire for launchStage.

getMutableAnnotations()

public Map<String,String> getMutableAnnotations()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public String 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}

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

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}

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getObservedGeneration()

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

int64 observed_generation = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
long

The observedGeneration.

getReconciling()

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

bool reconciling = 98 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

The reconciling.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

The satisfiesPzs.

getTemplate()

public RevisionTemplate getTemplate()

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

.google.cloud.run.v2.RevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
RevisionTemplate

The template.

getTemplateBuilder()

public RevisionTemplate.Builder getTemplateBuilder()

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

.google.cloud.run.v2.RevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
RevisionTemplate.Builder

getTemplateOrBuilder()

public RevisionTemplateOrBuilder getTemplateOrBuilder()

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

.google.cloud.run.v2.RevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
RevisionTemplateOrBuilder

getTerminalCondition()

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

.google.cloud.run.v2.Condition terminal_condition = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Condition

The terminalCondition.

getTerminalConditionBuilder()

public Condition.Builder getTerminalConditionBuilder()

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.

.google.cloud.run.v2.Condition terminal_condition = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Condition.Builder

getTerminalConditionOrBuilder()

public ConditionOrBuilder getTerminalConditionOrBuilder()

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.

.google.cloud.run.v2.Condition terminal_condition = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ConditionOrBuilder

getTraffic(int index)

public TrafficTarget getTraffic(int index)

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.

repeated .google.cloud.run.v2.TrafficTarget traffic = 19;

Parameter
NameDescription
indexint
Returns
TypeDescription
TrafficTarget

getTrafficBuilder(int index)

public TrafficTarget.Builder getTrafficBuilder(int index)

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.

repeated .google.cloud.run.v2.TrafficTarget traffic = 19;

Parameter
NameDescription
indexint
Returns
TypeDescription
TrafficTarget.Builder

getTrafficBuilderList()

public List<TrafficTarget.Builder> getTrafficBuilderList()

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.

repeated .google.cloud.run.v2.TrafficTarget traffic = 19;

Returns
TypeDescription
List<Builder>

getTrafficCount()

public int getTrafficCount()

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.

repeated .google.cloud.run.v2.TrafficTarget traffic = 19;

Returns
TypeDescription
int

getTrafficList()

public List<TrafficTarget> getTrafficList()

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.

repeated .google.cloud.run.v2.TrafficTarget traffic = 19;

Returns
TypeDescription
List<TrafficTarget>

getTrafficOrBuilder(int index)

public TrafficTargetOrBuilder getTrafficOrBuilder(int index)

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.

repeated .google.cloud.run.v2.TrafficTarget traffic = 19;

Parameter
NameDescription
indexint
Returns
TypeDescription
TrafficTargetOrBuilder

getTrafficOrBuilderList()

public List<? extends TrafficTargetOrBuilder> getTrafficOrBuilderList()

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.

repeated .google.cloud.run.v2.TrafficTarget traffic = 19;

Returns
TypeDescription
List<? extends com.google.cloud.run.v2.TrafficTargetOrBuilder>

getTrafficStatuses(int index)

public TrafficTargetStatus getTrafficStatuses(int index)

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

repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
TrafficTargetStatus

getTrafficStatusesBuilder(int index)

public TrafficTargetStatus.Builder getTrafficStatusesBuilder(int index)

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

repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
TrafficTargetStatus.Builder

getTrafficStatusesBuilderList()

public List<TrafficTargetStatus.Builder> getTrafficStatusesBuilderList()

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

repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<Builder>

getTrafficStatusesCount()

public int getTrafficStatusesCount()

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

repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

getTrafficStatusesList()

public List<TrafficTargetStatus> getTrafficStatusesList()

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

repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<TrafficTargetStatus>

getTrafficStatusesOrBuilder(int index)

public TrafficTargetStatusOrBuilder getTrafficStatusesOrBuilder(int index)

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

repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
TrafficTargetStatusOrBuilder

getTrafficStatusesOrBuilderList()

public List<? extends TrafficTargetStatusOrBuilder> getTrafficStatusesOrBuilderList()

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

repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<? extends com.google.cloud.run.v2.TrafficTargetStatusOrBuilder>

getUid()

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

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The uid.

getUidBytes()

public ByteString getUidBytes()

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.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The last-modified time.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The last-modified time.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The last-modified time.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getUri()

public String getUri()

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

string uri = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The uri.

getUriBytes()

public ByteString getUriBytes()

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

string uri = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for uri.

hasBinaryAuthorization()

public boolean hasBinaryAuthorization()

Settings for the Binary Authorization feature.

.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17;

Returns
TypeDescription
boolean

Whether the binaryAuthorization field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasDeleteTime()

public boolean hasDeleteTime()

Output only. The deletion time.

.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the deleteTime field is set.

hasExpireTime()

public boolean hasExpireTime()

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

.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the expireTime field is set.

hasTemplate()

public boolean hasTemplate()

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

.google.cloud.run.v2.RevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the template field is set.

hasTerminalCondition()

public boolean hasTerminalCondition()

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.

.google.cloud.run.v2.Condition terminal_condition = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the terminalCondition field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The last-modified time.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeBinaryAuthorization(BinaryAuthorization value)

public Service.Builder mergeBinaryAuthorization(BinaryAuthorization value)

Settings for the Binary Authorization feature.

.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17;

Parameter
NameDescription
valueBinaryAuthorization
Returns
TypeDescription
Service.Builder

mergeCreateTime(Timestamp value)

public Service.Builder mergeCreateTime(Timestamp value)

Output only. The creation time.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Service.Builder

mergeDeleteTime(Timestamp value)

public Service.Builder mergeDeleteTime(Timestamp value)

Output only. The deletion time.

.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Service.Builder

mergeExpireTime(Timestamp value)

public Service.Builder mergeExpireTime(Timestamp value)

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

.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Service.Builder

mergeFrom(Service other)

public Service.Builder mergeFrom(Service other)
Parameter
NameDescription
otherService
Returns
TypeDescription
Service.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Service.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Service.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Service.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Service.Builder
Overrides

mergeTemplate(RevisionTemplate value)

public Service.Builder mergeTemplate(RevisionTemplate value)

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

.google.cloud.run.v2.RevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueRevisionTemplate
Returns
TypeDescription
Service.Builder

mergeTerminalCondition(Condition value)

public Service.Builder mergeTerminalCondition(Condition value)

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.

.google.cloud.run.v2.Condition terminal_condition = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueCondition
Returns
TypeDescription
Service.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Service.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Service.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Service.Builder mergeUpdateTime(Timestamp value)

Output only. The last-modified time.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Service.Builder

putAllAnnotations(Map<String,String> values)

public Service.Builder putAllAnnotations(Map<String,String> values)

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.

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

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

map<string, string> annotations = 6;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
Service.Builder

putAllLabels(Map<String,String> values)

public Service.Builder putAllLabels(Map<String,String> values)

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.

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

map<string, string> labels = 5;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
Service.Builder

putAnnotations(String key, String value)

public Service.Builder putAnnotations(String key, String value)

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.

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

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

map<string, string> annotations = 6;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
Service.Builder

putLabels(String key, String value)

public Service.Builder putLabels(String key, String value)

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.

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

map<string, string> labels = 5;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
Service.Builder

removeAnnotations(String key)

public Service.Builder removeAnnotations(String key)

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.

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

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

map<string, string> annotations = 6;

Parameter
NameDescription
keyString
Returns
TypeDescription
Service.Builder

removeConditions(int index)

public Service.Builder removeConditions(int index)

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.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
Service.Builder

removeLabels(String key)

public Service.Builder removeLabels(String key)

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.

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

map<string, string> labels = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
Service.Builder

removeTraffic(int index)

public Service.Builder removeTraffic(int index)

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.

repeated .google.cloud.run.v2.TrafficTarget traffic = 19;

Parameter
NameDescription
indexint
Returns
TypeDescription
Service.Builder

removeTrafficStatuses(int index)

public Service.Builder removeTrafficStatuses(int index)

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

repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
Service.Builder

setBinaryAuthorization(BinaryAuthorization value)

public Service.Builder setBinaryAuthorization(BinaryAuthorization value)

Settings for the Binary Authorization feature.

.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17;

Parameter
NameDescription
valueBinaryAuthorization
Returns
TypeDescription
Service.Builder

setBinaryAuthorization(BinaryAuthorization.Builder builderForValue)

public Service.Builder setBinaryAuthorization(BinaryAuthorization.Builder builderForValue)

Settings for the Binary Authorization feature.

.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17;

Parameter
NameDescription
builderForValueBinaryAuthorization.Builder
Returns
TypeDescription
Service.Builder

setClient(String value)

public Service.Builder setClient(String value)

Arbitrary identifier for the API client.

string client = 13;

Parameter
NameDescription
valueString

The client to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setClientBytes(ByteString value)

public Service.Builder setClientBytes(ByteString value)

Arbitrary identifier for the API client.

string client = 13;

Parameter
NameDescription
valueByteString

The bytes for client to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setClientVersion(String value)

public Service.Builder setClientVersion(String value)

Arbitrary version identifier for the API client.

string client_version = 14;

Parameter
NameDescription
valueString

The clientVersion to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setClientVersionBytes(ByteString value)

public Service.Builder setClientVersionBytes(ByteString value)

Arbitrary version identifier for the API client.

string client_version = 14;

Parameter
NameDescription
valueByteString

The bytes for clientVersion to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setConditions(int index, Condition value)

public Service.Builder setConditions(int index, Condition value)

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.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
valueCondition
Returns
TypeDescription
Service.Builder

setConditions(int index, Condition.Builder builderForValue)

public Service.Builder setConditions(int index, Condition.Builder builderForValue)

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.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
builderForValueCondition.Builder
Returns
TypeDescription
Service.Builder

setCreateTime(Timestamp value)

public Service.Builder setCreateTime(Timestamp value)

Output only. The creation time.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Service.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Service.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The creation time.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Service.Builder

setCreator(String value)

public Service.Builder setCreator(String value)

Output only. Email address of the authenticated creator.

string creator = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueString

The creator to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setCreatorBytes(ByteString value)

public Service.Builder setCreatorBytes(ByteString value)

Output only. Email address of the authenticated creator.

string creator = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueByteString

The bytes for creator to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setCustomAudiences(int index, String value)

public Service.Builder setCustomAudiences(int index, String value)

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.

repeated string custom_audiences = 37;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The customAudiences to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setDeleteTime(Timestamp value)

public Service.Builder setDeleteTime(Timestamp value)

Output only. The deletion time.

.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Service.Builder

setDeleteTime(Timestamp.Builder builderForValue)

public Service.Builder setDeleteTime(Timestamp.Builder builderForValue)

Output only. The deletion time.

.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Service.Builder

setDescription(String value)

public Service.Builder setDescription(String value)

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

string description = 2;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Service.Builder setDescriptionBytes(ByteString value)

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

string description = 2;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setEtag(String value)

public Service.Builder setEtag(String value)

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

string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueString

The etag to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Service.Builder setEtagBytes(ByteString value)

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

string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueByteString

The bytes for etag to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setExpireTime(Timestamp value)

public Service.Builder setExpireTime(Timestamp value)

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

.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Service.Builder

setExpireTime(Timestamp.Builder builderForValue)

public Service.Builder setExpireTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Service.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Service.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Service.Builder
Overrides

setGeneration(long value)

public Service.Builder setGeneration(long value)

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.

int64 generation = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valuelong

The generation to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setIngress(IngressTraffic value)

public Service.Builder setIngress(IngressTraffic value)

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

.google.cloud.run.v2.IngressTraffic ingress = 15;

Parameter
NameDescription
valueIngressTraffic

The ingress to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setIngressValue(int value)

public Service.Builder setIngressValue(int value)

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

.google.cloud.run.v2.IngressTraffic ingress = 15;

Parameter
NameDescription
valueint

The enum numeric value on the wire for ingress to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setLastModifier(String value)

public Service.Builder setLastModifier(String value)

Output only. Email address of the last authenticated modifier.

string last_modifier = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueString

The lastModifier to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setLastModifierBytes(ByteString value)

public Service.Builder setLastModifierBytes(ByteString value)

Output only. Email address of the last authenticated modifier.

string last_modifier = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueByteString

The bytes for lastModifier to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setLatestCreatedRevision(String value)

public Service.Builder setLatestCreatedRevision(String value)

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

string latest_created_revision = 34 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueString

The latestCreatedRevision to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setLatestCreatedRevisionBytes(ByteString value)

public Service.Builder setLatestCreatedRevisionBytes(ByteString value)

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

string latest_created_revision = 34 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes for latestCreatedRevision to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setLatestReadyRevision(String value)

public Service.Builder setLatestReadyRevision(String value)

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

string latest_ready_revision = 33 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueString

The latestReadyRevision to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setLatestReadyRevisionBytes(ByteString value)

public Service.Builder setLatestReadyRevisionBytes(ByteString value)

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

string latest_ready_revision = 33 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes for latestReadyRevision to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setLaunchStage(LaunchStage value)

public Service.Builder setLaunchStage(LaunchStage value)

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. <p> For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.

.google.api.LaunchStage launch_stage = 16;

Parameter
NameDescription
valuecom.google.api.LaunchStage

The launchStage to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setLaunchStageValue(int value)

public Service.Builder setLaunchStageValue(int value)

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. <p> For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.

.google.api.LaunchStage launch_stage = 16;

Parameter
NameDescription
valueint

The enum numeric value on the wire for launchStage to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setName(String value)

public Service.Builder setName(String value)

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}

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Service.Builder setNameBytes(ByteString value)

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}

string name = 1;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setObservedGeneration(long value)

public Service.Builder setObservedGeneration(long value)

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.

int64 observed_generation = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valuelong

The observedGeneration to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setReconciling(boolean value)

public Service.Builder setReconciling(boolean value)

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.

bool reconciling = 98 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueboolean

The reconciling to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Service.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Service.Builder
Overrides

setSatisfiesPzs(boolean value)

public Service.Builder setSatisfiesPzs(boolean value)

Output only. Reserved for future use.

bool satisfies_pzs = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueboolean

The satisfiesPzs to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setTemplate(RevisionTemplate value)

public Service.Builder setTemplate(RevisionTemplate value)

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

.google.cloud.run.v2.RevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueRevisionTemplate
Returns
TypeDescription
Service.Builder

setTemplate(RevisionTemplate.Builder builderForValue)

public Service.Builder setTemplate(RevisionTemplate.Builder builderForValue)

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

.google.cloud.run.v2.RevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
builderForValueRevisionTemplate.Builder
Returns
TypeDescription
Service.Builder

setTerminalCondition(Condition value)

public Service.Builder setTerminalCondition(Condition value)

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.

.google.cloud.run.v2.Condition terminal_condition = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueCondition
Returns
TypeDescription
Service.Builder

setTerminalCondition(Condition.Builder builderForValue)

public Service.Builder setTerminalCondition(Condition.Builder builderForValue)

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.

.google.cloud.run.v2.Condition terminal_condition = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueCondition.Builder
Returns
TypeDescription
Service.Builder

setTraffic(int index, TrafficTarget value)

public Service.Builder setTraffic(int index, TrafficTarget value)

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.

repeated .google.cloud.run.v2.TrafficTarget traffic = 19;

Parameters
NameDescription
indexint
valueTrafficTarget
Returns
TypeDescription
Service.Builder

setTraffic(int index, TrafficTarget.Builder builderForValue)

public Service.Builder setTraffic(int index, TrafficTarget.Builder builderForValue)

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.

repeated .google.cloud.run.v2.TrafficTarget traffic = 19;

Parameters
NameDescription
indexint
builderForValueTrafficTarget.Builder
Returns
TypeDescription
Service.Builder

setTrafficStatuses(int index, TrafficTargetStatus value)

public Service.Builder setTrafficStatuses(int index, TrafficTargetStatus value)

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

repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
valueTrafficTargetStatus
Returns
TypeDescription
Service.Builder

setTrafficStatuses(int index, TrafficTargetStatus.Builder builderForValue)

public Service.Builder setTrafficStatuses(int index, TrafficTargetStatus.Builder builderForValue)

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

repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
NameDescription
indexint
builderForValueTrafficTargetStatus.Builder
Returns
TypeDescription
Service.Builder

setUid(String value)

public Service.Builder setUid(String value)

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.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueString

The uid to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setUidBytes(ByteString value)

public Service.Builder setUidBytes(ByteString value)

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.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueByteString

The bytes for uid to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Service.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Service.Builder
Overrides

setUpdateTime(Timestamp value)

public Service.Builder setUpdateTime(Timestamp value)

Output only. The last-modified time.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Service.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Service.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The last-modified time.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Service.Builder

setUri(String value)

public Service.Builder setUri(String value)

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

string uri = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueString

The uri to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.

setUriBytes(ByteString value)

public Service.Builder setUriBytes(ByteString value)

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

string uri = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueByteString

The bytes for uri to set.

Returns
TypeDescription
Service.Builder

This builder for chaining.