create(parent, body=None, workerPoolId=None, x__xgafv=None)
Creates a `WorkerPool` to run the builds, and returns the new worker pool.
Deletes a `WorkerPool`.
Returns details of a `WorkerPool`.
Lists `WorkerPool`s by project.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a `WorkerPool`.
create(parent, body=None, workerPoolId=None, x__xgafv=None)
Creates a `WorkerPool` to run the builds, and returns the new worker pool.
Args:
parent: string, Required. The parent resource where this book will be created.
Format: projects/{project} (required)
body: object, The request body.
The object takes the form of:
{ # Configuration for a WorkerPool to run the builds.
#
# Workers are machines that Cloud Build uses to run your builds. By default,
# all workers run in a project owned by Cloud Build. To have full control over
# the workers that execute your builds -- such as enabling them to access
# private resources on your private network -- you can request Cloud Build to
# run the workers in your own project by creating a custom workers pool.
"workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in # Worker configuration for the `WorkerPool`.
# the pool.
"diskSizeGb": "A String", # Size of the disk attached to the worker, in GB.
# See https://cloud.google.com/compute/docs/disks/
# If `0` is specified, Cloud Build will use a standard disk size.
"machineType": "A String", # Machine Type of the worker, such as n1-standard-1.
# See https://cloud.google.com/compute/docs/machine-types.
# If left blank, Cloud Build will use a standard unspecified machine to
# create the worker pool.
},
"deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was
# received.
"region": "A String", # Required. Immutable. The region where the `WorkerPool` runs. Only "us-central1" is currently
# supported.
#
# Note that `region` cannot be changed once the `WorkerPool` is created.
"createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was
# received.
"networkConfig": { # Network describes the network configuration for a `WorkerPool`. # Network configuration for the `WorkerPool`.
"peeredNetwork": "A String", # Required. Immutable. The network definition that the workers are peered to.
# If this section is left empty, the workers will be peered to
# WorkerPool.project_id on the default network. Must be in the format
# `projects/{project}/global/networks/{network}`, where {project}
# is a project number, such as `12345`, and {network} is the name of a
# VPC network in the project.
},
"updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was
# received.
"state": "A String", # Output only. WorkerPool state.
"name": "A String", # Output only. The resource name of the `WorkerPool`.
# Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`,
# where the value of {worker_pool_id} is provided in the CreateWorkerPool
# request.
}
workerPoolId: string, Required. Immutable. The ID to use for the `WorkerPool`, which will become the final component
of the resource name.
This value should be 1-63 characters, and valid characters
are /a-z-/.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Configuration for a WorkerPool to run the builds.
#
# Workers are machines that Cloud Build uses to run your builds. By default,
# all workers run in a project owned by Cloud Build. To have full control over
# the workers that execute your builds -- such as enabling them to access
# private resources on your private network -- you can request Cloud Build to
# run the workers in your own project by creating a custom workers pool.
"workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in # Worker configuration for the `WorkerPool`.
# the pool.
"diskSizeGb": "A String", # Size of the disk attached to the worker, in GB.
# See https://cloud.google.com/compute/docs/disks/
# If `0` is specified, Cloud Build will use a standard disk size.
"machineType": "A String", # Machine Type of the worker, such as n1-standard-1.
# See https://cloud.google.com/compute/docs/machine-types.
# If left blank, Cloud Build will use a standard unspecified machine to
# create the worker pool.
},
"deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was
# received.
"region": "A String", # Required. Immutable. The region where the `WorkerPool` runs. Only "us-central1" is currently
# supported.
#
# Note that `region` cannot be changed once the `WorkerPool` is created.
"createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was
# received.
"networkConfig": { # Network describes the network configuration for a `WorkerPool`. # Network configuration for the `WorkerPool`.
"peeredNetwork": "A String", # Required. Immutable. The network definition that the workers are peered to.
# If this section is left empty, the workers will be peered to
# WorkerPool.project_id on the default network. Must be in the format
# `projects/{project}/global/networks/{network}`, where {project}
# is a project number, such as `12345`, and {network} is the name of a
# VPC network in the project.
},
"updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was
# received.
"state": "A String", # Output only. WorkerPool state.
"name": "A String", # Output only. The resource name of the `WorkerPool`.
# Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`,
# where the value of {worker_pool_id} is provided in the CreateWorkerPool
# request.
}
delete(name, x__xgafv=None)
Deletes a `WorkerPool`.
Args:
name: string, Required. The name of the `WorkerPool` to delete.
Format: projects/{project}/workerPools/{workerPool} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
#
# service Foo {
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}
get(name, x__xgafv=None)
Returns details of a `WorkerPool`.
Args:
name: string, Required. The name of the `WorkerPool` to retrieve.
Format: projects/{project}/workerPools/{workerPool} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Configuration for a WorkerPool to run the builds.
#
# Workers are machines that Cloud Build uses to run your builds. By default,
# all workers run in a project owned by Cloud Build. To have full control over
# the workers that execute your builds -- such as enabling them to access
# private resources on your private network -- you can request Cloud Build to
# run the workers in your own project by creating a custom workers pool.
"workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in # Worker configuration for the `WorkerPool`.
# the pool.
"diskSizeGb": "A String", # Size of the disk attached to the worker, in GB.
# See https://cloud.google.com/compute/docs/disks/
# If `0` is specified, Cloud Build will use a standard disk size.
"machineType": "A String", # Machine Type of the worker, such as n1-standard-1.
# See https://cloud.google.com/compute/docs/machine-types.
# If left blank, Cloud Build will use a standard unspecified machine to
# create the worker pool.
},
"deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was
# received.
"region": "A String", # Required. Immutable. The region where the `WorkerPool` runs. Only "us-central1" is currently
# supported.
#
# Note that `region` cannot be changed once the `WorkerPool` is created.
"createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was
# received.
"networkConfig": { # Network describes the network configuration for a `WorkerPool`. # Network configuration for the `WorkerPool`.
"peeredNetwork": "A String", # Required. Immutable. The network definition that the workers are peered to.
# If this section is left empty, the workers will be peered to
# WorkerPool.project_id on the default network. Must be in the format
# `projects/{project}/global/networks/{network}`, where {project}
# is a project number, such as `12345`, and {network} is the name of a
# VPC network in the project.
},
"updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was
# received.
"state": "A String", # Output only. WorkerPool state.
"name": "A String", # Output only. The resource name of the `WorkerPool`.
# Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`,
# where the value of {worker_pool_id} is provided in the CreateWorkerPool
# request.
}
list(parent, x__xgafv=None)
Lists `WorkerPool`s by project.
Args:
parent: string, Required. The parent, which owns this collection of `WorkerPools`.
Format: projects/{project} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response containing existing `WorkerPools`.
"workerPools": [ # `WorkerPools` for the specified project.
{ # Configuration for a WorkerPool to run the builds.
#
# Workers are machines that Cloud Build uses to run your builds. By default,
# all workers run in a project owned by Cloud Build. To have full control over
# the workers that execute your builds -- such as enabling them to access
# private resources on your private network -- you can request Cloud Build to
# run the workers in your own project by creating a custom workers pool.
"workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in # Worker configuration for the `WorkerPool`.
# the pool.
"diskSizeGb": "A String", # Size of the disk attached to the worker, in GB.
# See https://cloud.google.com/compute/docs/disks/
# If `0` is specified, Cloud Build will use a standard disk size.
"machineType": "A String", # Machine Type of the worker, such as n1-standard-1.
# See https://cloud.google.com/compute/docs/machine-types.
# If left blank, Cloud Build will use a standard unspecified machine to
# create the worker pool.
},
"deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was
# received.
"region": "A String", # Required. Immutable. The region where the `WorkerPool` runs. Only "us-central1" is currently
# supported.
#
# Note that `region` cannot be changed once the `WorkerPool` is created.
"createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was
# received.
"networkConfig": { # Network describes the network configuration for a `WorkerPool`. # Network configuration for the `WorkerPool`.
"peeredNetwork": "A String", # Required. Immutable. The network definition that the workers are peered to.
# If this section is left empty, the workers will be peered to
# WorkerPool.project_id on the default network. Must be in the format
# `projects/{project}/global/networks/{network}`, where {project}
# is a project number, such as `12345`, and {network} is the name of a
# VPC network in the project.
},
"updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was
# received.
"state": "A String", # Output only. WorkerPool state.
"name": "A String", # Output only. The resource name of the `WorkerPool`.
# Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`,
# where the value of {worker_pool_id} is provided in the CreateWorkerPool
# request.
},
],
}
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a `WorkerPool`.
Args:
name: string, Output only. The resource name of the `WorkerPool`.
Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`,
where the value of {worker_pool_id} is provided in the CreateWorkerPool
request. (required)
body: object, The request body.
The object takes the form of:
{ # Configuration for a WorkerPool to run the builds.
#
# Workers are machines that Cloud Build uses to run your builds. By default,
# all workers run in a project owned by Cloud Build. To have full control over
# the workers that execute your builds -- such as enabling them to access
# private resources on your private network -- you can request Cloud Build to
# run the workers in your own project by creating a custom workers pool.
"workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in # Worker configuration for the `WorkerPool`.
# the pool.
"diskSizeGb": "A String", # Size of the disk attached to the worker, in GB.
# See https://cloud.google.com/compute/docs/disks/
# If `0` is specified, Cloud Build will use a standard disk size.
"machineType": "A String", # Machine Type of the worker, such as n1-standard-1.
# See https://cloud.google.com/compute/docs/machine-types.
# If left blank, Cloud Build will use a standard unspecified machine to
# create the worker pool.
},
"deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was
# received.
"region": "A String", # Required. Immutable. The region where the `WorkerPool` runs. Only "us-central1" is currently
# supported.
#
# Note that `region` cannot be changed once the `WorkerPool` is created.
"createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was
# received.
"networkConfig": { # Network describes the network configuration for a `WorkerPool`. # Network configuration for the `WorkerPool`.
"peeredNetwork": "A String", # Required. Immutable. The network definition that the workers are peered to.
# If this section is left empty, the workers will be peered to
# WorkerPool.project_id on the default network. Must be in the format
# `projects/{project}/global/networks/{network}`, where {project}
# is a project number, such as `12345`, and {network} is the name of a
# VPC network in the project.
},
"updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was
# received.
"state": "A String", # Output only. WorkerPool state.
"name": "A String", # Output only. The resource name of the `WorkerPool`.
# Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`,
# where the value of {worker_pool_id} is provided in the CreateWorkerPool
# request.
}
updateMask: string, A mask specifying which fields in `WorkerPool` should be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Configuration for a WorkerPool to run the builds.
#
# Workers are machines that Cloud Build uses to run your builds. By default,
# all workers run in a project owned by Cloud Build. To have full control over
# the workers that execute your builds -- such as enabling them to access
# private resources on your private network -- you can request Cloud Build to
# run the workers in your own project by creating a custom workers pool.
"workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in # Worker configuration for the `WorkerPool`.
# the pool.
"diskSizeGb": "A String", # Size of the disk attached to the worker, in GB.
# See https://cloud.google.com/compute/docs/disks/
# If `0` is specified, Cloud Build will use a standard disk size.
"machineType": "A String", # Machine Type of the worker, such as n1-standard-1.
# See https://cloud.google.com/compute/docs/machine-types.
# If left blank, Cloud Build will use a standard unspecified machine to
# create the worker pool.
},
"deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was
# received.
"region": "A String", # Required. Immutable. The region where the `WorkerPool` runs. Only "us-central1" is currently
# supported.
#
# Note that `region` cannot be changed once the `WorkerPool` is created.
"createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was
# received.
"networkConfig": { # Network describes the network configuration for a `WorkerPool`. # Network configuration for the `WorkerPool`.
"peeredNetwork": "A String", # Required. Immutable. The network definition that the workers are peered to.
# If this section is left empty, the workers will be peered to
# WorkerPool.project_id on the default network. Must be in the format
# `projects/{project}/global/networks/{network}`, where {project}
# is a project number, such as `12345`, and {network} is the name of a
# VPC network in the project.
},
"updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was
# received.
"state": "A String", # Output only. WorkerPool state.
"name": "A String", # Output only. The resource name of the `WorkerPool`.
# Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`,
# where the value of {worker_pool_id} is provided in the CreateWorkerPool
# request.
}