- 0.73.0 (latest)
- 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
public
final
class
Service
extends
GeneratedMessageV3
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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ServiceImplements
ServiceOrBuilderStatic Fields
ANNOTATIONS_FIELD_NUMBER
public
static
final
int
ANNOTATIONS_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
BINARY_AUTHORIZATION_FIELD_NUMBER
public
static
final
int
BINARY_AUTHORIZATION_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
CLIENT_FIELD_NUMBER
public
static
final
int
CLIENT_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
CLIENT_VERSION_FIELD_NUMBER
public
static
final
int
CLIENT_VERSION_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
CONDITIONS_FIELD_NUMBER
public
static
final
int
CONDITIONS_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
CREATE_TIME_FIELD_NUMBER
public
static
final
int
CREATE_TIME_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
CREATOR_FIELD_NUMBER
public
static
final
int
CREATOR_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
DELETE_TIME_FIELD_NUMBER
public
static
final
int
DELETE_TIME_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
DESCRIPTION_FIELD_NUMBER
public
static
final
int
DESCRIPTION_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
ETAG_FIELD_NUMBER
public
static
final
int
ETAG_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
EXPIRE_TIME_FIELD_NUMBER
public
static
final
int
EXPIRE_TIME_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
GENERATION_FIELD_NUMBER
public
static
final
int
GENERATION_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
INGRESS_FIELD_NUMBER
public
static
final
int
INGRESS_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
LABELS_FIELD_NUMBER
public
static
final
int
LABELS_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
LAST_MODIFIER_FIELD_NUMBER
public
static
final
int
LAST_MODIFIER_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
LATEST_CREATED_REVISION_FIELD_NUMBER
public
static
final
int
LATEST_CREATED_REVISION_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
LATEST_READY_REVISION_FIELD_NUMBER
public
static
final
int
LATEST_READY_REVISION_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
LAUNCH_STAGE_FIELD_NUMBER
public
static
final
int
LAUNCH_STAGE_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
NAME_FIELD_NUMBER
public
static
final
int
NAME_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
OBSERVED_GENERATION_FIELD_NUMBER
public
static
final
int
OBSERVED_GENERATION_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
RECONCILING_FIELD_NUMBER
public
static
final
int
RECONCILING_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
TEMPLATE_FIELD_NUMBER
public
static
final
int
TEMPLATE_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
TERMINAL_CONDITION_FIELD_NUMBER
public
static
final
int
TERMINAL_CONDITION_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
TRAFFIC_FIELD_NUMBER
public
static
final
int
TRAFFIC_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
TRAFFIC_STATUSES_FIELD_NUMBER
public
static
final
int
TRAFFIC_STATUSES_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
UID_FIELD_NUMBER
public
static
final
int
UID_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
UPDATE_TIME_FIELD_NUMBER
public
static
final
int
UPDATE_TIME_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
URI_FIELD_NUMBER
public
static
final
int
URI_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
Static Methods
getDefaultInstance()
public
static
Service
getDefaultInstance
()
| Type | Description |
|---|---|
| Service |
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
| Type | Description |
|---|---|
| Descriptor |
newBuilder()
public
static
Service
.
Builder
newBuilder
()
| Type | Description |
|---|---|
| Service.Builder |
newBuilder(Service prototype)
public
static
Service
.
Builder
newBuilder
(
Service
prototype
)
| Name | Description |
|---|---|
| prototype | Service
|
| Type | Description |
|---|---|
| Service.Builder |
parseDelimitedFrom(InputStream input)
public
static
Service
parseDelimitedFrom
(
InputStream
input
)
| Name | Description |
|---|---|
| input | InputStream
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Service
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
| Name | Description |
| input | InputStream
|
| extensionRegistry | ExtensionRegistryLite
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| IOException |
parseFrom(byte[] data)
public
static
Service
parseFrom
(
byte
[]
data
)
| Name | Description |
|---|---|
| data | byte
[]
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Service
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
| Name | Description |
| data | byte
[]
|
| extensionRegistry | ExtensionRegistryLite
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| InvalidProtocolBufferException |
parseFrom(ByteString data)
public
static
Service
parseFrom
(
ByteString
data
)
| Name | Description |
|---|---|
| data | ByteString
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Service
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
| Name | Description |
| data | ByteString
|
| extensionRegistry | ExtensionRegistryLite
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public
static
Service
parseFrom
(
CodedInputStream
input
)
| Name | Description |
|---|---|
| input | CodedInputStream
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Service
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
| Name | Description |
| input | CodedInputStream
|
| extensionRegistry | ExtensionRegistryLite
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| IOException |
parseFrom(InputStream input)
public
static
Service
parseFrom
(
InputStream
input
)
| Name | Description |
|---|---|
| input | InputStream
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Service
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
| Name | Description |
| input | InputStream
|
| extensionRegistry | ExtensionRegistryLite
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| IOException |
parseFrom(ByteBuffer data)
public
static
Service
parseFrom
(
ByteBuffer
data
)
| Name | Description |
|---|---|
| data | ByteBuffer
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Service
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
| Name | Description |
| data | ByteBuffer
|
| extensionRegistry | ExtensionRegistryLite
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| InvalidProtocolBufferException |
parser()
public
static
Parser<Service>
parser
()
| Type | Description |
|---|---|
| Parser < Service > |
Methods
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. 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;
| Name | Description |
|---|---|
| key | String
|
| Type | Description |
|---|---|
| boolean |
containsLabels(String key)
public
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;
| Name | Description |
|---|---|
| key | String
|
| Type | Description |
|---|---|
| boolean |
equals(Object obj)
public
boolean
equals
(
Object
obj
)
| Name | Description |
|---|---|
| obj | Object
|
| Type | Description |
|---|---|
| boolean |
getAnnotations()
public
Map<String
,
String
>
getAnnotations
()
Use #getAnnotationsMap() instead.
| Type | Description |
|---|---|
| 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. 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;
| Type | Description |
|---|---|
| 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. 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;
| Type | Description |
|---|---|
| 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. 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;
| Name | Description |
|---|---|
| key | String
|
| defaultValue | String
|
| Type | Description |
|---|---|
| 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. 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;
| Name | Description |
|---|---|
| key | String
|
| Type | Description |
|---|---|
| String |
getBinaryAuthorization()
public
BinaryAuthorization
getBinaryAuthorization
()
Settings for the Binary Authorization feature.
.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17;
| Type | Description |
| BinaryAuthorization | The binaryAuthorization. |
getBinaryAuthorizationOrBuilder()
public
BinaryAuthorizationOrBuilder
getBinaryAuthorizationOrBuilder
()
Settings for the Binary Authorization feature.
.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17;
| Type | Description |
|---|---|
| BinaryAuthorizationOrBuilder |
getClient()
public
String
getClient
()
Arbitrary identifier for the API client.
string client = 13;
| Type | Description |
|---|---|
| String | The client. |
getClientBytes()
public
ByteString
getClientBytes
()
Arbitrary identifier for the API client.
string client = 13;
| Type | Description |
|---|---|
| ByteString | The bytes for client. |
getClientVersion()
public
String
getClientVersion
()
Arbitrary version identifier for the API client.
string client_version = 14;
| Type | Description |
|---|---|
| String | The clientVersion. |
getClientVersionBytes()
public
ByteString
getClientVersionBytes
()
Arbitrary version identifier for the API client.
string client_version = 14;
| Type | Description |
| 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];
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| Condition |
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];
| Type | Description |
|---|---|
| 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];
| Type | Description |
|---|---|
| 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];
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| 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];
| Type | Description |
|---|---|
| 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];
| Type | Description |
|---|---|
| Timestamp | The createTime. |
getCreateTimeOrBuilder()
public
TimestampOrBuilder
getCreateTimeOrBuilder
()
Output only. The creation time.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
|---|---|
| TimestampOrBuilder |
getCreator()
public
String
getCreator
()
Output only. Email address of the authenticated creator.
string creator = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
|---|---|
| String | The creator. |
getCreatorBytes()
public
ByteString
getCreatorBytes
()
Output only. Email address of the authenticated creator.
string creator = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
|---|---|
| ByteString | The bytes for creator. |
getDefaultInstanceForType()
public
Service
getDefaultInstanceForType
()
| Type | Description |
|---|---|
| Service |
getDeleteTime()
public
Timestamp
getDeleteTime
()
Output only. The deletion time.
.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
|---|---|
| Timestamp | The deleteTime. |
getDeleteTimeOrBuilder()
public
TimestampOrBuilder
getDeleteTimeOrBuilder
()
Output only. The deletion time.
.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
|---|---|
| TimestampOrBuilder |
getDescription()
public
String
getDescription
()
User-provided description of the Service. This field currently has a 512-character limit.
string description = 2;
| Type | Description |
|---|---|
| String | The description. |
getDescriptionBytes()
public
ByteString
getDescriptionBytes
()
User-provided description of the Service. This field currently has a 512-character limit.
string description = 2;
| Type | Description |
| ByteString | The bytes for description. |
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];
| Type | Description |
|---|---|
| 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];
| Type | Description |
|---|---|
| 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];
| Type | Description |
|---|---|
| Timestamp | The expireTime. |
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];
| Type | Description |
|---|---|
| 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];
| Type | Description |
|---|---|
| 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;
| Type | Description |
|---|---|
| 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;
| Type | Description |
| int | The enum numeric value on the wire for ingress. |
getLabels()
public
Map<String
,
String
>
getLabels
()
Use #getLabelsMap() instead.
| Type | Description |
|---|---|
| Map < String , String > |
getLabelsCount()
public
int
getLabelsCount
()
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;
| Type | Description |
|---|---|
| int |
getLabelsMap()
public
Map<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 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;
| Type | Description |
|---|---|
| Map < String , String > |
getLabelsOrDefault(String key, String defaultValue)
public
String
getLabelsOrDefault
(
String
key
,
String
defaultValue
)
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;
| Name | Description |
|---|---|
| key | String
|
| defaultValue | String
|
| Type | Description |
|---|---|
| String |
getLabelsOrThrow(String key)
public
String
getLabelsOrThrow
(
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;
| Name | Description |
|---|---|
| key | String
|
| Type | Description |
|---|---|
| String |
getLastModifier()
public
String
getLastModifier
()
Output only. Email address of the last authenticated modifier.
string last_modifier = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
|---|---|
| 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];
| Type | Description |
| 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) = { ... }
| Type | Description |
| 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) = { ... }
| Type | Description |
| 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) = { ... }
| Type | Description |
| 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) = { ... }
| Type | Description |
| 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.
.google.api.LaunchStage launch_stage = 16;
| Type | Description |
|---|---|
| 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.
.google.api.LaunchStage launch_stage = 16;
| Type | Description |
| int | The enum numeric value on the wire for launchStage. |
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;
| Type | Description |
|---|---|
| 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;
| Type | Description |
|---|---|
| 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];
| Type | Description |
| long | The observedGeneration. |
getParserForType()
public
Parser<Service>
getParserForType
()
| Type | Description |
|---|---|
| Parser < Service > |
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];
| Type | Description |
|---|---|
| boolean | The reconciling. |
getSerializedSize()
public
int
getSerializedSize
()
| Type | Description |
|---|---|
| int |
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];
| Type | Description |
|---|---|
| RevisionTemplate | The template. |
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];
| Type | Description |
|---|---|
| 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];
| Type | Description |
|---|---|
| Condition | The terminalCondition. |
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];
| Type | Description |
|---|---|
| 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;
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| TrafficTarget |
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;
| Type | Description |
|---|---|
| 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;
| Type | Description |
|---|---|
| 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;
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| 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;
| Type | Description |
|---|---|
| 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];
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| TrafficTargetStatus |
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];
| Type | Description |
|---|---|
| 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];
| Type | Description |
|---|---|
| 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];
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| 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];
| Type | Description |
|---|---|
| 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];
| Type | Description |
|---|---|
| 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];
| Type | Description |
|---|---|
| ByteString | The bytes for uid. |
getUnknownFields()
public
final
UnknownFieldSet
getUnknownFields
()
| Type | Description |
|---|---|
| UnknownFieldSet |
getUpdateTime()
public
Timestamp
getUpdateTime
()
Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
|---|---|
| Timestamp | The updateTime. |
getUpdateTimeOrBuilder()
public
TimestampOrBuilder
getUpdateTimeOrBuilder
()
Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
|---|---|
| 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];
| Type | Description |
|---|---|
| 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];
| Type | Description |
|---|---|
| ByteString | The bytes for uri. |
hasBinaryAuthorization()
public
boolean
hasBinaryAuthorization
()
Settings for the Binary Authorization feature.
.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17;
| Type | Description |
| 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];
| Type | Description |
| 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];
| Type | Description |
| 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];
| Type | Description |
| 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];
| Type | Description |
| 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];
| Type | Description |
| 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];
| Type | Description |
| boolean | Whether the updateTime field is set. |
hashCode()
public
int
hashCode
()
| Type | Description |
|---|---|
| int |
internalGetFieldAccessorTable()
protected
GeneratedMessageV3
.
FieldAccessorTable
internalGetFieldAccessorTable
()
| Type | Description |
|---|---|
| FieldAccessorTable |
internalGetMapField(int number)
protected
MapField
internalGetMapField
(
int
number
)
| Name | Description |
|---|---|
| number | int
|
| Type | Description |
|---|---|
| MapField |
isInitialized()
public
final
boolean
isInitialized
()
| Type | Description |
|---|---|
| boolean |
newBuilderForType()
public
Service
.
Builder
newBuilderForType
()
| Type | Description |
|---|---|
| Service.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected
Service
.
Builder
newBuilderForType
(
GeneratedMessageV3
.
BuilderParent
parent
)
| Name | Description |
|---|---|
| parent | BuilderParent
|
| Type | Description |
|---|---|
| Service.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected
Object
newInstance
(
GeneratedMessageV3
.
UnusedPrivateParameter
unused
)
| Name | Description |
| unused | UnusedPrivateParameter
|
| Type | Description |
|---|---|
| Object |
toBuilder()
public
Service
.
Builder
toBuilder
()
| Type | Description |
|---|---|
| Service.Builder |
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
| Name | Description |
|---|---|
| output | CodedOutputStream
|
| Type | Description |
|---|---|
| IOException |
