- 0.48.0 (latest)
- 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 static final class Service.Builder extends GeneratedMessageV3.Builder<Service.Builder> implements ServiceOrBuilder
Service acts as a top-level container that manages a set of configurations and revision templates which implement a network service. Service exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership.
Protobuf type google.cloud.run.v2.Service
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Service.BuilderImplements
ServiceOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllConditions(Iterable<? extends Condition> values)
public Service.Builder addAllConditions(Iterable<? extends Condition> values)
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Service does not
reach its Serving state. See comments in reconciling
for additional
information on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
values |
Iterable<? extends com.google.cloud.run.v2.Condition> |
Returns | |
---|---|
Type | Description |
Service.Builder |
addAllCustomAudiences(Iterable<String> values)
public Service.Builder addAllCustomAudiences(Iterable<String> values)
One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.
repeated string custom_audiences = 37;
Parameter | |
---|---|
Name | Description |
values |
Iterable<String> The customAudiences to add. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
addAllTraffic(Iterable<? extends TrafficTarget> values)
public Service.Builder addAllTraffic(Iterable<? extends TrafficTarget> values)
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values |
Iterable<? extends com.google.cloud.run.v2.TrafficTarget> |
Returns | |
---|---|
Type | Description |
Service.Builder |
addAllTrafficStatuses(Iterable<? extends TrafficTargetStatus> values)
public Service.Builder addAllTrafficStatuses(Iterable<? extends TrafficTargetStatus> values)
Output only. Detailed status information for corresponding traffic targets.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
values |
Iterable<? extends com.google.cloud.run.v2.TrafficTargetStatus> |
Returns | |
---|---|
Type | Description |
Service.Builder |
addConditions(Condition value)
public Service.Builder addConditions(Condition value)
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Service does not
reach its Serving state. See comments in reconciling
for additional
information on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Condition |
Returns | |
---|---|
Type | Description |
Service.Builder |
addConditions(Condition.Builder builderForValue)
public Service.Builder addConditions(Condition.Builder builderForValue)
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Service does not
reach its Serving state. See comments in reconciling
for additional
information on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Condition.Builder |
Returns | |
---|---|
Type | Description |
Service.Builder |
addConditions(int index, Condition value)
public Service.Builder addConditions(int index, Condition value)
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Service does not
reach its Serving state. See comments in reconciling
for additional
information on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
Condition |
Returns | |
---|---|
Type | Description |
Service.Builder |
addConditions(int index, Condition.Builder builderForValue)
public Service.Builder addConditions(int index, Condition.Builder builderForValue)
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Service does not
reach its Serving state. See comments in reconciling
for additional
information on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
Condition.Builder |
Returns | |
---|---|
Type | Description |
Service.Builder |
addConditionsBuilder()
public Condition.Builder addConditionsBuilder()
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Service does not
reach its Serving state. See comments in reconciling
for additional
information on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Condition.Builder |
addConditionsBuilder(int index)
public Condition.Builder addConditionsBuilder(int index)
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Service does not
reach its Serving state. See comments in reconciling
for additional
information on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Condition.Builder |
addCustomAudiences(String value)
public Service.Builder addCustomAudiences(String value)
One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.
repeated string custom_audiences = 37;
Parameter | |
---|---|
Name | Description |
value |
String The customAudiences to add. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
addCustomAudiencesBytes(ByteString value)
public Service.Builder addCustomAudiencesBytes(ByteString value)
One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.
repeated string custom_audiences = 37;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes of the customAudiences to add. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Service.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Service.Builder |
addTraffic(TrafficTarget value)
public Service.Builder addTraffic(TrafficTarget value)
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
TrafficTarget |
Returns | |
---|---|
Type | Description |
Service.Builder |
addTraffic(TrafficTarget.Builder builderForValue)
public Service.Builder addTraffic(TrafficTarget.Builder builderForValue)
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
TrafficTarget.Builder |
Returns | |
---|---|
Type | Description |
Service.Builder |
addTraffic(int index, TrafficTarget value)
public Service.Builder addTraffic(int index, TrafficTarget value)
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
TrafficTarget |
Returns | |
---|---|
Type | Description |
Service.Builder |
addTraffic(int index, TrafficTarget.Builder builderForValue)
public Service.Builder addTraffic(int index, TrafficTarget.Builder builderForValue)
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
TrafficTarget.Builder |
Returns | |
---|---|
Type | Description |
Service.Builder |
addTrafficBuilder()
public TrafficTarget.Builder addTrafficBuilder()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
TrafficTarget.Builder |
addTrafficBuilder(int index)
public TrafficTarget.Builder addTrafficBuilder(int index)
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
TrafficTarget.Builder |
addTrafficStatuses(TrafficTargetStatus value)
public Service.Builder addTrafficStatuses(TrafficTargetStatus value)
Output only. Detailed status information for corresponding traffic targets.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
TrafficTargetStatus |
Returns | |
---|---|
Type | Description |
Service.Builder |
addTrafficStatuses(TrafficTargetStatus.Builder builderForValue)
public Service.Builder addTrafficStatuses(TrafficTargetStatus.Builder builderForValue)
Output only. Detailed status information for corresponding traffic targets.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
TrafficTargetStatus.Builder |
Returns | |
---|---|
Type | Description |
Service.Builder |
addTrafficStatuses(int index, TrafficTargetStatus value)
public Service.Builder addTrafficStatuses(int index, TrafficTargetStatus value)
Output only. Detailed status information for corresponding traffic targets.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
TrafficTargetStatus |
Returns | |
---|---|
Type | Description |
Service.Builder |
addTrafficStatuses(int index, TrafficTargetStatus.Builder builderForValue)
public Service.Builder addTrafficStatuses(int index, TrafficTargetStatus.Builder builderForValue)
Output only. Detailed status information for corresponding traffic targets.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
TrafficTargetStatus.Builder |
Returns | |
---|---|
Type | Description |
Service.Builder |
addTrafficStatusesBuilder()
public TrafficTargetStatus.Builder addTrafficStatusesBuilder()
Output only. Detailed status information for corresponding traffic targets.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TrafficTargetStatus.Builder |
addTrafficStatusesBuilder(int index)
public TrafficTargetStatus.Builder addTrafficStatusesBuilder(int index)
Output only. Detailed status information for corresponding traffic targets.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
TrafficTargetStatus.Builder |
build()
public Service build()
Returns | |
---|---|
Type | Description |
Service |
buildPartial()
public Service buildPartial()
Returns | |
---|---|
Type | Description |
Service |
clear()
public Service.Builder clear()
Returns | |
---|---|
Type | Description |
Service.Builder |
clearAnnotations()
public Service.Builder clearAnnotations()
Returns | |
---|---|
Type | Description |
Service.Builder |
clearBinaryAuthorization()
public Service.Builder clearBinaryAuthorization()
Optional. Settings for the Binary Authorization feature.
.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Service.Builder |
clearClient()
public Service.Builder clearClient()
Arbitrary identifier for the API client.
string client = 13;
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
clearClientVersion()
public Service.Builder clearClientVersion()
Arbitrary version identifier for the API client.
string client_version = 14;
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
clearConditions()
public Service.Builder clearConditions()
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Service does not
reach its Serving state. See comments in reconciling
for additional
information on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Service.Builder |
clearCreateTime()
public Service.Builder clearCreateTime()
Output only. The creation time.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Service.Builder |
clearCreator()
public Service.Builder clearCreator()
Output only. Email address of the authenticated creator.
string creator = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
clearCustomAudiences()
public Service.Builder clearCustomAudiences()
One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.
repeated string custom_audiences = 37;
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
clearDefaultUriDisabled()
public Service.Builder clearDefaultUriDisabled()
Optional. Disables public resolution of the default URI of this service.
bool default_uri_disabled = 22 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
clearDeleteTime()
public Service.Builder clearDeleteTime()
Output only. The deletion time. It is only populated as a response to a Delete request.
.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Service.Builder |
clearDescription()
public Service.Builder clearDescription()
User-provided description of the Service. This field currently has a 512-character limit.
string description = 2;
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
clearEtag()
public Service.Builder clearEtag()
Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
clearExpireTime()
public Service.Builder clearExpireTime()
Output only. For a deleted resource, the time after which it will be permamently deleted.
.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Service.Builder |
clearField(Descriptors.FieldDescriptor field)
public Service.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
Service.Builder |
clearGeneration()
public Service.Builder clearGeneration()
Output only. A number that monotonically increases every time the user
modifies the desired state.
Please note that unlike v1, this is an int64 value. As with most Google
APIs, its JSON representation will be a string
instead of an integer
.
int64 generation = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
clearIngress()
public Service.Builder clearIngress()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
clearLabels()
public Service.Builder clearLabels()
Returns | |
---|---|
Type | Description |
Service.Builder |
clearLastModifier()
public Service.Builder clearLastModifier()
Output only. Email address of the last authenticated modifier.
string last_modifier = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
clearLatestCreatedRevision()
public Service.Builder clearLatestCreatedRevision()
Output only. Name of the last created revision. See comments in
reconciling
for additional information on reconciliation process in Cloud
Run.
string latest_created_revision = 34 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
clearLatestReadyRevision()
public Service.Builder clearLatestReadyRevision()
Output only. Name of the latest revision that is serving traffic. See
comments in reconciling
for additional information on reconciliation
process in Cloud Run.
string latest_ready_revision = 33 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
clearLaunchStage()
public Service.Builder clearLaunchStage()
Optional. The launch stage as defined by Google Cloud Platform
Launch Stages.
Cloud Run supports ALPHA
, BETA
, and GA
. If no value is specified, GA
is assumed.
Set the launch stage to a preview stage on input to allow use of preview
features in that stage. On read (or output), describes whether the resource
uses preview features.
<p>
For example, if ALPHA is provided as input, but only BETA and GA-level
features are used, this field will be BETA on output.
.google.api.LaunchStage launch_stage = 16 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
clearName()
public Service.Builder clearName()
The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id.
Format: projects/{project}/locations/{location}/services/{service_id}
string name = 1;
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
clearObservedGeneration()
public Service.Builder clearObservedGeneration()
Output only. The generation of this Service currently serving traffic. See
comments in reconciling
for additional information on reconciliation
process in Cloud Run. Please note that unlike v1, this is an int64 value.
As with most Google APIs, its JSON representation will be a string
instead of an integer
.
int64 observed_generation = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Service.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
Service.Builder |
clearReconciling()
public Service.Builder clearReconciling()
Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state.
When a new Service is created, or an existing one is updated, Cloud Run
will asynchronously perform all necessary steps to bring the Service to the
desired serving state. This process is called reconciliation.
While reconciliation is in process, observed_generation
,
latest_ready_revison
, traffic_statuses
, and uri
will have transient
values that might mismatch the intended state: Once reconciliation is over
(and this field is false), there are two possible outcomes: reconciliation
succeeded and the serving state matches the Service, or there was an error,
and reconciliation failed. This state can be found in
terminal_condition.state
.
If reconciliation succeeded, the following fields will match: traffic
and
traffic_statuses
, observed_generation
and generation
,
latest_ready_revision
and latest_created_revision
.
If reconciliation failed, traffic_statuses
, observed_generation
, and
latest_ready_revision
will have the state of the last serving revision,
or empty for newly created Services. Additional information on the failure
can be found in terminal_condition
and conditions
.
bool reconciling = 98 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
clearSatisfiesPzs()
public Service.Builder clearSatisfiesPzs()
Output only. Reserved for future use.
bool satisfies_pzs = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
clearScaling()
public Service.Builder clearScaling()
Optional. Specifies service-level scaling settings
.google.cloud.run.v2.ServiceScaling scaling = 20 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Service.Builder |
clearTemplate()
public Service.Builder clearTemplate()
Required. The template used to create revisions for this Service.
.google.cloud.run.v2.RevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Service.Builder |
clearTerminalCondition()
public Service.Builder clearTerminalCondition()
Output only. The Condition of this Service, containing its readiness
status, and detailed error information in case it did not reach a serving
state. See comments in reconciling
for additional information on
reconciliation process in Cloud Run.
.google.cloud.run.v2.Condition terminal_condition = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Service.Builder |
clearTraffic()
public Service.Builder clearTraffic()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Service.Builder |
clearTrafficStatuses()
public Service.Builder clearTrafficStatuses()
Output only. Detailed status information for corresponding traffic targets.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Service.Builder |
clearUid()
public Service.Builder clearUid()
Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
clearUpdateTime()
public Service.Builder clearUpdateTime()
Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Service.Builder |
clearUri()
public Service.Builder clearUri()
Output only. The main URI in which this Service is serving traffic.
string uri = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
clone()
public Service.Builder clone()
Returns | |
---|---|
Type | Description |
Service.Builder |
containsAnnotations(String key)
public boolean containsAnnotations(String key)
Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.
<p>Cloud Run API v2 does not support annotations with run.googleapis.com
,
cloud.googleapis.com
, serving.knative.dev
, or autoscaling.knative.dev
namespaces, and they will be rejected in new resources. All system
annotations in v1 now have a corresponding field in v2 Service.
<p>This field follows Kubernetes annotations' namespacing, limits, and rules.
map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
boolean |
containsLabels(String key)
public boolean containsLabels(String key)
Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.
<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 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
boolean |
getAnnotations() (deprecated)
public Map<String,String> getAnnotations()
Use #getAnnotationsMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getAnnotationsCount()
public int getAnnotationsCount()
Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.
<p>Cloud Run API v2 does not support annotations with run.googleapis.com
,
cloud.googleapis.com
, serving.knative.dev
, or autoscaling.knative.dev
namespaces, and they will be rejected in new resources. All system
annotations in v1 now have a corresponding field in v2 Service.
<p>This field follows Kubernetes annotations' namespacing, limits, and rules.
map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
getAnnotationsMap()
public Map<String,String> getAnnotationsMap()
Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.
<p>Cloud Run API v2 does not support annotations with run.googleapis.com
,
cloud.googleapis.com
, serving.knative.dev
, or autoscaling.knative.dev
namespaces, and they will be rejected in new resources. All system
annotations in v1 now have a corresponding field in v2 Service.
<p>This field follows Kubernetes annotations' namespacing, limits, and rules.
map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Map<String,String> |
getAnnotationsOrDefault(String key, String defaultValue)
public String getAnnotationsOrDefault(String key, String defaultValue)
Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.
<p>Cloud Run API v2 does not support annotations with run.googleapis.com
,
cloud.googleapis.com
, serving.knative.dev
, or autoscaling.knative.dev
namespaces, and they will be rejected in new resources. All system
annotations in v1 now have a corresponding field in v2 Service.
<p>This field follows Kubernetes annotations' namespacing, limits, and rules.
map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
key |
String |
defaultValue |
String |
Returns | |
---|---|
Type | Description |
String |
getAnnotationsOrThrow(String key)
public String getAnnotationsOrThrow(String key)
Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.
<p>Cloud Run API v2 does not support annotations with run.googleapis.com
,
cloud.googleapis.com
, serving.knative.dev
, or autoscaling.knative.dev
namespaces, and they will be rejected in new resources. All system
annotations in v1 now have a corresponding field in v2 Service.
<p>This field follows Kubernetes annotations' namespacing, limits, and rules.
map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
String |
getBinaryAuthorization()
public BinaryAuthorization getBinaryAuthorization()
Optional. Settings for the Binary Authorization feature.
.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
BinaryAuthorization |
The binaryAuthorization. |
getBinaryAuthorizationBuilder()
public BinaryAuthorization.Builder getBinaryAuthorizationBuilder()
Optional. Settings for the Binary Authorization feature.
.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
BinaryAuthorization.Builder |
getBinaryAuthorizationOrBuilder()
public BinaryAuthorizationOrBuilder getBinaryAuthorizationOrBuilder()
Optional. Settings for the Binary Authorization feature.
.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
BinaryAuthorizationOrBuilder |
getClient()
public String getClient()
Arbitrary identifier for the API client.
string client = 13;
Returns | |
---|---|
Type | Description |
String |
The client. |
getClientBytes()
public ByteString getClientBytes()
Arbitrary identifier for the API client.
string client = 13;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for client. |
getClientVersion()
public String getClientVersion()
Arbitrary version identifier for the API client.
string client_version = 14;
Returns | |
---|---|
Type | Description |
String |
The clientVersion. |
getClientVersionBytes()
public 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 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 |
getConditionsBuilder(int index)
public Condition.Builder getConditionsBuilder(int index)
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Service does not
reach its Serving state. See comments in reconciling
for additional
information on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Condition.Builder |
getConditionsBuilderList()
public List<Condition.Builder> getConditionsBuilderList()
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Service does not
reach its Serving state. See comments in reconciling
for additional
information on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
List<Builder> |
getConditionsCount()
public int getConditionsCount()
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Service does not
reach its Serving state. See comments in reconciling
for additional
information on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
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];
Returns | |
---|---|
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];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
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];
Returns | |
---|---|
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];
Returns | |
---|---|
Type | Description |
Timestamp |
The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()
Output only. The creation time.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getCreateTimeOrBuilder()
public 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 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 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. |
getCustomAudiences(int index)
public String getCustomAudiences(int index)
One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.
repeated string custom_audiences = 37;
Parameter | |
---|---|
Name | Description |
index |
int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String |
The customAudiences at the given index. |
getCustomAudiencesBytes(int index)
public ByteString getCustomAudiencesBytes(int index)
One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.
repeated string custom_audiences = 37;
Parameter | |
---|---|
Name | Description |
index |
int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString |
The bytes of the customAudiences at the given index. |
getCustomAudiencesCount()
public int getCustomAudiencesCount()
One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.
repeated string custom_audiences = 37;
Returns | |
---|---|
Type | Description |
int |
The count of customAudiences. |
getCustomAudiencesList()
public ProtocolStringList getCustomAudiencesList()
One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.
repeated string custom_audiences = 37;
Returns | |
---|---|
Type | Description |
ProtocolStringList |
A list containing the customAudiences. |
getDefaultInstanceForType()
public Service getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Service |
getDefaultUriDisabled()
public boolean getDefaultUriDisabled()
Optional. Disables public resolution of the default URI of this service.
bool default_uri_disabled = 22 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
The defaultUriDisabled. |
getDeleteTime()
public Timestamp getDeleteTime()
Output only. The deletion time. It is only populated as a response to a Delete request.
.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp |
The deleteTime. |
getDeleteTimeBuilder()
public Timestamp.Builder getDeleteTimeBuilder()
Output only. The deletion time. It is only populated as a response to a Delete request.
.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getDeleteTimeOrBuilder()
public TimestampOrBuilder getDeleteTimeOrBuilder()
Output only. The deletion time. It is only populated as a response to a Delete request.
.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getDescription()
public 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 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. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getEtag()
public String getEtag()
Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
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];
Returns | |
---|---|
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];
Returns | |
---|---|
Type | Description |
Timestamp |
The expireTime. |
getExpireTimeBuilder()
public Timestamp.Builder getExpireTimeBuilder()
Output only. For a deleted resource, the time after which it will be permamently deleted.
.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getExpireTimeOrBuilder()
public TimestampOrBuilder getExpireTimeOrBuilder()
Output only. For a deleted resource, the time after which it will be permamently deleted.
.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
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];
Returns | |
---|---|
Type | Description |
long |
The generation. |
getIngress()
public IngressTraffic getIngress()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
IngressTraffic |
The ingress. |
getIngressValue()
public int getIngressValue()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for ingress. |
getLabels() (deprecated)
public Map<String,String> getLabels()
Use #getLabelsMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getLabelsCount()
public int getLabelsCount()
Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.
<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 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
getLabelsMap()
public Map<String,String> getLabelsMap()
Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.
<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 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Map<String,String> |
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.
<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 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
key |
String |
defaultValue |
String |
Returns | |
---|---|
Type | Description |
String |
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.
<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 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
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];
Returns | |
---|---|
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];
Returns | |
---|---|
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) = { ... }
Returns | |
---|---|
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) = { ... }
Returns | |
---|---|
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) = { ... }
Returns | |
---|---|
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) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for latestReadyRevision. |
getLaunchStage()
public LaunchStage getLaunchStage()
Optional. The launch stage as defined by Google Cloud Platform
Launch Stages.
Cloud Run supports ALPHA
, BETA
, and GA
. If no value is specified, GA
is assumed.
Set the launch stage to a preview stage on input to allow use of preview
features in that stage. On read (or output), describes whether the resource
uses preview features.
<p>
For example, if ALPHA is provided as input, but only BETA and GA-level
features are used, this field will be BETA on output.
.google.api.LaunchStage launch_stage = 16 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
com.google.api.LaunchStage |
The launchStage. |
getLaunchStageValue()
public int getLaunchStageValue()
Optional. The launch stage as defined by Google Cloud Platform
Launch Stages.
Cloud Run supports ALPHA
, BETA
, and GA
. If no value is specified, GA
is assumed.
Set the launch stage to a preview stage on input to allow use of preview
features in that stage. On read (or output), describes whether the resource
uses preview features.
<p>
For example, if ALPHA is provided as input, but only BETA and GA-level
features are used, this field will be BETA on output.
.google.api.LaunchStage launch_stage = 16 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for launchStage. |
getMutableAnnotations() (deprecated)
public Map<String,String> getMutableAnnotations()
Use alternate mutation accessors instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()
Use alternate mutation accessors instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getName()
public String getName()
The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id.
Format: projects/{project}/locations/{location}/services/{service_id}
string name = 1;
Returns | |
---|---|
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;
Returns | |
---|---|
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];
Returns | |
---|---|
Type | Description |
long |
The observedGeneration. |
getReconciling()
public boolean getReconciling()
Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state.
When a new Service is created, or an existing one is updated, Cloud Run
will asynchronously perform all necessary steps to bring the Service to the
desired serving state. This process is called reconciliation.
While reconciliation is in process, observed_generation
,
latest_ready_revison
, traffic_statuses
, and uri
will have transient
values that might mismatch the intended state: Once reconciliation is over
(and this field is false), there are two possible outcomes: reconciliation
succeeded and the serving state matches the Service, or there was an error,
and reconciliation failed. This state can be found in
terminal_condition.state
.
If reconciliation succeeded, the following fields will match: traffic
and
traffic_statuses
, observed_generation
and generation
,
latest_ready_revision
and latest_created_revision
.
If reconciliation failed, traffic_statuses
, observed_generation
, and
latest_ready_revision
will have the state of the last serving revision,
or empty for newly created Services. Additional information on the failure
can be found in terminal_condition
and conditions
.
bool reconciling = 98 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
The reconciling. |
getSatisfiesPzs()
public boolean getSatisfiesPzs()
Output only. Reserved for future use.
bool satisfies_pzs = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
The satisfiesPzs. |
getScaling()
public ServiceScaling getScaling()
Optional. Specifies service-level scaling settings
.google.cloud.run.v2.ServiceScaling scaling = 20 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ServiceScaling |
The scaling. |
getScalingBuilder()
public ServiceScaling.Builder getScalingBuilder()
Optional. Specifies service-level scaling settings
.google.cloud.run.v2.ServiceScaling scaling = 20 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ServiceScaling.Builder |
getScalingOrBuilder()
public ServiceScalingOrBuilder getScalingOrBuilder()
Optional. Specifies service-level scaling settings
.google.cloud.run.v2.ServiceScaling scaling = 20 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ServiceScalingOrBuilder |
getTemplate()
public RevisionTemplate getTemplate()
Required. The template used to create revisions for this Service.
.google.cloud.run.v2.RevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
RevisionTemplate |
The template. |
getTemplateBuilder()
public RevisionTemplate.Builder getTemplateBuilder()
Required. The template used to create revisions for this Service.
.google.cloud.run.v2.RevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
RevisionTemplate.Builder |
getTemplateOrBuilder()
public RevisionTemplateOrBuilder getTemplateOrBuilder()
Required. The template used to create revisions for this Service.
.google.cloud.run.v2.RevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
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];
Returns | |
---|---|
Type | Description |
Condition |
The terminalCondition. |
getTerminalConditionBuilder()
public Condition.Builder getTerminalConditionBuilder()
Output only. The Condition of this Service, containing its readiness
status, and detailed error information in case it did not reach a serving
state. See comments in reconciling
for additional information on
reconciliation process in Cloud Run.
.google.cloud.run.v2.Condition terminal_condition = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Condition.Builder |
getTerminalConditionOrBuilder()
public ConditionOrBuilder getTerminalConditionOrBuilder()
Output only. The Condition of this Service, containing its readiness
status, and detailed error information in case it did not reach a serving
state. See comments in reconciling
for additional information on
reconciliation process in Cloud Run.
.google.cloud.run.v2.Condition terminal_condition = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ConditionOrBuilder |
getTraffic(int index)
public TrafficTarget getTraffic(int index)
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
TrafficTarget |
getTrafficBuilder(int index)
public TrafficTarget.Builder getTrafficBuilder(int index)
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
TrafficTarget.Builder |
getTrafficBuilderList()
public List<TrafficTarget.Builder> getTrafficBuilderList()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<Builder> |
getTrafficCount()
public int getTrafficCount()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
getTrafficList()
public List<TrafficTarget> getTrafficList()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<TrafficTarget> |
getTrafficOrBuilder(int index)
public TrafficTargetOrBuilder getTrafficOrBuilder(int index)
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
TrafficTargetOrBuilder |
getTrafficOrBuilderList()
public List<? extends TrafficTargetOrBuilder> getTrafficOrBuilderList()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
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];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
TrafficTargetStatus |
getTrafficStatusesBuilder(int index)
public TrafficTargetStatus.Builder getTrafficStatusesBuilder(int index)
Output only. Detailed status information for corresponding traffic targets.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
TrafficTargetStatus.Builder |
getTrafficStatusesBuilderList()
public List<TrafficTargetStatus.Builder> getTrafficStatusesBuilderList()
Output only. Detailed status information for corresponding traffic targets.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
List<Builder> |
getTrafficStatusesCount()
public int getTrafficStatusesCount()
Output only. Detailed status information for corresponding traffic targets.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
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];
Returns | |
---|---|
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];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
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];
Returns | |
---|---|
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];
Returns | |
---|---|
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];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for uid. |
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()
Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getUpdateTimeOrBuilder()
public 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 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 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 boolean hasBinaryAuthorization()
Optional. Settings for the Binary Authorization feature.
.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
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];
Returns | |
---|---|
Type | Description |
boolean |
Whether the createTime field is set. |
hasDeleteTime()
public boolean hasDeleteTime()
Output only. The deletion time. It is only populated as a response to a Delete request.
.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
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];
Returns | |
---|---|
Type | Description |
boolean |
Whether the expireTime field is set. |
hasScaling()
public boolean hasScaling()
Optional. Specifies service-level scaling settings
.google.cloud.run.v2.ServiceScaling scaling = 20 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
Whether the scaling field is set. |
hasTemplate()
public boolean hasTemplate()
Required. The template used to create revisions for this Service.
.google.cloud.run.v2.RevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
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];
Returns | |
---|---|
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];
Returns | |
---|---|
Type | Description |
boolean |
Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeBinaryAuthorization(BinaryAuthorization value)
public Service.Builder mergeBinaryAuthorization(BinaryAuthorization value)
Optional. Settings for the Binary Authorization feature.
.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
BinaryAuthorization |
Returns | |
---|---|
Type | Description |
Service.Builder |
mergeCreateTime(Timestamp value)
public Service.Builder mergeCreateTime(Timestamp value)
Output only. The creation time.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Service.Builder |
mergeDeleteTime(Timestamp value)
public Service.Builder mergeDeleteTime(Timestamp value)
Output only. The deletion time. It is only populated as a response to a Delete request.
.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Service.Builder |
mergeExpireTime(Timestamp value)
public Service.Builder mergeExpireTime(Timestamp value)
Output only. For a deleted resource, the time after which it will be permamently deleted.
.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Service.Builder |
mergeFrom(Service other)
public Service.Builder mergeFrom(Service other)
Parameter | |
---|---|
Name | Description |
other |
Service |
Returns | |
---|---|
Type | Description |
Service.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Service.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Service.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public Service.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
Service.Builder |
mergeScaling(ServiceScaling value)
public Service.Builder mergeScaling(ServiceScaling value)
Optional. Specifies service-level scaling settings
.google.cloud.run.v2.ServiceScaling scaling = 20 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ServiceScaling |
Returns | |
---|---|
Type | Description |
Service.Builder |
mergeTemplate(RevisionTemplate value)
public Service.Builder mergeTemplate(RevisionTemplate value)
Required. The template used to create revisions for this Service.
.google.cloud.run.v2.RevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
RevisionTemplate |
Returns | |
---|---|
Type | Description |
Service.Builder |
mergeTerminalCondition(Condition value)
public Service.Builder mergeTerminalCondition(Condition value)
Output only. The Condition of this Service, containing its readiness
status, and detailed error information in case it did not reach a serving
state. See comments in reconciling
for additional information on
reconciliation process in Cloud Run.
.google.cloud.run.v2.Condition terminal_condition = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Condition |
Returns | |
---|---|
Type | Description |
Service.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Service.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Service.Builder |
mergeUpdateTime(Timestamp value)
public Service.Builder mergeUpdateTime(Timestamp value)
Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Service.Builder |
putAllAnnotations(Map<String,String> values)
public Service.Builder putAllAnnotations(Map<String,String> values)
Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.
<p>Cloud Run API v2 does not support annotations with run.googleapis.com
,
cloud.googleapis.com
, serving.knative.dev
, or autoscaling.knative.dev
namespaces, and they will be rejected in new resources. All system
annotations in v1 now have a corresponding field in v2 Service.
<p>This field follows Kubernetes annotations' namespacing, limits, and rules.
map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values |
Map<String,String> |
Returns | |
---|---|
Type | Description |
Service.Builder |
putAllLabels(Map<String,String> values)
public Service.Builder putAllLabels(Map<String,String> values)
Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.
<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 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values |
Map<String,String> |
Returns | |
---|---|
Type | Description |
Service.Builder |
putAnnotations(String key, String value)
public Service.Builder putAnnotations(String key, String value)
Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.
<p>Cloud Run API v2 does not support annotations with run.googleapis.com
,
cloud.googleapis.com
, serving.knative.dev
, or autoscaling.knative.dev
namespaces, and they will be rejected in new resources. All system
annotations in v1 now have a corresponding field in v2 Service.
<p>This field follows Kubernetes annotations' namespacing, limits, and rules.
map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
key |
String |
value |
String |
Returns | |
---|---|
Type | Description |
Service.Builder |
putLabels(String key, String value)
public Service.Builder putLabels(String key, String value)
Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.
<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 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
key |
String |
value |
String |
Returns | |
---|---|
Type | Description |
Service.Builder |
removeAnnotations(String key)
public Service.Builder removeAnnotations(String key)
Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.
<p>Cloud Run API v2 does not support annotations with run.googleapis.com
,
cloud.googleapis.com
, serving.knative.dev
, or autoscaling.knative.dev
namespaces, and they will be rejected in new resources. All system
annotations in v1 now have a corresponding field in v2 Service.
<p>This field follows Kubernetes annotations' namespacing, limits, and rules.
map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
Service.Builder |
removeConditions(int index)
public Service.Builder removeConditions(int index)
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Service does not
reach its Serving state. See comments in reconciling
for additional
information on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Service.Builder |
removeLabels(String key)
public Service.Builder removeLabels(String key)
Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.
<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 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
Service.Builder |
removeTraffic(int index)
public Service.Builder removeTraffic(int index)
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Service.Builder |
removeTrafficStatuses(int index)
public Service.Builder removeTrafficStatuses(int index)
Output only. Detailed status information for corresponding traffic targets.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Service.Builder |
setBinaryAuthorization(BinaryAuthorization value)
public Service.Builder setBinaryAuthorization(BinaryAuthorization value)
Optional. Settings for the Binary Authorization feature.
.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
BinaryAuthorization |
Returns | |
---|---|
Type | Description |
Service.Builder |
setBinaryAuthorization(BinaryAuthorization.Builder builderForValue)
public Service.Builder setBinaryAuthorization(BinaryAuthorization.Builder builderForValue)
Optional. Settings for the Binary Authorization feature.
.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
BinaryAuthorization.Builder |
Returns | |
---|---|
Type | Description |
Service.Builder |
setClient(String value)
public Service.Builder setClient(String value)
Arbitrary identifier for the API client.
string client = 13;
Parameter | |
---|---|
Name | Description |
value |
String The client to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setClientBytes(ByteString value)
public Service.Builder setClientBytes(ByteString value)
Arbitrary identifier for the API client.
string client = 13;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for client to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setClientVersion(String value)
public Service.Builder setClientVersion(String value)
Arbitrary version identifier for the API client.
string client_version = 14;
Parameter | |
---|---|
Name | Description |
value |
String The clientVersion to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setClientVersionBytes(ByteString value)
public Service.Builder setClientVersionBytes(ByteString value)
Arbitrary version identifier for the API client.
string client_version = 14;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for clientVersion to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setConditions(int index, Condition value)
public Service.Builder setConditions(int index, Condition value)
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Service does not
reach its Serving state. See comments in reconciling
for additional
information on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
Condition |
Returns | |
---|---|
Type | Description |
Service.Builder |
setConditions(int index, Condition.Builder builderForValue)
public Service.Builder setConditions(int index, Condition.Builder builderForValue)
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Service does not
reach its Serving state. See comments in reconciling
for additional
information on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
Condition.Builder |
Returns | |
---|---|
Type | Description |
Service.Builder |
setCreateTime(Timestamp value)
public Service.Builder setCreateTime(Timestamp value)
Output only. The creation time.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Service.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public Service.Builder setCreateTime(Timestamp.Builder builderForValue)
Output only. The creation time.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Service.Builder |
setCreator(String value)
public Service.Builder setCreator(String value)
Output only. Email address of the authenticated creator.
string creator = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
String The creator to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setCreatorBytes(ByteString value)
public Service.Builder setCreatorBytes(ByteString value)
Output only. Email address of the authenticated creator.
string creator = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for creator to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setCustomAudiences(int index, String value)
public Service.Builder setCustomAudiences(int index, String value)
One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.
repeated string custom_audiences = 37;
Parameters | |
---|---|
Name | Description |
index |
int The index to set the value at. |
value |
String The customAudiences to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setDefaultUriDisabled(boolean value)
public Service.Builder setDefaultUriDisabled(boolean value)
Optional. Disables public resolution of the default URI of this service.
bool default_uri_disabled = 22 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
boolean The defaultUriDisabled to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setDeleteTime(Timestamp value)
public Service.Builder setDeleteTime(Timestamp value)
Output only. The deletion time. It is only populated as a response to a Delete request.
.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Service.Builder |
setDeleteTime(Timestamp.Builder builderForValue)
public Service.Builder setDeleteTime(Timestamp.Builder builderForValue)
Output only. The deletion time. It is only populated as a response to a Delete request.
.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Service.Builder |
setDescription(String value)
public Service.Builder setDescription(String value)
User-provided description of the Service. This field currently has a 512-character limit.
string description = 2;
Parameter | |
---|---|
Name | Description |
value |
String The description to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public Service.Builder setDescriptionBytes(ByteString value)
User-provided description of the Service. This field currently has a 512-character limit.
string description = 2;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for description to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setEtag(String value)
public Service.Builder setEtag(String value)
Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
String The etag to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setEtagBytes(ByteString value)
public Service.Builder setEtagBytes(ByteString value)
Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for etag to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setExpireTime(Timestamp value)
public Service.Builder setExpireTime(Timestamp value)
Output only. For a deleted resource, the time after which it will be permamently deleted.
.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Service.Builder |
setExpireTime(Timestamp.Builder builderForValue)
public Service.Builder setExpireTime(Timestamp.Builder builderForValue)
Output only. For a deleted resource, the time after which it will be permamently deleted.
.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Service.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public Service.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Service.Builder |
setGeneration(long value)
public Service.Builder setGeneration(long value)
Output only. A number that monotonically increases every time the user
modifies the desired state.
Please note that unlike v1, this is an int64 value. As with most Google
APIs, its JSON representation will be a string
instead of an integer
.
int64 generation = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
long The generation to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setIngress(IngressTraffic value)
public Service.Builder setIngress(IngressTraffic value)
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
IngressTraffic The ingress to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setIngressValue(int value)
public Service.Builder setIngressValue(int value)
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
int The enum numeric value on the wire for ingress to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setLastModifier(String value)
public Service.Builder setLastModifier(String value)
Output only. Email address of the last authenticated modifier.
string last_modifier = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
String The lastModifier to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setLastModifierBytes(ByteString value)
public Service.Builder setLastModifierBytes(ByteString value)
Output only. Email address of the last authenticated modifier.
string last_modifier = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for lastModifier to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setLatestCreatedRevision(String value)
public Service.Builder setLatestCreatedRevision(String value)
Output only. Name of the last created revision. See comments in
reconciling
for additional information on reconciliation process in Cloud
Run.
string latest_created_revision = 34 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The latestCreatedRevision to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setLatestCreatedRevisionBytes(ByteString value)
public Service.Builder setLatestCreatedRevisionBytes(ByteString value)
Output only. Name of the last created revision. See comments in
reconciling
for additional information on reconciliation process in Cloud
Run.
string latest_created_revision = 34 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for latestCreatedRevision to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setLatestReadyRevision(String value)
public Service.Builder setLatestReadyRevision(String value)
Output only. Name of the latest revision that is serving traffic. See
comments in reconciling
for additional information on reconciliation
process in Cloud Run.
string latest_ready_revision = 33 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The latestReadyRevision to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setLatestReadyRevisionBytes(ByteString value)
public Service.Builder setLatestReadyRevisionBytes(ByteString value)
Output only. Name of the latest revision that is serving traffic. See
comments in reconciling
for additional information on reconciliation
process in Cloud Run.
string latest_ready_revision = 33 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for latestReadyRevision to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setLaunchStage(LaunchStage value)
public Service.Builder setLaunchStage(LaunchStage value)
Optional. The launch stage as defined by Google Cloud Platform
Launch Stages.
Cloud Run supports ALPHA
, BETA
, and GA
. If no value is specified, GA
is assumed.
Set the launch stage to a preview stage on input to allow use of preview
features in that stage. On read (or output), describes whether the resource
uses preview features.
<p>
For example, if ALPHA is provided as input, but only BETA and GA-level
features are used, this field will be BETA on output.
.google.api.LaunchStage launch_stage = 16 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
com.google.api.LaunchStage The launchStage to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setLaunchStageValue(int value)
public Service.Builder setLaunchStageValue(int value)
Optional. The launch stage as defined by Google Cloud Platform
Launch Stages.
Cloud Run supports ALPHA
, BETA
, and GA
. If no value is specified, GA
is assumed.
Set the launch stage to a preview stage on input to allow use of preview
features in that stage. On read (or output), describes whether the resource
uses preview features.
<p>
For example, if ALPHA is provided as input, but only BETA and GA-level
features are used, this field will be BETA on output.
.google.api.LaunchStage launch_stage = 16 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
int The enum numeric value on the wire for launchStage to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setName(String value)
public Service.Builder setName(String value)
The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id.
Format: projects/{project}/locations/{location}/services/{service_id}
string name = 1;
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Service.Builder setNameBytes(ByteString value)
The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id.
Format: projects/{project}/locations/{location}/services/{service_id}
string name = 1;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setObservedGeneration(long value)
public Service.Builder setObservedGeneration(long value)
Output only. The generation of this Service currently serving traffic. See
comments in reconciling
for additional information on reconciliation
process in Cloud Run. Please note that unlike v1, this is an int64 value.
As with most Google APIs, its JSON representation will be a string
instead of an integer
.
int64 observed_generation = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
long The observedGeneration to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setReconciling(boolean value)
public Service.Builder setReconciling(boolean value)
Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state.
When a new Service is created, or an existing one is updated, Cloud Run
will asynchronously perform all necessary steps to bring the Service to the
desired serving state. This process is called reconciliation.
While reconciliation is in process, observed_generation
,
latest_ready_revison
, traffic_statuses
, and uri
will have transient
values that might mismatch the intended state: Once reconciliation is over
(and this field is false), there are two possible outcomes: reconciliation
succeeded and the serving state matches the Service, or there was an error,
and reconciliation failed. This state can be found in
terminal_condition.state
.
If reconciliation succeeded, the following fields will match: traffic
and
traffic_statuses
, observed_generation
and generation
,
latest_ready_revision
and latest_created_revision
.
If reconciliation failed, traffic_statuses
, observed_generation
, and
latest_ready_revision
will have the state of the last serving revision,
or empty for newly created Services. Additional information on the failure
can be found in terminal_condition
and conditions
.
bool reconciling = 98 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
boolean The reconciling to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Service.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
Service.Builder |
setSatisfiesPzs(boolean value)
public Service.Builder setSatisfiesPzs(boolean value)
Output only. Reserved for future use.
bool satisfies_pzs = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
boolean The satisfiesPzs to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setScaling(ServiceScaling value)
public Service.Builder setScaling(ServiceScaling value)
Optional. Specifies service-level scaling settings
.google.cloud.run.v2.ServiceScaling scaling = 20 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ServiceScaling |
Returns | |
---|---|
Type | Description |
Service.Builder |
setScaling(ServiceScaling.Builder builderForValue)
public Service.Builder setScaling(ServiceScaling.Builder builderForValue)
Optional. Specifies service-level scaling settings
.google.cloud.run.v2.ServiceScaling scaling = 20 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
ServiceScaling.Builder |
Returns | |
---|---|
Type | Description |
Service.Builder |
setTemplate(RevisionTemplate value)
public Service.Builder setTemplate(RevisionTemplate value)
Required. The template used to create revisions for this Service.
.google.cloud.run.v2.RevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
RevisionTemplate |
Returns | |
---|---|
Type | Description |
Service.Builder |
setTemplate(RevisionTemplate.Builder builderForValue)
public Service.Builder setTemplate(RevisionTemplate.Builder builderForValue)
Required. The template used to create revisions for this Service.
.google.cloud.run.v2.RevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
builderForValue |
RevisionTemplate.Builder |
Returns | |
---|---|
Type | Description |
Service.Builder |
setTerminalCondition(Condition value)
public Service.Builder setTerminalCondition(Condition value)
Output only. The Condition of this Service, containing its readiness
status, and detailed error information in case it did not reach a serving
state. See comments in reconciling
for additional information on
reconciliation process in Cloud Run.
.google.cloud.run.v2.Condition terminal_condition = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Condition |
Returns | |
---|---|
Type | Description |
Service.Builder |
setTerminalCondition(Condition.Builder builderForValue)
public Service.Builder setTerminalCondition(Condition.Builder builderForValue)
Output only. The Condition of this Service, containing its readiness
status, and detailed error information in case it did not reach a serving
state. See comments in reconciling
for additional information on
reconciliation process in Cloud Run.
.google.cloud.run.v2.Condition terminal_condition = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Condition.Builder |
Returns | |
---|---|
Type | Description |
Service.Builder |
setTraffic(int index, TrafficTarget value)
public Service.Builder setTraffic(int index, TrafficTarget value)
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
TrafficTarget |
Returns | |
---|---|
Type | Description |
Service.Builder |
setTraffic(int index, TrafficTarget.Builder builderForValue)
public Service.Builder setTraffic(int index, TrafficTarget.Builder builderForValue)
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
TrafficTarget.Builder |
Returns | |
---|---|
Type | Description |
Service.Builder |
setTrafficStatuses(int index, TrafficTargetStatus value)
public Service.Builder setTrafficStatuses(int index, TrafficTargetStatus value)
Output only. Detailed status information for corresponding traffic targets.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
TrafficTargetStatus |
Returns | |
---|---|
Type | Description |
Service.Builder |
setTrafficStatuses(int index, TrafficTargetStatus.Builder builderForValue)
public Service.Builder setTrafficStatuses(int index, TrafficTargetStatus.Builder builderForValue)
Output only. Detailed status information for corresponding traffic targets.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.TrafficTargetStatus traffic_statuses = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
TrafficTargetStatus.Builder |
Returns | |
---|---|
Type | Description |
Service.Builder |
setUid(String value)
public Service.Builder setUid(String value)
Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
String The uid to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setUidBytes(ByteString value)
public Service.Builder setUidBytes(ByteString value)
Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for uid to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Service.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Service.Builder |
setUpdateTime(Timestamp value)
public Service.Builder setUpdateTime(Timestamp value)
Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Service.Builder |
setUpdateTime(Timestamp.Builder builderForValue)
public Service.Builder setUpdateTime(Timestamp.Builder builderForValue)
Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Service.Builder |
setUri(String value)
public Service.Builder setUri(String value)
Output only. The main URI in which this Service is serving traffic.
string uri = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
String The uri to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |
setUriBytes(ByteString value)
public Service.Builder setUriBytes(ByteString value)
Output only. The main URI in which this Service is serving traffic.
string uri = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for uri to set. |
Returns | |
---|---|
Type | Description |
Service.Builder |
This builder for chaining. |