- 0.72.0 (latest)
- 0.70.0
- 0.68.0
- 0.67.0
- 0.64.0
- 0.63.0
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.5
- 0.2.1
- 0.1.2
public static final class WorkerPool.Builder extends GeneratedMessageV3.Builder<WorkerPool.Builder> implements WorkerPoolOrBuilder
WorkerPool acts as a top-level container that manages a set of configurations and revision templates which implement a pull-based workload. WorkerPool 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.WorkerPool
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > WorkerPool.BuilderImplements
WorkerPoolOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllConditions(Iterable<? extends Condition> values)
public WorkerPool.Builder addAllConditions(Iterable<? extends Condition> values)
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the WorkerPool 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 |
WorkerPool.Builder |
addAllCustomAudiences(Iterable<String> values)
public WorkerPool.Builder addAllCustomAudiences(Iterable<String> values)
One or more custom audiences that you want this worker pool 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 |
WorkerPool.Builder |
This builder for chaining. |
addAllInstanceSplitStatuses(Iterable<? extends InstanceSplitStatus> values)
public WorkerPool.Builder addAllInstanceSplitStatuses(Iterable<? extends InstanceSplitStatus> values)
Output only. Detailed status information for corresponding instance splits.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
values |
Iterable<? extends com.google.cloud.run.v2.InstanceSplitStatus> |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
addAllInstanceSplits(Iterable<? extends InstanceSplit> values)
public WorkerPool.Builder addAllInstanceSplits(Iterable<? extends InstanceSplit> values)
Optional. Specifies how to distribute instances over a collection of
Revisions belonging to the WorkerPool. If instance split is empty or not
provided, defaults to 100% instances assigned to the latest Ready
Revision.
repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values |
Iterable<? extends com.google.cloud.run.v2.InstanceSplit> |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
addConditions(Condition value)
public WorkerPool.Builder addConditions(Condition value)
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the WorkerPool 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 |
WorkerPool.Builder |
addConditions(Condition.Builder builderForValue)
public WorkerPool.Builder addConditions(Condition.Builder builderForValue)
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the WorkerPool 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 |
WorkerPool.Builder |
addConditions(int index, Condition value)
public WorkerPool.Builder addConditions(int index, Condition value)
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the WorkerPool 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 |
WorkerPool.Builder |
addConditions(int index, Condition.Builder builderForValue)
public WorkerPool.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 WorkerPool 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 |
WorkerPool.Builder |
addConditionsBuilder()
public Condition.Builder addConditionsBuilder()
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the WorkerPool 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 WorkerPool 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 WorkerPool.Builder addCustomAudiences(String value)
One or more custom audiences that you want this worker pool 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 |
WorkerPool.Builder |
This builder for chaining. |
addCustomAudiencesBytes(ByteString value)
public WorkerPool.Builder addCustomAudiencesBytes(ByteString value)
One or more custom audiences that you want this worker pool 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 |
WorkerPool.Builder |
This builder for chaining. |
addInstanceSplitStatuses(InstanceSplitStatus value)
public WorkerPool.Builder addInstanceSplitStatuses(InstanceSplitStatus value)
Output only. Detailed status information for corresponding instance splits.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
InstanceSplitStatus |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
addInstanceSplitStatuses(InstanceSplitStatus.Builder builderForValue)
public WorkerPool.Builder addInstanceSplitStatuses(InstanceSplitStatus.Builder builderForValue)
Output only. Detailed status information for corresponding instance splits.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
InstanceSplitStatus.Builder |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
addInstanceSplitStatuses(int index, InstanceSplitStatus value)
public WorkerPool.Builder addInstanceSplitStatuses(int index, InstanceSplitStatus value)
Output only. Detailed status information for corresponding instance splits.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
InstanceSplitStatus |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
addInstanceSplitStatuses(int index, InstanceSplitStatus.Builder builderForValue)
public WorkerPool.Builder addInstanceSplitStatuses(int index, InstanceSplitStatus.Builder builderForValue)
Output only. Detailed status information for corresponding instance splits.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
InstanceSplitStatus.Builder |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
addInstanceSplitStatusesBuilder()
public InstanceSplitStatus.Builder addInstanceSplitStatusesBuilder()
Output only. Detailed status information for corresponding instance splits.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
InstanceSplitStatus.Builder |
addInstanceSplitStatusesBuilder(int index)
public InstanceSplitStatus.Builder addInstanceSplitStatusesBuilder(int index)
Output only. Detailed status information for corresponding instance splits.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
InstanceSplitStatus.Builder |
addInstanceSplits(InstanceSplit value)
public WorkerPool.Builder addInstanceSplits(InstanceSplit value)
Optional. Specifies how to distribute instances over a collection of
Revisions belonging to the WorkerPool. If instance split is empty or not
provided, defaults to 100% instances assigned to the latest Ready
Revision.
repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
InstanceSplit |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
addInstanceSplits(InstanceSplit.Builder builderForValue)
public WorkerPool.Builder addInstanceSplits(InstanceSplit.Builder builderForValue)
Optional. Specifies how to distribute instances over a collection of
Revisions belonging to the WorkerPool. If instance split is empty or not
provided, defaults to 100% instances assigned to the latest Ready
Revision.
repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
InstanceSplit.Builder |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
addInstanceSplits(int index, InstanceSplit value)
public WorkerPool.Builder addInstanceSplits(int index, InstanceSplit value)
Optional. Specifies how to distribute instances over a collection of
Revisions belonging to the WorkerPool. If instance split is empty or not
provided, defaults to 100% instances assigned to the latest Ready
Revision.
repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
InstanceSplit |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
addInstanceSplits(int index, InstanceSplit.Builder builderForValue)
public WorkerPool.Builder addInstanceSplits(int index, InstanceSplit.Builder builderForValue)
Optional. Specifies how to distribute instances over a collection of
Revisions belonging to the WorkerPool. If instance split is empty or not
provided, defaults to 100% instances assigned to the latest Ready
Revision.
repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
InstanceSplit.Builder |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
addInstanceSplitsBuilder()
public InstanceSplit.Builder addInstanceSplitsBuilder()
Optional. Specifies how to distribute instances over a collection of
Revisions belonging to the WorkerPool. If instance split is empty or not
provided, defaults to 100% instances assigned to the latest Ready
Revision.
repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
InstanceSplit.Builder |
addInstanceSplitsBuilder(int index)
public InstanceSplit.Builder addInstanceSplitsBuilder(int index)
Optional. Specifies how to distribute instances over a collection of
Revisions belonging to the WorkerPool. If instance split is empty or not
provided, defaults to 100% instances assigned to the latest Ready
Revision.
repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
InstanceSplit.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public WorkerPool.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
build()
public WorkerPool build()
Returns | |
---|---|
Type | Description |
WorkerPool |
buildPartial()
public WorkerPool buildPartial()
Returns | |
---|---|
Type | Description |
WorkerPool |
clear()
public WorkerPool.Builder clear()
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
clearAnnotations()
public WorkerPool.Builder clearAnnotations()
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
clearBinaryAuthorization()
public WorkerPool.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 |
WorkerPool.Builder |
clearClient()
public WorkerPool.Builder clearClient()
Arbitrary identifier for the API client.
string client = 13;
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
This builder for chaining. |
clearClientVersion()
public WorkerPool.Builder clearClientVersion()
Arbitrary version identifier for the API client.
string client_version = 14;
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
This builder for chaining. |
clearConditions()
public WorkerPool.Builder clearConditions()
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the WorkerPool 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 |
WorkerPool.Builder |
clearCreateTime()
public WorkerPool.Builder clearCreateTime()
Output only. The creation time.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
clearCreator()
public WorkerPool.Builder clearCreator()
Output only. Email address of the authenticated creator.
string creator = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
This builder for chaining. |
clearCustomAudiences()
public WorkerPool.Builder clearCustomAudiences()
One or more custom audiences that you want this worker pool 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 |
WorkerPool.Builder |
This builder for chaining. |
clearDeleteTime()
public WorkerPool.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 |
WorkerPool.Builder |
clearDescription()
public WorkerPool.Builder clearDescription()
User-provided description of the WorkerPool. This field currently has a 512-character limit.
string description = 2;
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
This builder for chaining. |
clearEtag()
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
clearExpireTime()
public WorkerPool.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 |
WorkerPool.Builder |
clearField(Descriptors.FieldDescriptor field)
public WorkerPool.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
clearGeneration()
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
clearInstanceSplitStatuses()
public WorkerPool.Builder clearInstanceSplitStatuses()
Output only. Detailed status information for corresponding instance splits.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
clearInstanceSplits()
public WorkerPool.Builder clearInstanceSplits()
Optional. Specifies how to distribute instances over a collection of
Revisions belonging to the WorkerPool. If instance split is empty or not
provided, defaults to 100% instances assigned to the latest Ready
Revision.
repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
clearLabels()
public WorkerPool.Builder clearLabels()
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
clearLastModifier()
public WorkerPool.Builder clearLastModifier()
Output only. Email address of the last authenticated modifier.
string last_modifier = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
This builder for chaining. |
clearLatestCreatedRevision()
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
clearLatestReadyRevision()
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
clearLaunchStage()
public WorkerPool.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.
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 |
WorkerPool.Builder |
This builder for chaining. |
clearName()
public WorkerPool.Builder clearName()
The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id.
Format:
projects/{project}/locations/{location}/workerPools/{worker_id}
string name = 1;
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
This builder for chaining. |
clearObservedGeneration()
public WorkerPool.Builder clearObservedGeneration()
Output only. The generation of this WorkerPool 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 |
WorkerPool.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public WorkerPool.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
clearReconciling()
public WorkerPool.Builder clearReconciling()
Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state.
When a new WorkerPool is created, or an existing one is updated, Cloud Run
will asynchronously perform all necessary steps to bring the WorkerPool 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 WorkerPool, 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 WorkerPools. 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 |
WorkerPool.Builder |
This builder for chaining. |
clearSatisfiesPzs()
public WorkerPool.Builder clearSatisfiesPzs()
Output only. Reserved for future use.
bool satisfies_pzs = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
This builder for chaining. |
clearScaling()
public WorkerPool.Builder clearScaling()
Optional. Specifies worker-pool-level scaling settings
.google.cloud.run.v2.WorkerPoolScaling scaling = 20 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
clearTemplate()
public WorkerPool.Builder clearTemplate()
Required. The template used to create revisions for this WorkerPool.
.google.cloud.run.v2.WorkerPoolRevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
clearTerminalCondition()
public WorkerPool.Builder clearTerminalCondition()
Output only. The Condition of this WorkerPool, 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 |
WorkerPool.Builder |
clearUid()
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
clearUpdateTime()
public WorkerPool.Builder clearUpdateTime()
Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
clone()
public WorkerPool.Builder clone()
Returns | |
---|---|
Type | Description |
WorkerPool.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.
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 WorkerPool.
<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.
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 WorkerPool.
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.
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 WorkerPool.
<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.
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 WorkerPool.
<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.
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 WorkerPool.
<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.
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 WorkerPool.
<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 WorkerPool 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 WorkerPool 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 WorkerPool 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 WorkerPool 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 WorkerPool 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 WorkerPool 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 WorkerPool 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 worker pool 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 worker pool 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 worker pool 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 worker pool 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 WorkerPool getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
WorkerPool |
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 WorkerPool. 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 WorkerPool. 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. |
getInstanceSplitStatuses(int index)
public InstanceSplitStatus getInstanceSplitStatuses(int index)
Output only. Detailed status information for corresponding instance splits.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
InstanceSplitStatus |
getInstanceSplitStatusesBuilder(int index)
public InstanceSplitStatus.Builder getInstanceSplitStatusesBuilder(int index)
Output only. Detailed status information for corresponding instance splits.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
InstanceSplitStatus.Builder |
getInstanceSplitStatusesBuilderList()
public List<InstanceSplitStatus.Builder> getInstanceSplitStatusesBuilderList()
Output only. Detailed status information for corresponding instance splits.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
List<Builder> |
getInstanceSplitStatusesCount()
public int getInstanceSplitStatusesCount()
Output only. Detailed status information for corresponding instance splits.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int |
getInstanceSplitStatusesList()
public List<InstanceSplitStatus> getInstanceSplitStatusesList()
Output only. Detailed status information for corresponding instance splits.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
List<InstanceSplitStatus> |
getInstanceSplitStatusesOrBuilder(int index)
public InstanceSplitStatusOrBuilder getInstanceSplitStatusesOrBuilder(int index)
Output only. Detailed status information for corresponding instance splits.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
InstanceSplitStatusOrBuilder |
getInstanceSplitStatusesOrBuilderList()
public List<? extends InstanceSplitStatusOrBuilder> getInstanceSplitStatusesOrBuilderList()
Output only. Detailed status information for corresponding instance splits.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.run.v2.InstanceSplitStatusOrBuilder> |
getInstanceSplits(int index)
public InstanceSplit getInstanceSplits(int index)
Optional. Specifies how to distribute instances over a collection of
Revisions belonging to the WorkerPool. If instance split is empty or not
provided, defaults to 100% instances assigned to the latest Ready
Revision.
repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
InstanceSplit |
getInstanceSplitsBuilder(int index)
public InstanceSplit.Builder getInstanceSplitsBuilder(int index)
Optional. Specifies how to distribute instances over a collection of
Revisions belonging to the WorkerPool. If instance split is empty or not
provided, defaults to 100% instances assigned to the latest Ready
Revision.
repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
InstanceSplit.Builder |
getInstanceSplitsBuilderList()
public List<InstanceSplit.Builder> getInstanceSplitsBuilderList()
Optional. Specifies how to distribute instances over a collection of
Revisions belonging to the WorkerPool. If instance split is empty or not
provided, defaults to 100% instances assigned to the latest Ready
Revision.
repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<Builder> |
getInstanceSplitsCount()
public int getInstanceSplitsCount()
Optional. Specifies how to distribute instances over a collection of
Revisions belonging to the WorkerPool. If instance split is empty or not
provided, defaults to 100% instances assigned to the latest Ready
Revision.
repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
getInstanceSplitsList()
public List<InstanceSplit> getInstanceSplitsList()
Optional. Specifies how to distribute instances over a collection of
Revisions belonging to the WorkerPool. If instance split is empty or not
provided, defaults to 100% instances assigned to the latest Ready
Revision.
repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<InstanceSplit> |
getInstanceSplitsOrBuilder(int index)
public InstanceSplitOrBuilder getInstanceSplitsOrBuilder(int index)
Optional. Specifies how to distribute instances over a collection of
Revisions belonging to the WorkerPool. If instance split is empty or not
provided, defaults to 100% instances assigned to the latest Ready
Revision.
repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
InstanceSplitOrBuilder |
getInstanceSplitsOrBuilderList()
public List<? extends InstanceSplitOrBuilder> getInstanceSplitsOrBuilderList()
Optional. Specifies how to distribute instances over a collection of
Revisions belonging to the WorkerPool. If instance split is empty or not
provided, defaults to 100% instances assigned to the latest Ready
Revision.
repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.run.v2.InstanceSplitOrBuilder> |
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.
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 WorkerPool.
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.
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 WorkerPool.
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.
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 WorkerPool.
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.
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 WorkerPool.
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.
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.
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 WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id.
Format:
projects/{project}/locations/{location}/workerPools/{worker_id}
string name = 1;
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()
The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id.
Format:
projects/{project}/locations/{location}/workerPools/{worker_id}
string name = 1;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
getObservedGeneration()
public long getObservedGeneration()
Output only. The generation of this WorkerPool 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 WorkerPool is currently being acted upon by the system to bring it into the desired state.
When a new WorkerPool is created, or an existing one is updated, Cloud Run
will asynchronously perform all necessary steps to bring the WorkerPool 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 WorkerPool, 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 WorkerPools. 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 WorkerPoolScaling getScaling()
Optional. Specifies worker-pool-level scaling settings
.google.cloud.run.v2.WorkerPoolScaling scaling = 20 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
WorkerPoolScaling |
The scaling. |
getScalingBuilder()
public WorkerPoolScaling.Builder getScalingBuilder()
Optional. Specifies worker-pool-level scaling settings
.google.cloud.run.v2.WorkerPoolScaling scaling = 20 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
WorkerPoolScaling.Builder |
getScalingOrBuilder()
public WorkerPoolScalingOrBuilder getScalingOrBuilder()
Optional. Specifies worker-pool-level scaling settings
.google.cloud.run.v2.WorkerPoolScaling scaling = 20 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
WorkerPoolScalingOrBuilder |
getTemplate()
public WorkerPoolRevisionTemplate getTemplate()
Required. The template used to create revisions for this WorkerPool.
.google.cloud.run.v2.WorkerPoolRevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
WorkerPoolRevisionTemplate |
The template. |
getTemplateBuilder()
public WorkerPoolRevisionTemplate.Builder getTemplateBuilder()
Required. The template used to create revisions for this WorkerPool.
.google.cloud.run.v2.WorkerPoolRevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
WorkerPoolRevisionTemplate.Builder |
getTemplateOrBuilder()
public WorkerPoolRevisionTemplateOrBuilder getTemplateOrBuilder()
Required. The template used to create revisions for this WorkerPool.
.google.cloud.run.v2.WorkerPoolRevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
WorkerPoolRevisionTemplateOrBuilder |
getTerminalCondition()
public Condition getTerminalCondition()
Output only. The Condition of this WorkerPool, 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 WorkerPool, 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 WorkerPool, 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 |
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 |
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 worker-pool-level scaling settings
.google.cloud.run.v2.WorkerPoolScaling 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 WorkerPool.
.google.cloud.run.v2.WorkerPoolRevisionTemplate 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 WorkerPool, 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 WorkerPool.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 |
WorkerPool.Builder |
mergeCreateTime(Timestamp value)
public WorkerPool.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 |
WorkerPool.Builder |
mergeDeleteTime(Timestamp value)
public WorkerPool.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 |
WorkerPool.Builder |
mergeExpireTime(Timestamp value)
public WorkerPool.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 |
WorkerPool.Builder |
mergeFrom(WorkerPool other)
public WorkerPool.Builder mergeFrom(WorkerPool other)
Parameter | |
---|---|
Name | Description |
other |
WorkerPool |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public WorkerPool.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public WorkerPool.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
mergeScaling(WorkerPoolScaling value)
public WorkerPool.Builder mergeScaling(WorkerPoolScaling value)
Optional. Specifies worker-pool-level scaling settings
.google.cloud.run.v2.WorkerPoolScaling scaling = 20 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
WorkerPoolScaling |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
mergeTemplate(WorkerPoolRevisionTemplate value)
public WorkerPool.Builder mergeTemplate(WorkerPoolRevisionTemplate value)
Required. The template used to create revisions for this WorkerPool.
.google.cloud.run.v2.WorkerPoolRevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
WorkerPoolRevisionTemplate |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
mergeTerminalCondition(Condition value)
public WorkerPool.Builder mergeTerminalCondition(Condition value)
Output only. The Condition of this WorkerPool, 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 |
WorkerPool.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final WorkerPool.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
mergeUpdateTime(Timestamp value)
public WorkerPool.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 |
WorkerPool.Builder |
putAllAnnotations(Map<String,String> values)
public WorkerPool.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.
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 WorkerPool.
<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 |
WorkerPool.Builder |
putAllLabels(Map<String,String> values)
public WorkerPool.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.
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 WorkerPool.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values |
Map<String,String> |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
putAnnotations(String key, String value)
public WorkerPool.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.
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 WorkerPool.
<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 |
WorkerPool.Builder |
putLabels(String key, String value)
public WorkerPool.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.
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 WorkerPool.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
key |
String |
value |
String |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
removeAnnotations(String key)
public WorkerPool.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.
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 WorkerPool.
<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 |
WorkerPool.Builder |
removeConditions(int index)
public WorkerPool.Builder removeConditions(int index)
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the WorkerPool 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 |
WorkerPool.Builder |
removeInstanceSplitStatuses(int index)
public WorkerPool.Builder removeInstanceSplitStatuses(int index)
Output only. Detailed status information for corresponding instance splits.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
removeInstanceSplits(int index)
public WorkerPool.Builder removeInstanceSplits(int index)
Optional. Specifies how to distribute instances over a collection of
Revisions belonging to the WorkerPool. If instance split is empty or not
provided, defaults to 100% instances assigned to the latest Ready
Revision.
repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
removeLabels(String key)
public WorkerPool.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.
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 WorkerPool.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
setBinaryAuthorization(BinaryAuthorization value)
public WorkerPool.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 |
WorkerPool.Builder |
setBinaryAuthorization(BinaryAuthorization.Builder builderForValue)
public WorkerPool.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 |
WorkerPool.Builder |
setClient(String value)
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
setClientBytes(ByteString value)
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
setClientVersion(String value)
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
setClientVersionBytes(ByteString value)
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
setConditions(int index, Condition value)
public WorkerPool.Builder setConditions(int index, Condition value)
Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the WorkerPool 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 |
WorkerPool.Builder |
setConditions(int index, Condition.Builder builderForValue)
public WorkerPool.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 WorkerPool 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 |
WorkerPool.Builder |
setCreateTime(Timestamp value)
public WorkerPool.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 |
WorkerPool.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public WorkerPool.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 |
WorkerPool.Builder |
setCreator(String value)
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
setCreatorBytes(ByteString value)
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
setCustomAudiences(int index, String value)
public WorkerPool.Builder setCustomAudiences(int index, String value)
One or more custom audiences that you want this worker pool 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 |
WorkerPool.Builder |
This builder for chaining. |
setDeleteTime(Timestamp value)
public WorkerPool.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 |
WorkerPool.Builder |
setDeleteTime(Timestamp.Builder builderForValue)
public WorkerPool.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 |
WorkerPool.Builder |
setDescription(String value)
public WorkerPool.Builder setDescription(String value)
User-provided description of the WorkerPool. This field currently has a 512-character limit.
string description = 2;
Parameter | |
---|---|
Name | Description |
value |
String The description to set. |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public WorkerPool.Builder setDescriptionBytes(ByteString value)
User-provided description of the WorkerPool. 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 |
WorkerPool.Builder |
This builder for chaining. |
setEtag(String value)
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
setEtagBytes(ByteString value)
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
setExpireTime(Timestamp value)
public WorkerPool.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 |
WorkerPool.Builder |
setExpireTime(Timestamp.Builder builderForValue)
public WorkerPool.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 |
WorkerPool.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public WorkerPool.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
setGeneration(long value)
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
setInstanceSplitStatuses(int index, InstanceSplitStatus value)
public WorkerPool.Builder setInstanceSplitStatuses(int index, InstanceSplitStatus value)
Output only. Detailed status information for corresponding instance splits.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
InstanceSplitStatus |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
setInstanceSplitStatuses(int index, InstanceSplitStatus.Builder builderForValue)
public WorkerPool.Builder setInstanceSplitStatuses(int index, InstanceSplitStatus.Builder builderForValue)
Output only. Detailed status information for corresponding instance splits.
See comments in reconciling
for additional information on reconciliation
process in Cloud Run.
repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
InstanceSplitStatus.Builder |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
setInstanceSplits(int index, InstanceSplit value)
public WorkerPool.Builder setInstanceSplits(int index, InstanceSplit value)
Optional. Specifies how to distribute instances over a collection of
Revisions belonging to the WorkerPool. If instance split is empty or not
provided, defaults to 100% instances assigned to the latest Ready
Revision.
repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
InstanceSplit |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
setInstanceSplits(int index, InstanceSplit.Builder builderForValue)
public WorkerPool.Builder setInstanceSplits(int index, InstanceSplit.Builder builderForValue)
Optional. Specifies how to distribute instances over a collection of
Revisions belonging to the WorkerPool. If instance split is empty or not
provided, defaults to 100% instances assigned to the latest Ready
Revision.
repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
InstanceSplit.Builder |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
setLastModifier(String value)
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
setLastModifierBytes(ByteString value)
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
setLatestCreatedRevision(String value)
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
setLatestCreatedRevisionBytes(ByteString value)
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
setLatestReadyRevision(String value)
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
setLatestReadyRevisionBytes(ByteString value)
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
setLaunchStage(LaunchStage value)
public WorkerPool.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.
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 |
WorkerPool.Builder |
This builder for chaining. |
setLaunchStageValue(int value)
public WorkerPool.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.
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 |
WorkerPool.Builder |
This builder for chaining. |
setName(String value)
public WorkerPool.Builder setName(String value)
The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id.
Format:
projects/{project}/locations/{location}/workerPools/{worker_id}
string name = 1;
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public WorkerPool.Builder setNameBytes(ByteString value)
The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id.
Format:
projects/{project}/locations/{location}/workerPools/{worker_id}
string name = 1;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
This builder for chaining. |
setObservedGeneration(long value)
public WorkerPool.Builder setObservedGeneration(long value)
Output only. The generation of this WorkerPool 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 |
WorkerPool.Builder |
This builder for chaining. |
setReconciling(boolean value)
public WorkerPool.Builder setReconciling(boolean value)
Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state.
When a new WorkerPool is created, or an existing one is updated, Cloud Run
will asynchronously perform all necessary steps to bring the WorkerPool 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 WorkerPool, 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 WorkerPools. 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 |
WorkerPool.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public WorkerPool.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
setSatisfiesPzs(boolean value)
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
setScaling(WorkerPoolScaling value)
public WorkerPool.Builder setScaling(WorkerPoolScaling value)
Optional. Specifies worker-pool-level scaling settings
.google.cloud.run.v2.WorkerPoolScaling scaling = 20 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
WorkerPoolScaling |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
setScaling(WorkerPoolScaling.Builder builderForValue)
public WorkerPool.Builder setScaling(WorkerPoolScaling.Builder builderForValue)
Optional. Specifies worker-pool-level scaling settings
.google.cloud.run.v2.WorkerPoolScaling scaling = 20 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
WorkerPoolScaling.Builder |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
setTemplate(WorkerPoolRevisionTemplate value)
public WorkerPool.Builder setTemplate(WorkerPoolRevisionTemplate value)
Required. The template used to create revisions for this WorkerPool.
.google.cloud.run.v2.WorkerPoolRevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
WorkerPoolRevisionTemplate |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
setTemplate(WorkerPoolRevisionTemplate.Builder builderForValue)
public WorkerPool.Builder setTemplate(WorkerPoolRevisionTemplate.Builder builderForValue)
Required. The template used to create revisions for this WorkerPool.
.google.cloud.run.v2.WorkerPoolRevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
builderForValue |
WorkerPoolRevisionTemplate.Builder |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
setTerminalCondition(Condition value)
public WorkerPool.Builder setTerminalCondition(Condition value)
Output only. The Condition of this WorkerPool, 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 |
WorkerPool.Builder |
setTerminalCondition(Condition.Builder builderForValue)
public WorkerPool.Builder setTerminalCondition(Condition.Builder builderForValue)
Output only. The Condition of this WorkerPool, 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 |
WorkerPool.Builder |
setUid(String value)
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
setUidBytes(ByteString value)
public WorkerPool.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 |
WorkerPool.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final WorkerPool.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
WorkerPool.Builder |
setUpdateTime(Timestamp value)
public WorkerPool.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 |
WorkerPool.Builder |
setUpdateTime(Timestamp.Builder builderForValue)
public WorkerPool.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 |
WorkerPool.Builder |