Cloud Build V1 API - Class Google::Cloud::Build::V1::WorkerPool (v0.23.0)

Reference documentation and code samples for the Cloud Build V1 API class Google::Cloud::Build::V1::WorkerPool.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#annotations

def annotations() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

#annotations=

def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#delete_time

def delete_time() -> ::Google::Protobuf::Timestamp
Returns

#display_name

def display_name() -> ::String
Returns
  • (::String) — A user-specified, human-readable name for the WorkerPool. If provided, this value must be 1-63 characters.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — A user-specified, human-readable name for the WorkerPool. If provided, this value must be 1-63 characters.
Returns
  • (::String) — A user-specified, human-readable name for the WorkerPool. If provided, this value must be 1-63 characters.

#etag

def etag() -> ::String
Returns
  • (::String) — 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.

#name

def name() -> ::String
Returns
  • (::String) — 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.

#private_pool_v1_config

def private_pool_v1_config() -> ::Google::Cloud::Build::V1::PrivatePoolV1Config
Returns

#private_pool_v1_config=

def private_pool_v1_config=(value) -> ::Google::Cloud::Build::V1::PrivatePoolV1Config
Parameter
Returns

#state

def state() -> ::Google::Cloud::Build::V1::WorkerPool::State
Returns

#uid

def uid() -> ::String
Returns
  • (::String) — Output only. A unique identifier for the WorkerPool.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns