Class WorkerPool

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.

Inheritance

builtins.object > proto.message.Message > WorkerPool

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.