Interface WorkerPoolOrBuilder (0.72.0) 

public interface WorkerPoolOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract boolean containsAnnotations(String key)

Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 WorkerPool.

<p>This field follows Kubernetes annotations' namespacing, limits, and rules.

map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPool.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getAnnotations() (deprecated)

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public abstract int getAnnotationsCount()

Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 WorkerPool.

<p>This field follows Kubernetes annotations' namespacing, limits, and rules.

map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAnnotationsMap()

public abstract Map<String,String> getAnnotationsMap()

Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 WorkerPool.

<p>This field follows Kubernetes annotations' namespacing, limits, and rules.

map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public abstract String getAnnotationsOrDefault(String key, String defaultValue)

Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 WorkerPool.

<p>This field follows Kubernetes annotations' namespacing, limits, and rules.

map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAnnotationsOrThrow(String key)

public abstract String getAnnotationsOrThrow(String key)

Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 WorkerPool.

<p>This field follows Kubernetes annotations' namespacing, limits, and rules.

map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getBinaryAuthorization()

public abstract BinaryAuthorization getBinaryAuthorization()

Optional. Settings for the Binary Authorization feature.

.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BinaryAuthorization

The binaryAuthorization.

getBinaryAuthorizationOrBuilder()

public abstract BinaryAuthorizationOrBuilder getBinaryAuthorizationOrBuilder()

Optional. Settings for the Binary Authorization feature.

.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BinaryAuthorizationOrBuilder

getClient()

public abstract String getClient()

Arbitrary identifier for the API client.

string client = 13;

Returns
Type Description
String

The client.

getClientBytes()

public abstract ByteString getClientBytes()

Arbitrary identifier for the API client.

string client = 13;

Returns
Type Description
ByteString

The bytes for client.

getClientVersion()

public abstract String getClientVersion()

Arbitrary version identifier for the API client.

string client_version = 14;

Returns
Type Description
String

The clientVersion.

getClientVersionBytes()

public abstract ByteString getClientVersionBytes()

Arbitrary version identifier for the API client.

string client_version = 14;

Returns
Type Description
ByteString

The bytes for clientVersion.

getConditions(int index)

public abstract Condition getConditions(int index)

Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the WorkerPool does not reach its Serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Condition

getConditionsCount()

public abstract int getConditionsCount()

Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the WorkerPool does not reach its Serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getConditionsList()

public abstract List<Condition> getConditionsList()

Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the WorkerPool does not reach its Serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Condition>

getConditionsOrBuilder(int index)

public abstract ConditionOrBuilder getConditionsOrBuilder(int index)

Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the WorkerPool does not reach its Serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ConditionOrBuilder

getConditionsOrBuilderList()

public abstract List<? extends ConditionOrBuilder> getConditionsOrBuilderList()

Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the WorkerPool does not reach its Serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

repeated .google.cloud.run.v2.Condition conditions = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.run.v2.ConditionOrBuilder>

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCreator()

public abstract String getCreator()

Output only. Email address of the authenticated creator.

string creator = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The creator.

getCreatorBytes()

public abstract ByteString getCreatorBytes()

Output only. Email address of the authenticated creator.

string creator = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for creator.

getCustomAudiences(int index)

public abstract String getCustomAudiences(int index)

One or more custom audiences that you want this worker pool to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.

repeated string custom_audiences = 37;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The customAudiences at the given index.

getCustomAudiencesBytes(int index)

public abstract ByteString getCustomAudiencesBytes(int index)

One or more custom audiences that you want this worker pool to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.

repeated string custom_audiences = 37;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the customAudiences at the given index.

getCustomAudiencesCount()

public abstract int getCustomAudiencesCount()

One or more custom audiences that you want this worker pool to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.

repeated string custom_audiences = 37;

Returns
Type Description
int

The count of customAudiences.

getCustomAudiencesList()

public abstract List<String> getCustomAudiencesList()

One or more custom audiences that you want this worker pool to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.

repeated string custom_audiences = 37;

Returns
Type Description
List<String>

A list containing the customAudiences.

getDeleteTime()

public abstract Timestamp getDeleteTime()

Output only. The deletion time. It is only populated as a response to a Delete request.

.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The deleteTime.

getDeleteTimeOrBuilder()

public abstract TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. The deletion time. It is only populated as a response to a Delete request.

.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDescription()

public abstract String getDescription()

User-provided description of the WorkerPool. This field currently has a 512-character limit.

string description = 2;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

User-provided description of the WorkerPool. This field currently has a 512-character limit.

string description = 2;

Returns
Type Description
ByteString

The bytes for description.

getEtag()

