Interface ServiceOrBuilder (0.4.0)

public interface ServiceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract 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. Cloud Run will populate some annotations using 'run.googleapis.com' or 'serving.knative.dev' namespaces. This field follows Kubernetes annotations' namespacing, limits, and rules. More info: https://kubernetes.io/docs/user-guide/annotations

map<string, string> annotations = 6;

Parameter

Name	Description
key	`String`

Returns

Type	Description
boolean

containsLabels(String key)

public abstract boolean containsLabels(String key)

Map of string keys and values that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with 'run.googleapis.com' or 'serving.knative.dev' namespaces. Those labels are read-only, and user changes will not be preserved.

map<string, string> labels = 5;

Parameter

Name	Description
key	`String`

Returns

Type	Description
boolean

getAnnotations()

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns

Type	Description
Map<String,String>

getAnnotationsCount()

public abstract int getAnnotationsCount()

map<string, string> annotations = 6;

Returns

Type	Description
int

getAnnotationsMap()

public abstract Map<String,String> getAnnotationsMap()

map<string, string> annotations = 6;

Returns

Type	Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public abstract String getAnnotationsOrDefault(String key, String defaultValue)

map<string, string> annotations = 6;

Parameters

Name	Description
key	`String`
defaultValue	`String`

Returns

Type	Description
String

getAnnotationsOrThrow(String key)

public abstract String getAnnotationsOrThrow(String key)

map<string, string> annotations = 6;

Parameter

Name	Description
key	`String`

Returns

Type	Description
String

getBinaryAuthorization()

public abstract BinaryAuthorization getBinaryAuthorization()

Settings for the Binary Authorization feature.

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

Returns

Type	Description
BinaryAuthorization	The binaryAuthorization.

getBinaryAuthorizationOrBuilder()

public abstract BinaryAuthorizationOrBuilder getBinaryAuthorizationOrBuilder()

Settings for the Binary Authorization feature.

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

Returns

Type	Description
BinaryAuthorizationOrBuilder

getClient()

public abstract String getClient()

Arbitrary identifier for the API client.

string client = 13;

Returns

Type	Description
String	The client.

getClientBytes()

public abstract ByteString getClientBytes()

Arbitrary identifier for the API client.

string client = 13;

Returns

Type	Description
ByteString	The bytes for client.

getClientVersion()

public abstract String getClientVersion()

Arbitrary version identifier for the API client.

string client_version = 14;

Returns

Type	Description
String	The clientVersion.

getClientVersionBytes()

public abstract ByteString getClientVersionBytes()

Arbitrary version identifier for the API client.

string client_version = 14;

Returns

Type	Description
ByteString	The bytes for clientVersion.

getConditions(int index)

public abstract 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

Name	Description
index	`int`

Returns

Type	Description
Condition

getConditionsCount()

public abstract int getConditionsCount()

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

Returns

Type	Description
int

getConditionsList()

public abstract List<Condition> getConditionsList()

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

Returns

Type	Description
List<Condition>

getConditionsOrBuilder(int index)

public abstract ConditionOrBuilder getConditionsOrBuilder(int index)

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

Parameter

Name	Description
index	`int`

Returns

Type	Description
ConditionOrBuilder

getConditionsOrBuilderList()

public abstract List<? extends ConditionOrBuilder> getConditionsOrBuilderList()

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

Returns

Type	Description
List<? extends com.google.cloud.run.v2.ConditionOrBuilder>

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The creation time.

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

Returns

Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation time.

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

Returns

Type	Description
TimestampOrBuilder

getCreator()

public abstract String getCreator()

Output only. Email address of the authenticated creator.

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

Returns

Type	Description
String	The creator.

getCreatorBytes()

public abstract ByteString getCreatorBytes()

Output only. Email address of the authenticated creator.

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

Returns

Type	Description
ByteString	The bytes for creator.

getDeleteTime()

public abstract Timestamp getDeleteTime()

Output only. The deletion time.

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

Returns

Type	Description
Timestamp	The deleteTime.

getDeleteTimeOrBuilder()

public abstract TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. The deletion time.

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

Returns

Type	Description
TimestampOrBuilder

getDescription()

public abstract String getDescription()

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

string description = 2;

Returns

Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

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

string description = 2;

Returns

Type	Description
ByteString	The bytes for description.

getEtag()

public abstract 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

Type	Description
String	The etag.

getEtagBytes()

public abstract 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

Type	Description
ByteString	The bytes for etag.

getExpireTime()

public abstract 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

Type	Description
Timestamp	The expireTime.

getExpireTimeOrBuilder()

public abstract 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

Type	Description
TimestampOrBuilder

getGeneration()

public abstract 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

Type	Description
long	The generation.

getIngress()

public abstract 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

Type	Description
IngressTraffic	The ingress.

getIngressValue()

