Reference documentation and code samples for the Google Cloud Build V1 Client class WorkerConfig.
WorkerConfig defines the configuration to be used for a creating workers in the pool.
Generated from protobuf message google.devtools.cloudbuild.v1.WorkerConfig
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ machine_type
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. machine_type
is overridden if you specify a different machine type in build_options
. In this case, the VM specified in the build_options
will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes
↳ disk_size_gb
int|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. disk_size
is overridden if you specify a different disk size in build_options
. In this case, a VM with a disk size specified in the build_options
will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions
↳ network
Google\Cloud\Build\V1\Network
The network definition used to create the worker. If this section is left empty, the workers will be created in WorkerPool.project_id on the default network.
↳ tag
string
The tag applied to the worker, and the same tag used by the firewall rule. It is used to identify the Cloud Build workers among other VMs. The default value for tag is worker
.
getMachineType
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. machine_type
is overridden if you specify a different machine type in build_options
. In this case, the VM specified in the build_options
will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes
string
setMachineType
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. machine_type
is overridden if you specify a different machine type in build_options
. In this case, the VM specified in the build_options
will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes
var
string
$this
getDiskSizeGb
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. disk_size
is overridden if you specify a different disk size in build_options
. In this case, a VM with a disk size specified in the build_options
will be created on demand at build time. For more
information see https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions
int|string
setDiskSizeGb
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. disk_size
is overridden if you specify a different disk size in build_options
. In this case, a VM with a disk size specified in the build_options
will be created on demand at build time. For more
information see https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions
var
int|string
$this
getNetwork
The network definition used to create the worker.
If this section is left empty, the workers will be created in WorkerPool.project_id on the default network.
hasNetwork
clearNetwork
setNetwork
The network definition used to create the worker.
If this section is left empty, the workers will be created in WorkerPool.project_id on the default network.
$this
getTag
The tag applied to the worker, and the same tag used by the firewall rule.
It is used to identify the Cloud Build workers among other VMs.
The default value for tag is worker
.
string
setTag
The tag applied to the worker, and the same tag used by the firewall rule.
It is used to identify the Cloud Build workers among other VMs.
The default value for tag is worker
.
var
string
$this