public abstract String getEtag()

Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for etag.

getExpireTime()

public abstract Timestamp getExpireTime()

Output only. For a deleted resource, the time after which it will be permamently deleted.

.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The expireTime.

getExpireTimeOrBuilder()

public abstract TimestampOrBuilder getExpireTimeOrBuilder()

Output only. For a deleted resource, the time after which it will be permamently deleted.

.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getGeneration()

public abstract long getGeneration()

Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.

int64 generation = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The generation.

getInstanceSplitStatuses(int index)

public abstract InstanceSplitStatus getInstanceSplitStatuses(int index)

Output only. Detailed status information for corresponding instance splits. See comments in reconciling for additional information on reconciliation process in Cloud Run.

repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
InstanceSplitStatus

getInstanceSplitStatusesCount()

public abstract int getInstanceSplitStatusesCount()

Output only. Detailed status information for corresponding instance splits. See comments in reconciling for additional information on reconciliation process in Cloud Run.

repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getInstanceSplitStatusesList()

public abstract List<InstanceSplitStatus> getInstanceSplitStatusesList()

Output only. Detailed status information for corresponding instance splits. See comments in reconciling for additional information on reconciliation process in Cloud Run.

repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<InstanceSplitStatus>

getInstanceSplitStatusesOrBuilder(int index)

public abstract InstanceSplitStatusOrBuilder getInstanceSplitStatusesOrBuilder(int index)

Output only. Detailed status information for corresponding instance splits. See comments in reconciling for additional information on reconciliation process in Cloud Run.

repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
InstanceSplitStatusOrBuilder

getInstanceSplitStatusesOrBuilderList()

public abstract List<? extends InstanceSplitStatusOrBuilder> getInstanceSplitStatusesOrBuilderList()

Output only. Detailed status information for corresponding instance splits. See comments in reconciling for additional information on reconciliation process in Cloud Run.

repeated .google.cloud.run.v2.InstanceSplitStatus instance_split_statuses = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.run.v2.InstanceSplitStatusOrBuilder>

getInstanceSplits(int index)

public abstract InstanceSplit getInstanceSplits(int index)

Optional. Specifies how to distribute instances over a collection of Revisions belonging to the WorkerPool. If instance split is empty or not provided, defaults to 100% instances assigned to the latest Ready Revision.

repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
InstanceSplit

getInstanceSplitsCount()

public abstract int getInstanceSplitsCount()

Optional. Specifies how to distribute instances over a collection of Revisions belonging to the WorkerPool. If instance split is empty or not provided, defaults to 100% instances assigned to the latest Ready Revision.

repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getInstanceSplitsList()

public abstract List<InstanceSplit> getInstanceSplitsList()

Optional. Specifies how to distribute instances over a collection of Revisions belonging to the WorkerPool. If instance split is empty or not provided, defaults to 100% instances assigned to the latest Ready Revision.

repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<InstanceSplit>

getInstanceSplitsOrBuilder(int index)

public abstract InstanceSplitOrBuilder getInstanceSplitsOrBuilder(int index)

Optional. Specifies how to distribute instances over a collection of Revisions belonging to the WorkerPool. If instance split is empty or not provided, defaults to 100% instances assigned to the latest Ready Revision.

repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
InstanceSplitOrBuilder

getInstanceSplitsOrBuilderList()

public abstract List<? extends InstanceSplitOrBuilder> getInstanceSplitsOrBuilderList()

Optional. Specifies how to distribute instances over a collection of Revisions belonging to the WorkerPool. If instance split is empty or not provided, defaults to 100% instances assigned to the latest Ready Revision.

repeated .google.cloud.run.v2.InstanceSplit instance_splits = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.run.v2.InstanceSplitOrBuilder>

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPool.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPool.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPool.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPool.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getLastModifier()

public abstract String getLastModifier()

Output only. Email address of the last authenticated modifier.

string last_modifier = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The lastModifier.

getLastModifierBytes()

public abstract ByteString getLastModifierBytes()

Output only. Email address of the last authenticated modifier.

string last_modifier = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for lastModifier.

getLatestCreatedRevision()

public abstract String getLatestCreatedRevision()

Output only. Name of the last created revision. See comments in reconciling for additional information on reconciliation process in Cloud Run.

string latest_created_revision = 34 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The latestCreatedRevision.

getLatestCreatedRevisionBytes()

public abstract ByteString getLatestCreatedRevisionBytes()

Output only. Name of the last created revision. See comments in reconciling for additional information on reconciliation process in Cloud Run.

string latest_created_revision = 34 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for latestCreatedRevision.