public abstract 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

Type	Description
int	The enum numeric value on the wire for ingress.

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns

Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

map<string, string> labels = 5;

Returns

Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

map<string, string> labels = 5;

Returns

Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

map<string, string> labels = 5;

Parameters

Name	Description
key	`String`
defaultValue	`String`

Returns

Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

map<string, string> labels = 5;

Parameter

Name	Description
key	`String`

Returns

Type	Description
String

getLastModifier()

public abstract String getLastModifier()

Output only. Email address of the last authenticated modifier.

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

Returns

Type	Description
String	The lastModifier.

getLastModifierBytes()

public abstract ByteString getLastModifierBytes()

Output only. Email address of the last authenticated modifier.

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

Returns

Type	Description
ByteString	The bytes for lastModifier.

getLatestCreatedRevision()

public abstract 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

Type	Description
String	The latestCreatedRevision.

getLatestCreatedRevisionBytes()

public abstract 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

Type	Description
ByteString	The bytes for latestCreatedRevision.

getLatestReadyRevision()

public abstract 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

Type	Description
String	The latestReadyRevision.

getLatestReadyRevisionBytes()

public abstract 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

Type	Description
ByteString	The bytes for latestReadyRevision.

getLaunchStage()

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

.google.api.LaunchStage launch_stage = 16;

Returns

Type	Description
com.google.api.LaunchStage	The launchStage.

getLaunchStageValue()

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

.google.api.LaunchStage launch_stage = 16;

Returns

Type	Description
int	The enum numeric value on the wire for launchStage.

getName()

public abstract 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

Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

string name = 1;

Returns

Type	Description
ByteString	The bytes for name.

getObservedGeneration()

public abstract 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

Type	Description
long	The observedGeneration.

getReconciling()

public abstract 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

Type	Description
boolean	The reconciling.

getTemplate()

public abstract 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

Type	Description
RevisionTemplate	The template.

getTemplateOrBuilder()

public abstract 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

Type	Description
RevisionTemplateOrBuilder

getTerminalCondition()

public abstract 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

Type	Description
Condition	The terminalCondition.

getTerminalConditionOrBuilder()

public abstract ConditionOrBuilder getTerminalConditionOrBuilder()

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

Returns

Type	Description
ConditionOrBuilder

getTraffic(int index)

public abstract 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

Name	Description
index	`int`

Returns

Type	Description
TrafficTarget

getTrafficCount()

public abstract 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

Type	Description
int

getTrafficList()

public abstract 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

Type	Description
List<TrafficTarget>

getTrafficOrBuilder(int index)

public abstract 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

Name	Description
index	`int`

Returns

Type	Description
TrafficTargetOrBuilder

getTrafficOrBuilderList()

public abstract 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

Type	Description
List<? extends com.google.cloud.run.v2.TrafficTargetOrBuilder>

getTrafficStatuses(int index)

public abstract 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

Name	Description
index	`int`

Returns

Type	Description
TrafficTargetStatus

getTrafficStatusesCount()

public abstract 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

Type	Description
int

getTrafficStatusesList()

public abstract 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

Type	Description
List<TrafficTargetStatus>

getTrafficStatusesOrBuilder(int index)

public abstract 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

Name	Description
index	`int`

Returns

Type	Description
TrafficTargetStatusOrBuilder

getTrafficStatusesOrBuilderList()

public abstract 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

Type	Description
List<? extends com.google.cloud.run.v2.TrafficTargetStatusOrBuilder>

getUid()

public abstract 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

Type	Description
String	The uid.

getUidBytes()

public abstract 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

Type	Description
ByteString	The bytes for uid.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The last-modified time.

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

Returns

Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The last-modified time.

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

Returns

Type	Description
TimestampOrBuilder

getUri()

public abstract String getUri()

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

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

Returns

Type	Description
String	The uri.

getUriBytes()

public abstract ByteString getUriBytes()

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

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

Returns

Type	Description
ByteString	The bytes for uri.

hasBinaryAuthorization()

public abstract boolean hasBinaryAuthorization()

Settings for the Binary Authorization feature.

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

Returns

Type	Description
boolean	Whether the binaryAuthorization field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The creation time.

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

Returns

Type	Description
boolean	Whether the createTime field is set.

hasDeleteTime()

public abstract boolean hasDeleteTime()

Output only. The deletion time.

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

Returns

Type	Description
boolean	Whether the deleteTime field is set.

hasExpireTime()

public abstract 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

Type	Description
boolean	Whether the expireTime field is set.

hasTemplate()

public abstract 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

Type	Description
boolean	Whether the template field is set.

hasTerminalCondition()

public abstract boolean hasTerminalCondition()

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

Returns

Type	Description
boolean	Whether the terminalCondition field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The last-modified time.

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

Returns

Type	Description
boolean	Whether the updateTime field is set.