Class WorkerPool.Builder (0.72.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 0.78.0 (latest)
- 0.76.0
- 0.75.0
- 0.74.0
- 0.73.0
- 0.72.0
- 0.70.0
- 0.68.0
- 0.67.0
- 0.64.0
- 0.63.0
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.5
- 0.2.1
- 0.1.2
publicstaticfinalclass WorkerPool.BuilderextendsGeneratedMessageV3.Builder<WorkerPool.Builder>implementsWorkerPoolOrBuilderWorkerPool 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
WorkerPoolOrBuilderInherited Members
Static Methods
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllConditions(Iterable<? extends Condition> values)
publicWorkerPool.BuilderaddAllConditions(Iterable<?extendsCondition>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)
publicWorkerPool.BuilderaddAllCustomAudiences(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)
publicWorkerPool.BuilderaddAllInstanceSplitStatuses(Iterable<?extendsInstanceSplitStatus>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)
publicWorkerPool.BuilderaddAllInstanceSplits(Iterable<?extendsInstanceSplit>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)
publicWorkerPool.BuilderaddConditions(Conditionvalue) 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)
publicWorkerPool.BuilderaddConditions(Condition.BuilderbuilderForValue) 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)
publicWorkerPool.BuilderaddConditions(intindex,Conditionvalue) 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)
publicWorkerPool.BuilderaddConditions(intindex,Condition.BuilderbuilderForValue) 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()
publicCondition.BuilderaddConditionsBuilder() 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)
publicCondition.BuilderaddConditionsBuilder(intindex) 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)
publicWorkerPool.BuilderaddCustomAudiences(Stringvalue)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)
publicWorkerPool.BuilderaddCustomAudiencesBytes(ByteStringvalue)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)
publicWorkerPool.BuilderaddInstanceSplitStatuses(InstanceSplitStatusvalue) 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)
publicWorkerPool.BuilderaddInstanceSplitStatuses(InstanceSplitStatus.BuilderbuilderForValue) 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)
publicWorkerPool.BuilderaddInstanceSplitStatuses(intindex,InstanceSplitStatusvalue) 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)
publicWorkerPool.BuilderaddInstanceSplitStatuses(intindex,InstanceSplitStatus.BuilderbuilderForValue) 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()
publicInstanceSplitStatus.BuilderaddInstanceSplitStatusesBuilder() 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)
publicInstanceSplitStatus.BuilderaddInstanceSplitStatusesBuilder(intindex) 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)
publicWorkerPool.BuilderaddInstanceSplits(InstanceSplitvalue) 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)
publicWorkerPool.BuilderaddInstanceSplits(InstanceSplit.BuilderbuilderForValue) 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)
publicWorkerPool.BuilderaddInstanceSplits(intindex,InstanceSplitvalue) 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)
publicWorkerPool.BuilderaddInstanceSplits(intindex,InstanceSplit.BuilderbuilderForValue) 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()
publicInstanceSplit.BuilderaddInstanceSplitsBuilder() 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)
publicInstanceSplit.BuilderaddInstanceSplitsBuilder(intindex) 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)
publicWorkerPool.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
WorkerPool.Builder |
|
build()
publicWorkerPoolbuild()| Returns | |
|---|---|
| Type | Description |
WorkerPool |
|
buildPartial()
publicWorkerPoolbuildPartial()| Returns | |
|---|---|
| Type | Description |
WorkerPool |
|
clear()
publicWorkerPool.Builderclear()| Returns | |
|---|---|
| Type | Description |
WorkerPool.Builder |
|
clearAnnotations()
publicWorkerPool.BuilderclearAnnotations()| Returns | |
|---|---|
| Type | Description |
WorkerPool.Builder |
|
clearBinaryAuthorization()
publicWorkerPool.BuilderclearBinaryAuthorization()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()
publicWorkerPool.BuilderclearClient()Arbitrary identifier for the API client.
string client = 13;
| Returns | |
|---|---|
| Type | Description |
WorkerPool.Builder |
This builder for chaining. |
clearClientVersion()
publicWorkerPool.BuilderclearClientVersion()Arbitrary version identifier for the API client.
string client_version = 14;
| Returns | |
|---|---|
| Type | Description |
WorkerPool.Builder |
This builder for chaining. |
clearConditions()
publicWorkerPool.BuilderclearConditions() 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()
publicWorkerPool.BuilderclearCreateTime()Output only. The creation time.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
WorkerPool.Builder |
|
clearCreator()
publicWorkerPool.BuilderclearCreator()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()
publicWorkerPool.BuilderclearCustomAudiences()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()
publicWorkerPool.BuilderclearDeleteTime()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()
publicWorkerPool.BuilderclearDescription()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()
publicWorkerPool.BuilderclearEtag()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()
publicWorkerPool.BuilderclearExpireTime()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)
publicWorkerPool.BuilderclearField(Descriptors.FieldDescriptorfield)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
WorkerPool.Builder |
|
clearGeneration()
publicWorkerPool.BuilderclearGeneration() 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()
publicWorkerPool.BuilderclearInstanceSplitStatuses() 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()
publicWorkerPool.BuilderclearInstanceSplits() 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()
publicWorkerPool.BuilderclearLabels()| Returns | |
|---|---|
| Type | Description |
WorkerPool.Builder |
|
clearLastModifier()
publicWorkerPool.BuilderclearLastModifier()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()
publicWorkerPool.BuilderclearLatestCreatedRevision() 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()
publicWorkerPool.BuilderclearLatestReadyRevision() 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()
publicWorkerPool.BuilderclearLaunchStage() 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()
publicWorkerPool.BuilderclearName()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()
publicWorkerPool.BuilderclearObservedGeneration() 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)
publicWorkerPool.BuilderclearOneof(Descriptors.OneofDescriptoroneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
WorkerPool.Builder |
|
clearReconciling()
publicWorkerPool.BuilderclearReconciling()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()
publicWorkerPool.BuilderclearSatisfiesPzs()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()
publicWorkerPool.BuilderclearScaling()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()
publicWorkerPool.BuilderclearTemplate()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()
publicWorkerPool.BuilderclearTerminalCondition() 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()
publicWorkerPool.BuilderclearUid()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()
publicWorkerPool.BuilderclearUpdateTime()Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
WorkerPool.Builder |
|
clone()
publicWorkerPool.Builderclone()| Returns | |
|---|---|
| Type | Description |
WorkerPool.Builder |
|
containsAnnotations(String key)
publicbooleancontainsAnnotations(Stringkey)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)
publicbooleancontainsLabels(Stringkey)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)
publicMap<String,String>getAnnotations()Use #getAnnotationsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getAnnotationsCount()
publicintgetAnnotationsCount()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()
publicMap<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)
publicStringgetAnnotationsOrDefault(Stringkey,StringdefaultValue)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)
publicStringgetAnnotationsOrThrow(Stringkey)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()
publicBinaryAuthorizationgetBinaryAuthorization()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()
publicBinaryAuthorization.BuildergetBinaryAuthorizationBuilder()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()
publicBinaryAuthorizationOrBuildergetBinaryAuthorizationOrBuilder()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()
publicStringgetClient()Arbitrary identifier for the API client.
string client = 13;
| Returns | |
|---|---|
| Type | Description |
String |
The client. |
getClientBytes()
publicByteStringgetClientBytes()Arbitrary identifier for the API client.
string client = 13;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for client. |
getClientVersion()
publicStringgetClientVersion()Arbitrary version identifier for the API client.
string client_version = 14;
| Returns | |
|---|---|
| Type | Description |
String |
The clientVersion. |
getClientVersionBytes()
publicByteStringgetClientVersionBytes()Arbitrary version identifier for the API client.
string client_version = 14;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for clientVersion. |
getConditions(int index)
publicConditiongetConditions(intindex) Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the 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)
publicCondition.BuildergetConditionsBuilder(intindex) 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()
publicList<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()
publicintgetConditionsCount() 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()
publicList<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)
publicConditionOrBuildergetConditionsOrBuilder(intindex) 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()
publicList<?extendsConditionOrBuilder>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()
publicTimestampgetCreateTime()Output only. The creation time.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeBuilder()
publicTimestamp.BuildergetCreateTimeBuilder()Output only. The creation time.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getCreateTimeOrBuilder()
publicTimestampOrBuildergetCreateTimeOrBuilder()Output only. The creation time.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getCreator()
publicStringgetCreator()Output only. Email address of the authenticated creator.
string creator = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The creator. |
getCreatorBytes()
publicByteStringgetCreatorBytes()Output only. Email address of the authenticated creator.
string creator = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for creator. |
getCustomAudiences(int index)
publicStringgetCustomAudiences(intindex)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)
publicByteStringgetCustomAudiencesBytes(intindex)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()
publicintgetCustomAudiencesCount()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()
publicProtocolStringListgetCustomAudiencesList()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()
publicWorkerPoolgetDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
WorkerPool |
|
getDeleteTime()
publicTimestampgetDeleteTime()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()
publicTimestamp.BuildergetDeleteTimeBuilder()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()
publicTimestampOrBuildergetDeleteTimeOrBuilder()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()
publicStringgetDescription()User-provided description of the WorkerPool. This field currently has a 512-character limit.
string description = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
publicByteStringgetDescriptionBytes()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()
publicDescriptors.DescriptorgetDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getEtag()
publicStringgetEtag()Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The etag. |
getEtagBytes()
publicByteStringgetEtagBytes()Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for etag. |
getExpireTime()
publicTimestampgetExpireTime()Output only. For a deleted resource, the time after which it will be permamently deleted.
.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The expireTime. |
getExpireTimeBuilder()
publicTimestamp.BuildergetExpireTimeBuilder()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()
publicTimestampOrBuildergetExpireTimeOrBuilder()Output only. For a deleted resource, the time after which it will be permamently deleted.
.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getGeneration()
publiclonggetGeneration() Output only. A number that monotonically increases every time the user
modifies the desired state.
Please note that unlike v1, this is an int64 value. As with most Google
APIs, its JSON representation will be a string instead of an integer.
int64 generation = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
long |
The generation. |
getInstanceSplitStatuses(int index)
publicInstanceSplitStatusgetInstanceSplitStatuses(intindex) 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)
publicInstanceSplitStatus.BuildergetInstanceSplitStatusesBuilder(intindex) 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()
publicList<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()
publicintgetInstanceSplitStatusesCount() 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()
publicList<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)
publicInstanceSplitStatusOrBuildergetInstanceSplitStatusesOrBuilder(intindex) 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()
publicList<?extendsInstanceSplitStatusOrBuilder>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)
publicInstanceSplitgetInstanceSplits(intindex) 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)
publicInstanceSplit.BuildergetInstanceSplitsBuilder(intindex) 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()
publicList<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()
publicintgetInstanceSplitsCount() 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()
publicList<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)
publicInstanceSplitOrBuildergetInstanceSplitsOrBuilder(intindex) 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()
publicList<?extendsInstanceSplitOrBuilder>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)
publicMap<String,String>getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
publicintgetLabelsCount()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()
publicMap<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)
publicStringgetLabelsOrDefault(Stringkey,StringdefaultValue)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)
publicStringgetLabelsOrThrow(Stringkey)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()
publicStringgetLastModifier()Output only. Email address of the last authenticated modifier.
string last_modifier = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The lastModifier. |
getLastModifierBytes()
publicByteStringgetLastModifierBytes()Output only. Email address of the last authenticated modifier.
string last_modifier = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for lastModifier. |
getLatestCreatedRevision()
publicStringgetLatestCreatedRevision() Output only. Name of the last created revision. See comments in
reconciling for additional information on reconciliation process in Cloud
Run.
string latest_created_revision = 34 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The latestCreatedRevision. |
getLatestCreatedRevisionBytes()
publicByteStringgetLatestCreatedRevisionBytes() Output only. Name of the last created revision. See comments in
reconciling for additional information on reconciliation process in Cloud
Run.
string latest_created_revision = 34 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for latestCreatedRevision. |
getLatestReadyRevision()
publicStringgetLatestReadyRevision() Output only. Name of the latest revision that is serving traffic. See
comments in reconciling for additional information on reconciliation
process in Cloud Run.
string latest_ready_revision = 33 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The latestReadyRevision. |
getLatestReadyRevisionBytes()
publicByteStringgetLatestReadyRevisionBytes() Output only. Name of the latest revision that is serving traffic. See
comments in reconciling for additional information on reconciliation
process in Cloud Run.
string latest_ready_revision = 33 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for latestReadyRevision. |
getLaunchStage()
publicLaunchStagegetLaunchStage() 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()
publicintgetLaunchStageValue() 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)
publicMap<String,String>getMutableAnnotations()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getMutableLabels() (deprecated)
publicMap<String,String>getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getName()
publicStringgetName()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()
publicByteStringgetNameBytes()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()
publiclonggetObservedGeneration() 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()
publicbooleangetReconciling()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()
publicbooleangetSatisfiesPzs()Output only. Reserved for future use.
bool satisfies_pzs = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The satisfiesPzs. |
getScaling()
publicWorkerPoolScalinggetScaling()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()
publicWorkerPoolScaling.BuildergetScalingBuilder()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()
publicWorkerPoolScalingOrBuildergetScalingOrBuilder()Optional. Specifies worker-pool-level scaling settings
.google.cloud.run.v2.WorkerPoolScaling scaling = 20 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
WorkerPoolScalingOrBuilder |
|
getTemplate()
publicWorkerPoolRevisionTemplategetTemplate()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()
publicWorkerPoolRevisionTemplate.BuildergetTemplateBuilder()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()
publicWorkerPoolRevisionTemplateOrBuildergetTemplateOrBuilder()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()
publicConditiongetTerminalCondition() 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()
publicCondition.BuildergetTerminalConditionBuilder() 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()
publicConditionOrBuildergetTerminalConditionOrBuilder() 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()
publicStringgetUid()Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The uid. |
getUidBytes()
publicByteStringgetUidBytes()Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for uid. |
getUpdateTime()
publicTimestampgetUpdateTime()Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeBuilder()
publicTimestamp.BuildergetUpdateTimeBuilder()Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getUpdateTimeOrBuilder()
publicTimestampOrBuildergetUpdateTimeOrBuilder()Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
hasBinaryAuthorization()
publicbooleanhasBinaryAuthorization()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()
publicbooleanhasCreateTime()Output only. The creation time.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasDeleteTime()
publicbooleanhasDeleteTime()Output only. The deletion time. 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()
publicbooleanhasExpireTime()Output only. For a deleted resource, the time after which it will be permamently deleted.
.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the expireTime field is set. |
hasScaling()
publicbooleanhasScaling()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()
publicbooleanhasTemplate()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()
publicbooleanhasTerminalCondition() 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()
publicbooleanhasUpdateTime()Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protectedMapFieldReflectionAccessorinternalGetMapFieldReflection(intnumber)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protectedMapFieldReflectionAccessorinternalGetMutableMapFieldReflection(intnumber)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
publicfinalbooleanisInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeBinaryAuthorization(BinaryAuthorization value)
publicWorkerPool.BuildermergeBinaryAuthorization(BinaryAuthorizationvalue)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)
publicWorkerPool.BuildermergeCreateTime(Timestampvalue)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)
publicWorkerPool.BuildermergeDeleteTime(Timestampvalue)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)
publicWorkerPool.BuildermergeExpireTime(Timestampvalue)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)
publicWorkerPool.BuildermergeFrom(WorkerPoolother)| Parameter | |
|---|---|
| Name | Description |
other |
WorkerPool |
| Returns | |
|---|---|
| Type | Description |
WorkerPool.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicWorkerPool.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
WorkerPool.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
publicWorkerPool.BuildermergeFrom(Messageother)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
WorkerPool.Builder |
|
mergeScaling(WorkerPoolScaling value)
publicWorkerPool.BuildermergeScaling(WorkerPoolScalingvalue)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)
publicWorkerPool.BuildermergeTemplate(WorkerPoolRevisionTemplatevalue)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)
publicWorkerPool.BuildermergeTerminalCondition(Conditionvalue) 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)
publicfinalWorkerPool.BuildermergeUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
WorkerPool.Builder |
|
mergeUpdateTime(Timestamp value)
publicWorkerPool.BuildermergeUpdateTime(Timestampvalue)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)
publicWorkerPool.BuilderputAllAnnotations(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)
publicWorkerPool.BuilderputAllLabels(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)
publicWorkerPool.BuilderputAnnotations(Stringkey,Stringvalue)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)
publicWorkerPool.BuilderputLabels(Stringkey,Stringvalue)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)
publicWorkerPool.BuilderremoveAnnotations(Stringkey)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)
publicWorkerPool.BuilderremoveConditions(intindex) 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)
publicWorkerPool.BuilderremoveInstanceSplitStatuses(intindex) 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)
publicWorkerPool.BuilderremoveInstanceSplits(intindex) 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)
publicWorkerPool.BuilderremoveLabels(Stringkey)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)
publicWorkerPool.BuildersetBinaryAuthorization(BinaryAuthorizationvalue)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)
publicWorkerPool.BuildersetBinaryAuthorization(BinaryAuthorization.BuilderbuilderForValue)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)
publicWorkerPool.BuildersetClient(Stringvalue)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)
publicWorkerPool.BuildersetClientBytes(ByteStringvalue)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)
publicWorkerPool.BuildersetClientVersion(Stringvalue)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)
publicWorkerPool.BuildersetClientVersionBytes(ByteStringvalue)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)
publicWorkerPool.BuildersetConditions(intindex,Conditionvalue) 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)
publicWorkerPool.BuildersetConditions(intindex,Condition.BuilderbuilderForValue) 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)
publicWorkerPool.BuildersetCreateTime(Timestampvalue)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)
publicWorkerPool.BuildersetCreateTime(Timestamp.BuilderbuilderForValue)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)
publicWorkerPool.BuildersetCreator(Stringvalue)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)
publicWorkerPool.BuildersetCreatorBytes(ByteStringvalue)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)
publicWorkerPool.BuildersetCustomAudiences(intindex,Stringvalue)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)
publicWorkerPool.BuildersetDeleteTime(Timestampvalue)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)
publicWorkerPool.BuildersetDeleteTime(Timestamp.BuilderbuilderForValue)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)
publicWorkerPool.BuildersetDescription(Stringvalue)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)
publicWorkerPool.BuildersetDescriptionBytes(ByteStringvalue)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)
publicWorkerPool.BuildersetEtag(Stringvalue)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)
publicWorkerPool.BuildersetEtagBytes(ByteStringvalue)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)
publicWorkerPool.BuildersetExpireTime(Timestampvalue)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)
publicWorkerPool.BuildersetExpireTime(Timestamp.BuilderbuilderForValue)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)
publicWorkerPool.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
WorkerPool.Builder |
|
setGeneration(long value)
publicWorkerPool.BuildersetGeneration(longvalue) 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)
publicWorkerPool.BuildersetInstanceSplitStatuses(intindex,InstanceSplitStatusvalue) 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)
publicWorkerPool.BuildersetInstanceSplitStatuses(intindex,InstanceSplitStatus.BuilderbuilderForValue) 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)
publicWorkerPool.BuildersetInstanceSplits(intindex,InstanceSplitvalue) 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)
publicWorkerPool.BuildersetInstanceSplits(intindex,InstanceSplit.BuilderbuilderForValue) 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)
publicWorkerPool.BuildersetLastModifier(Stringvalue)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)
publicWorkerPool.BuildersetLastModifierBytes(ByteStringvalue)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)
publicWorkerPool.BuildersetLatestCreatedRevision(Stringvalue) 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)
publicWorkerPool.BuildersetLatestCreatedRevisionBytes(ByteStringvalue) 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)
publicWorkerPool.BuildersetLatestReadyRevision(Stringvalue) 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)
publicWorkerPool.BuildersetLatestReadyRevisionBytes(ByteStringvalue) 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)
publicWorkerPool.BuildersetLaunchStage(LaunchStagevalue) 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.LaunchStageThe launchStage to set. |
| Returns | |
|---|---|
| Type | Description |
WorkerPool.Builder |
This builder for chaining. |
setLaunchStageValue(int value)
publicWorkerPool.BuildersetLaunchStageValue(intvalue) 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)
publicWorkerPool.BuildersetName(Stringvalue)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)
publicWorkerPool.BuildersetNameBytes(ByteStringvalue)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)
publicWorkerPool.BuildersetObservedGeneration(longvalue) 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)
publicWorkerPool.BuildersetReconciling(booleanvalue)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)
publicWorkerPool.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
WorkerPool.Builder |
|
setSatisfiesPzs(boolean value)
publicWorkerPool.BuildersetSatisfiesPzs(booleanvalue)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)
publicWorkerPool.BuildersetScaling(WorkerPoolScalingvalue)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)
publicWorkerPool.BuildersetScaling(WorkerPoolScaling.BuilderbuilderForValue)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)
publicWorkerPool.BuildersetTemplate(WorkerPoolRevisionTemplatevalue)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)
publicWorkerPool.BuildersetTemplate(WorkerPoolRevisionTemplate.BuilderbuilderForValue)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)
publicWorkerPool.BuildersetTerminalCondition(Conditionvalue) 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)
publicWorkerPool.BuildersetTerminalCondition(Condition.BuilderbuilderForValue) 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)
publicWorkerPool.BuildersetUid(Stringvalue)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)
publicWorkerPool.BuildersetUidBytes(ByteStringvalue)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)
publicfinalWorkerPool.BuildersetUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
WorkerPool.Builder |
|
setUpdateTime(Timestamp value)
publicWorkerPool.BuildersetUpdateTime(Timestampvalue)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)
publicWorkerPool.BuildersetUpdateTime(Timestamp.BuilderbuilderForValue)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 |
|