Class Service (0.14.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 0.78.0 (latest)
- 0.76.0
- 0.75.0
- 0.74.0
- 0.73.0
- 0.72.0
- 0.70.0
- 0.68.0
- 0.67.0
- 0.64.0
- 0.63.0
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.5
- 0.2.1
- 0.1.2
publicfinalclass ServiceextendsGeneratedMessageV3implementsServiceOrBuilderService 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ServiceImplements
ServiceOrBuilderInherited Members
Static Fields
ANNOTATIONS_FIELD_NUMBER
publicstaticfinalintANNOTATIONS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
BINARY_AUTHORIZATION_FIELD_NUMBER
publicstaticfinalintBINARY_AUTHORIZATION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CLIENT_FIELD_NUMBER
publicstaticfinalintCLIENT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CLIENT_VERSION_FIELD_NUMBER
publicstaticfinalintCLIENT_VERSION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CONDITIONS_FIELD_NUMBER
publicstaticfinalintCONDITIONS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CREATE_TIME_FIELD_NUMBER
publicstaticfinalintCREATE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CREATOR_FIELD_NUMBER
publicstaticfinalintCREATOR_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DELETE_TIME_FIELD_NUMBER
publicstaticfinalintDELETE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DESCRIPTION_FIELD_NUMBER
publicstaticfinalintDESCRIPTION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ETAG_FIELD_NUMBER
publicstaticfinalintETAG_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
EXPIRE_TIME_FIELD_NUMBER
publicstaticfinalintEXPIRE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
GENERATION_FIELD_NUMBER
publicstaticfinalintGENERATION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
INGRESS_FIELD_NUMBER
publicstaticfinalintINGRESS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
LABELS_FIELD_NUMBER
publicstaticfinalintLABELS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
LAST_MODIFIER_FIELD_NUMBER
publicstaticfinalintLAST_MODIFIER_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
LATEST_CREATED_REVISION_FIELD_NUMBER
publicstaticfinalintLATEST_CREATED_REVISION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
LATEST_READY_REVISION_FIELD_NUMBER
publicstaticfinalintLATEST_READY_REVISION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
LAUNCH_STAGE_FIELD_NUMBER
publicstaticfinalintLAUNCH_STAGE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NAME_FIELD_NUMBER
publicstaticfinalintNAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
OBSERVED_GENERATION_FIELD_NUMBER
publicstaticfinalintOBSERVED_GENERATION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RECONCILING_FIELD_NUMBER
publicstaticfinalintRECONCILING_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TEMPLATE_FIELD_NUMBER
publicstaticfinalintTEMPLATE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TERMINAL_CONDITION_FIELD_NUMBER
publicstaticfinalintTERMINAL_CONDITION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TRAFFIC_FIELD_NUMBER
publicstaticfinalintTRAFFIC_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TRAFFIC_STATUSES_FIELD_NUMBER
publicstaticfinalintTRAFFIC_STATUSES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
UID_FIELD_NUMBER
publicstaticfinalintUID_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
publicstaticfinalintUPDATE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
URI_FIELD_NUMBER
publicstaticfinalintURI_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
publicstaticServicegetDefaultInstance()| Returns | |
|---|---|
| Type | Description |
Service |
|
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
publicstaticService.BuildernewBuilder()| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
newBuilder(Service prototype)
publicstaticService.BuildernewBuilder(Serviceprototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
Service |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
parseDelimitedFrom(InputStream input)
publicstaticServiceparseDelimitedFrom(InputStreaminput)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticServiceparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
publicstaticServiceparseFrom(byte[]data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticServiceparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
publicstaticServiceparseFrom(ByteStringdata)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticServiceparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
publicstaticServiceparseFrom(CodedInputStreaminput)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticServiceparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
publicstaticServiceparseFrom(InputStreaminput)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticServiceparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
publicstaticServiceparseFrom(ByteBufferdata)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticServiceparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
publicstaticParser<Service>parser()| Returns | |
|---|---|
| Type | Description |
Parser<Service> |
|
Methods
containsAnnotations(String key)
publicbooleancontainsAnnotations(Stringkey) 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. All system annotations in v1 now
have a corresponding field in v2 Service.
<p>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)
publicbooleancontainsLabels(Stringkey) 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
<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 | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
equals(Object obj)
publicbooleanequals(Objectobj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAnnotations()
publicMap<String,String>getAnnotations()Use #getAnnotationsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getAnnotationsCount()
publicintgetAnnotationsCount() 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. All system annotations in v1 now
have a corresponding field in v2 Service.
<p>This field follows Kubernetes
annotations' namespacing, limits, and rules. More info:
https://kubernetes.io/docs/user-guide/annotations
map<string, string> annotations = 6;
| Returns | |
|---|---|
| Type | Description |
int |
|
getAnnotationsMap()
publicMap<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. All system annotations in v1 now
have a corresponding field in v2 Service.
<p>This field follows Kubernetes
annotations' namespacing, limits, and rules. More info:
https://kubernetes.io/docs/user-guide/annotations
map<string, string> annotations = 6;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getAnnotationsOrDefault(String key, String defaultValue)
publicStringgetAnnotationsOrDefault(Stringkey,StringdefaultValue) 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. All system annotations in v1 now
have a corresponding field in v2 Service.
<p>This field follows Kubernetes
annotations' namespacing, limits, and rules. More info:
https://kubernetes.io/docs/user-guide/annotations
map<string, string> annotations = 6;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getAnnotationsOrThrow(String key)
publicStringgetAnnotationsOrThrow(Stringkey) 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. All system annotations in v1 now
have a corresponding field in v2 Service.
<p>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 |
String |
|
getBinaryAuthorization()
publicBinaryAuthorizationgetBinaryAuthorization()Settings for the Binary Authorization feature.
.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17;
| Returns | |
|---|---|
| Type | Description |
BinaryAuthorization |
The binaryAuthorization. |
getBinaryAuthorizationOrBuilder()
publicBinaryAuthorizationOrBuildergetBinaryAuthorizationOrBuilder()Settings for the Binary Authorization feature.
.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17;
| Returns | |
|---|---|
| Type | Description |
BinaryAuthorizationOrBuilder |
|
getClient()
publicStringgetClient()Arbitrary identifier for the API client.
string client = 13;
| Returns | |
|---|---|
| Type | Description |
String |
The client. |
getClientBytes()
publicByteStringgetClientBytes()Arbitrary identifier for the API client.
string client = 13;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for client. |
getClientVersion()
publicStringgetClientVersion()Arbitrary version identifier for the API client.
string client_version = 14;
| Returns | |
|---|---|
| Type | Description |
String |
The clientVersion. |
getClientVersionBytes()
publicByteStringgetClientVersionBytes()Arbitrary version identifier for the API client.
string client_version = 14;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for clientVersion. |
getConditions(int index)
publicConditiongetConditions(intindex) 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()
publicintgetConditionsCount() 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 | |
|---|---|
| Type | Description |
int |
|
getConditionsList()
publicList<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 | |
|---|---|
| Type | Description |
List<Condition> |
|
getConditionsOrBuilder(int index)
publicConditionOrBuildergetConditionsOrBuilder(intindex) 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 |
ConditionOrBuilder |
|
getConditionsOrBuilderList()
publicList<?extendsConditionOrBuilder>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 | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.run.v2.ConditionOrBuilder> |
|
getCreateTime()
publicTimestampgetCreateTime()Output only. The creation time.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
publicTimestampOrBuildergetCreateTimeOrBuilder()Output only. The creation time.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getCreator()
publicStringgetCreator()Output only. Email address of the authenticated creator.
string creator = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The creator. |
getCreatorBytes()
publicByteStringgetCreatorBytes()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. |
getDefaultInstanceForType()
publicServicegetDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Service |
|
getDeleteTime()
publicTimestampgetDeleteTime()Output only. The deletion time.
.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The deleteTime. |
getDeleteTimeOrBuilder()
publicTimestampOrBuildergetDeleteTimeOrBuilder()Output only. The deletion time.
.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDescription()
publicStringgetDescription()User-provided description of the Service. This field currently has a 512-character limit.
string description = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
publicByteStringgetDescriptionBytes()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()
publicStringgetEtag()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()
publicByteStringgetEtagBytes()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()
publicTimestampgetExpireTime()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()
publicTimestampOrBuildergetExpireTimeOrBuilder()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()
publiclonggetGeneration() 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()
publicIngressTrafficgetIngress()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()
publicintgetIngressValue()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()
publicMap<String,String>getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
publicintgetLabelsCount() 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
<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 | |
|---|---|
| Type | Description |
int |
|
getLabelsMap()
publicMap<String,String>getLabelsMap() 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
<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 | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
publicStringgetLabelsOrDefault(Stringkey,StringdefaultValue) 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
<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 | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLabelsOrThrow(String key)
publicStringgetLabelsOrThrow(Stringkey) 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
<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 | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLastModifier()
publicStringgetLastModifier()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()
publicByteStringgetLastModifierBytes()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()
publicStringgetLatestCreatedRevision() 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()
publicByteStringgetLatestCreatedRevisionBytes() 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()
publicStringgetLatestReadyRevision() 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()
publicByteStringgetLatestReadyRevisionBytes() 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()
publicLaunchStagegetLaunchStage() 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()
publicintgetLaunchStageValue() 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()
publicStringgetName()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()
publicByteStringgetNameBytes()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 |
ByteString |
The bytes for name. |
getObservedGeneration()
publiclonggetObservedGeneration() 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. |
getParserForType()
publicParser<Service>getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<Service> |
|
getReconciling()
publicbooleangetReconciling() 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. |
getSerializedSize()
publicintgetSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
getTemplate()
publicRevisionTemplategetTemplate()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()
publicRevisionTemplateOrBuildergetTemplateOrBuilder()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()
publicConditiongetTerminalCondition() 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()
publicConditionOrBuildergetTerminalConditionOrBuilder() 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 |
ConditionOrBuilder |
|
getTraffic(int index)
publicTrafficTargetgetTraffic(intindex) 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()
publicintgetTrafficCount() 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()
publicList<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)
publicTrafficTargetOrBuildergetTrafficOrBuilder(intindex) 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()
publicList<?extendsTrafficTargetOrBuilder>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)
publicTrafficTargetStatusgetTrafficStatuses(intindex) 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()
publicintgetTrafficStatusesCount() 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()
publicList<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)
publicTrafficTargetStatusOrBuildergetTrafficStatusesOrBuilder(intindex) 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()
publicList<?extendsTrafficTargetStatusOrBuilder>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()
publicStringgetUid()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()
publicByteStringgetUidBytes()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. |
getUnknownFields()
publicfinalUnknownFieldSetgetUnknownFields()| Returns | |
|---|---|
| Type | Description |
UnknownFieldSet |
|
getUpdateTime()
publicTimestampgetUpdateTime()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()
publicTimestampOrBuildergetUpdateTimeOrBuilder()Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getUri()
publicStringgetUri()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()
publicByteStringgetUriBytes()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()
publicbooleanhasBinaryAuthorization()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()
publicbooleanhasCreateTime()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()
publicbooleanhasDeleteTime()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()
publicbooleanhasExpireTime()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()
publicbooleanhasTemplate()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()
publicbooleanhasTerminalCondition() 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 |
boolean |
Whether the terminalCondition field is set. |
hasUpdateTime()
publicbooleanhasUpdateTime()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. |
hashCode()
publicinthashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapField(int number)
protectedMapFieldinternalGetMapField(intnumber)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
MapField |
|
isInitialized()
publicfinalbooleanisInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
publicService.BuildernewBuilderForType()| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedService.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
publicService.BuildertoBuilder()| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|