getLatestReadyRevision()

public abstract String getLatestReadyRevision()

Output only. Name of the latest revision that is serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run.

string latest_ready_revision = 33 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The latestReadyRevision.

getLatestReadyRevisionBytes()

public abstract ByteString getLatestReadyRevisionBytes()

Output only. Name of the latest revision that is serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run.

string latest_ready_revision = 33 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for latestReadyRevision.

getLaunchStage()

public abstract LaunchStage getLaunchStage()

Optional. The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.

For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.

.google.api.LaunchStage launch_stage = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.api.LaunchStage

The launchStage.

getLaunchStageValue()

public abstract int getLaunchStageValue()

Optional. The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features.

For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.

.google.api.LaunchStage launch_stage = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for launchStage.

getName()

public abstract String getName()

The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id.

Format: projects/{project}/locations/{location}/workerPools/{worker_id}

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id.

Format: projects/{project}/locations/{location}/workerPools/{worker_id}

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getObservedGeneration()

public abstract long getObservedGeneration()

Output only. The generation of this WorkerPool currently serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.

int64 observed_generation = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The observedGeneration.

getReconciling()

public abstract boolean getReconciling()

Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state.

When a new WorkerPool is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the WorkerPool to the desired serving state. This process is called reconciliation. While reconciliation is in process, observed_generation, latest_ready_revison, traffic_statuses, and uri will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the WorkerPool, or there was an error, and reconciliation failed. This state can be found in terminal_condition.state.

If reconciliation succeeded, the following fields will match: traffic and traffic_statuses, observed_generation and generation, latest_ready_revision and latest_created_revision.

If reconciliation failed, traffic_statuses, observed_generation, and latest_ready_revision will have the state of the last serving revision, or empty for newly created WorkerPools. Additional information on the failure can be found in terminal_condition and conditions.

bool reconciling = 98 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The reconciling.

getSatisfiesPzs()

public abstract boolean getSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzs.

getScaling()

public abstract WorkerPoolScaling getScaling()

Optional. Specifies worker-pool-level scaling settings

.google.cloud.run.v2.WorkerPoolScaling scaling = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WorkerPoolScaling

The scaling.

getScalingOrBuilder()

public abstract WorkerPoolScalingOrBuilder getScalingOrBuilder()

Optional. Specifies worker-pool-level scaling settings

.google.cloud.run.v2.WorkerPoolScaling scaling = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
WorkerPoolScalingOrBuilder

getTemplate()

public abstract WorkerPoolRevisionTemplate getTemplate()

Required. The template used to create revisions for this WorkerPool.

.google.cloud.run.v2.WorkerPoolRevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
WorkerPoolRevisionTemplate

The template.

getTemplateOrBuilder()

public abstract WorkerPoolRevisionTemplateOrBuilder getTemplateOrBuilder()

Required. The template used to create revisions for this WorkerPool.

.google.cloud.run.v2.WorkerPoolRevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
WorkerPoolRevisionTemplateOrBuilder

getTerminalCondition()

public abstract Condition getTerminalCondition()

Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

.google.cloud.run.v2.Condition terminal_condition = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Condition

The terminalCondition.

getTerminalConditionOrBuilder()

public abstract ConditionOrBuilder getTerminalConditionOrBuilder()

Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

.google.cloud.run.v2.Condition terminal_condition = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ConditionOrBuilder

getUid()

public abstract String getUid()

Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The last-modified time.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The last-modified time.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasBinaryAuthorization()

public abstract boolean hasBinaryAuthorization()

Optional. Settings for the Binary Authorization feature.

.google.cloud.run.v2.BinaryAuthorization binary_authorization = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the binaryAuthorization field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDeleteTime()

public abstract boolean hasDeleteTime()

Output only. The deletion time. It is only populated as a response to a Delete request.

.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the deleteTime field is set.

hasExpireTime()

public abstract boolean hasExpireTime()

Output only. For a deleted resource, the time after which it will be permamently deleted.

.google.protobuf.Timestamp expire_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the expireTime field is set.

hasScaling()

public abstract boolean hasScaling()

Optional. Specifies worker-pool-level scaling settings

.google.cloud.run.v2.WorkerPoolScaling scaling = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the scaling field is set.

hasTemplate()

public abstract boolean hasTemplate()

Required. The template used to create revisions for this WorkerPool.

.google.cloud.run.v2.WorkerPoolRevisionTemplate template = 18 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the template field is set.

hasTerminalCondition()

public abstract boolean hasTerminalCondition()

Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.

.google.cloud.run.v2.Condition terminal_condition = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the terminalCondition field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The last-modified time.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.