Class WorkerPool (3.7.1)

Version 3.7.1

• 3.28.0 (latest)
• 3.27.1
• 3.26.0
• 3.25.0
• 3.24.2
• 3.23.3
• 3.22.0
• 3.21.0
• 3.20.1
• 3.19.0
• 3.18.0
• 3.17.1
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.1
• 3.10.0
• 3.9.3
• 3.8.3
• 3.7.1
• 3.6.0
• 3.5.2
• 3.4.0
• 3.3.2
• 3.2.1
• 3.1.1
• 3.0.2
• 2.0.2
• 1.1.2
• 1.0.0
• 0.1.0

WorkerPool(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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>__.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name	Description
name	str 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.
display_name	str A user-specified, human-readable name for the WorkerPool. If provided, this value must be 1-63 characters.
uid	str Output only. A unique identifier for the WorkerPool.
annotations	Sequence[google.cloud.devtools.cloudbuild_v1.types.WorkerPool.AnnotationsEntry] User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
create_time	google.protobuf.timestamp_pb2.Timestamp Output only. Time at which the request to create the WorkerPool was received.
update_time	google.protobuf.timestamp_pb2.Timestamp Output only. Time at which the request to update the WorkerPool was received.
delete_time	google.protobuf.timestamp_pb2.Timestamp Output only. Time at which the request to delete the WorkerPool was received.
state	google.cloud.devtools.cloudbuild_v1.types.WorkerPool.State Output only. WorkerPool state.
private_pool_v1_config	google.cloud.devtools.cloudbuild_v1.types.PrivatePoolV1Config Private Pool using a v1 configuration. This field is a member of oneof_ config.
etag	str 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.

Classes

AnnotationsEntry

AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters

Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

State

State(value)

State of the WorkerPool.