Package com.google.cloudbuild.v1

Class WorkerPool

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloudbuild.v1.WorkerPool
All Implemented Interfaces:
WorkerPoolOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class WorkerPool extends com.google.protobuf.GeneratedMessage 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 `WorkerPool`s 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](https://cloud.google.com/build/docs/private-pools/private-pools-overview).
Protobuf type google.devtools.cloudbuild.v1.WorkerPool
See Also:

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getConfigCase

      public WorkerPool.ConfigCase getConfigCase()
      Specified by:
      getConfigCase in interface WorkerPoolOrBuilder

    • getName

      public String 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];
      Specified by:
      getName in interface WorkerPoolOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.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];
      Specified by:
      getNameBytes in interface WorkerPoolOrBuilder
      Returns:
      The bytes for name.

    • 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;
      Specified by:
      getDisplayName in interface WorkerPoolOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       A user-specified, human-readable name for the `WorkerPool`. If provided,
 this value must be 1-63 characters.
      string display_name = 2;
      Specified by:
      getDisplayNameBytes in interface WorkerPoolOrBuilder
      Returns:
      The bytes for displayName.

    • getUid

      public String getUid()
       Output only. A unique identifier for the `WorkerPool`.
      string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUid in interface WorkerPoolOrBuilder
      Returns:
      The uid.

    • getUidBytes

      public com.google.protobuf.ByteString getUidBytes()
       Output only. A unique identifier for the `WorkerPool`.
      string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUidBytes in interface WorkerPoolOrBuilder
      Returns:
      The bytes for uid.

    • getAnnotationsCount

      public int getAnnotationsCount()
      Description copied from interface: WorkerPoolOrBuilder
       User specified annotations. See https://google.aip.dev/128#annotations
 for more details such as format and size limitations.
      map<string, string> annotations = 4;
      Specified by:
      getAnnotationsCount in interface WorkerPoolOrBuilder

    • containsAnnotations

      public boolean containsAnnotations(String key)
       User specified annotations. See https://google.aip.dev/128#annotations
 for more details such as format and size limitations.
      map<string, string> annotations = 4;
      Specified by:
      containsAnnotations in interface WorkerPoolOrBuilder

    • getAnnotations

      @Deprecated public Map<String,String> getAnnotations()
      Deprecated.
      Use getAnnotationsMap() instead.
      Specified by:
      getAnnotations in interface WorkerPoolOrBuilder

    • getAnnotationsMap

      public Map<String,String> getAnnotationsMap()
       User specified annotations. See https://google.aip.dev/128#annotations
 for more details such as format and size limitations.
      map<string, string> annotations = 4;
      Specified by:
      getAnnotationsMap in interface WorkerPoolOrBuilder

    • getAnnotationsOrDefault

      public String getAnnotationsOrDefault(String key, String defaultValue)
       User specified annotations. See https://google.aip.dev/128#annotations
 for more details such as format and size limitations.
      map<string, string> annotations = 4;
      Specified by:
      getAnnotationsOrDefault in interface WorkerPoolOrBuilder

    • getAnnotationsOrThrow

      public String getAnnotationsOrThrow(String key)
       User specified annotations. See https://google.aip.dev/128#annotations
 for more details such as format and size limitations.
      map<string, string> annotations = 4;
      Specified by:
      getAnnotationsOrThrow in interface WorkerPoolOrBuilder

    • 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];
      Specified by:
      hasCreateTime in interface WorkerPoolOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.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];
      Specified by:
      getCreateTime in interface WorkerPoolOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.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];
      Specified by:
      getCreateTimeOrBuilder in interface WorkerPoolOrBuilder

    • 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];
      Specified by:
      hasUpdateTime in interface WorkerPoolOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.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];
      Specified by:
      getUpdateTime in interface WorkerPoolOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.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];
      Specified by:
      getUpdateTimeOrBuilder in interface WorkerPoolOrBuilder

    • 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];
      Specified by:
      hasDeleteTime in interface WorkerPoolOrBuilder
      Returns:
      Whether the deleteTime field is set.

    • getDeleteTime

      public com.google.protobuf.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];
      Specified by:
      getDeleteTime in interface WorkerPoolOrBuilder
      Returns:
      The deleteTime.

    • getDeleteTimeOrBuilder

      public com.google.protobuf.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];
      Specified by:
      getDeleteTimeOrBuilder in interface WorkerPoolOrBuilder

    • getStateValue

      public int getStateValue()
       Output only. `WorkerPool` state.
      .google.devtools.cloudbuild.v1.WorkerPool.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStateValue in interface WorkerPoolOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public WorkerPool.State getState()
       Output only. `WorkerPool` state.
      .google.devtools.cloudbuild.v1.WorkerPool.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getState in interface WorkerPoolOrBuilder
      Returns:
      The state.

    • hasPrivatePoolV1Config

      public boolean hasPrivatePoolV1Config()
       Private Pool configuration.
      .google.devtools.cloudbuild.v1.PrivatePoolV1Config private_pool_v1_config = 12;
      Specified by:
      hasPrivatePoolV1Config in interface WorkerPoolOrBuilder
      Returns:
      Whether the privatePoolV1Config field is set.

    • getPrivatePoolV1Config

      public PrivatePoolV1Config getPrivatePoolV1Config()
       Private Pool configuration.
      .google.devtools.cloudbuild.v1.PrivatePoolV1Config private_pool_v1_config = 12;
      Specified by:
      getPrivatePoolV1Config in interface WorkerPoolOrBuilder
      Returns:
      The privatePoolV1Config.

    • getPrivatePoolV1ConfigOrBuilder

      public PrivatePoolV1ConfigOrBuilder getPrivatePoolV1ConfigOrBuilder()
       Private Pool configuration.
      .google.devtools.cloudbuild.v1.PrivatePoolV1Config private_pool_v1_config = 12;
      Specified by:
      getPrivatePoolV1ConfigOrBuilder in interface WorkerPoolOrBuilder

    • getEtag

      public String 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];
      Specified by:
      getEtag in interface WorkerPoolOrBuilder
      Returns:
      The etag.

    • getEtagBytes

      public com.google.protobuf.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];
      Specified by:
      getEtagBytes in interface WorkerPoolOrBuilder
      Returns:
      The bytes for etag.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static WorkerPool parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WorkerPool parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WorkerPool parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WorkerPool parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WorkerPool parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WorkerPool parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static WorkerPool parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static WorkerPool parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static WorkerPool parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static WorkerPool parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static WorkerPool parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static WorkerPool parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public WorkerPool.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static WorkerPool.Builder newBuilder()

    • newBuilder

      public static WorkerPool.Builder newBuilder(WorkerPool prototype)

    • toBuilder

      public WorkerPool.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected WorkerPool.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static WorkerPool getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<WorkerPool> parser()

    • getParserForType

      public com.google.protobuf.Parser<WorkerPool> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public WorkerPool getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder