public final class WorkerPool extends GeneratedMessageV3 implements WorkerPoolOrBuilder
Configuration for a WorkerPool.
Cloud Build owns and maintains a pool of workers for general use and have no
access to a project's private network. By default, builds submitted to
Cloud Build will use a worker from this pool.
If your build needs access to resources on a private network,
create and use a WorkerPool to run your builds. Private WorkerPools give
your builds access to any single VPC network that you
administer, including any on-prem resources connected to that VPC
network. For an overview of private pools, see
Private pools
overview.
Protobuf type google.devtools.cloudbuild.v1.WorkerPool
Static Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DELETE_TIME_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PRIVATE_POOL_V1_CONFIG_FIELD_NUMBER
public static final int PRIVATE_POOL_V1_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static WorkerPool getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static WorkerPool.Builder newBuilder()
newBuilder(WorkerPool prototype)
public static WorkerPool.Builder newBuilder(WorkerPool prototype)
public static WorkerPool parseDelimitedFrom(InputStream input)
public static WorkerPool parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static WorkerPool parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static WorkerPool parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static WorkerPool parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static WorkerPool parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static WorkerPool parseFrom(CodedInputStream input)
public static WorkerPool parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static WorkerPool parseFrom(InputStream input)
public static WorkerPool parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static WorkerPool parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static WorkerPool parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<WorkerPool> parser()
Methods
containsAnnotations(String key)
public boolean containsAnnotations(String key)
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAnnotations()
public Map<String,String> getAnnotations()
getAnnotationsCount()
public int getAnnotationsCount()
| Returns |
|---|
| Type | Description |
int | |
getAnnotationsMap()
public Map<String,String> getAnnotationsMap()
getAnnotationsOrDefault(String key, String defaultValue)
public String getAnnotationsOrDefault(String key, String defaultValue)
getAnnotationsOrThrow(String key)
public String getAnnotationsOrThrow(String key)
| Parameter |
|---|
| Name | Description |
key | String
|
getConfigCase()
public WorkerPool.ConfigCase getConfigCase()
getCreateTime()
public Timestamp getCreateTime()
Output only. Time at which the request to create the WorkerPool was
received.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Time at which the request to create the WorkerPool was
received.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public WorkerPool getDefaultInstanceForType()
getDeleteTime()
public Timestamp getDeleteTime()
Output only. Time at which the request to delete the WorkerPool was
received.
.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The deleteTime.
|
getDeleteTimeOrBuilder()
public TimestampOrBuilder getDeleteTimeOrBuilder()
Output only. Time at which the request to delete the WorkerPool was
received.
.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDisplayName()
public String getDisplayName()
A user-specified, human-readable name for the WorkerPool. If provided,
this value must be 1-63 characters.
string display_name = 2;
| Returns |
|---|
| Type | Description |
String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
A user-specified, human-readable name for the WorkerPool. If provided,
this value must be 1-63 characters.
string display_name = 2;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for displayName.
|
getEtag()
Output only. Checksum computed by the server. May be sent on update and
delete requests to ensure that the client has an up-to-date value before
proceeding.
string etag = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The etag.
|
getEtagBytes()
public ByteString getEtagBytes()
Output only. Checksum computed by the server. May be sent on update and
delete requests to ensure that the client has an up-to-date value before
proceeding.
string etag = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for etag.
|
getName()
Output only. The resource name of the WorkerPool, with format
projects/{project}/locations/{location}/workerPools/{worker_pool}.
The value of {worker_pool} is provided by worker_pool_id in
CreateWorkerPool request and the value of {location} is determined by
the endpoint accessed.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. The resource name of the WorkerPool, with format
projects/{project}/locations/{location}/workerPools/{worker_pool}.
The value of {worker_pool} is provided by worker_pool_id in
CreateWorkerPool request and the value of {location} is determined by
the endpoint accessed.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<WorkerPool> getParserForType()
Overrides
getPrivatePoolV1Config()
public PrivatePoolV1Config getPrivatePoolV1Config()
Private Pool using a v1 configuration.
.google.devtools.cloudbuild.v1.PrivatePoolV1Config private_pool_v1_config = 12;
getPrivatePoolV1ConfigOrBuilder()
public PrivatePoolV1ConfigOrBuilder getPrivatePoolV1ConfigOrBuilder()
Private Pool using a v1 configuration.
.google.devtools.cloudbuild.v1.PrivatePoolV1Config private_pool_v1_config = 12;
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getState()
public WorkerPool.State getState()
Output only. WorkerPool state.
.google.devtools.cloudbuild.v1.WorkerPool.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public int getStateValue()
Output only. WorkerPool state.
.google.devtools.cloudbuild.v1.WorkerPool.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for state.
|
getUid()
Output only. A unique identifier for the WorkerPool.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The uid.
|
getUidBytes()
public ByteString getUidBytes()
Output only. A unique identifier for the WorkerPool.
string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for uid.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Time at which the request to update the WorkerPool was
received.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Time at which the request to update the WorkerPool was
received.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. Time at which the request to create the WorkerPool was
received.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set.
|
hasDeleteTime()
public boolean hasDeleteTime()
Output only. Time at which the request to delete the WorkerPool was
received.
.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the deleteTime field is set.
|
hasPrivatePoolV1Config()
public boolean hasPrivatePoolV1Config()
Private Pool using a v1 configuration.
.google.devtools.cloudbuild.v1.PrivatePoolV1Config private_pool_v1_config = 12;
| Returns |
|---|
| Type | Description |
boolean | Whether the privatePoolV1Config field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. Time at which the request to update the WorkerPool was
received.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public WorkerPool.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected WorkerPool.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public WorkerPool.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
