Google Cloud Native v0.28.0, Feb 2 23

google-native.cloudbuild/v1alpha1.getWorkerPool

Returns information about a WorkerPool.

Using getWorkerPool

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getWorkerPool(args: GetWorkerPoolArgs, opts?: InvokeOptions): Promise<GetWorkerPoolResult>
function getWorkerPoolOutput(args: GetWorkerPoolOutputArgs, opts?: InvokeOptions): Output<GetWorkerPoolResult>

def get_worker_pool(project: Optional[str] = None,
                    worker_pool_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetWorkerPoolResult
def get_worker_pool_output(project: Optional[pulumi.Input[str]] = None,
                    worker_pool_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetWorkerPoolResult]

func LookupWorkerPool(ctx *Context, args *LookupWorkerPoolArgs, opts ...InvokeOption) (*LookupWorkerPoolResult, error)
func LookupWorkerPoolOutput(ctx *Context, args *LookupWorkerPoolOutputArgs, opts ...InvokeOption) LookupWorkerPoolResultOutput

> Note: This function is named LookupWorkerPool in the Go SDK.

public static class GetWorkerPool 
{
    public static Task<GetWorkerPoolResult> InvokeAsync(GetWorkerPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkerPoolResult> Invoke(GetWorkerPoolInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetWorkerPoolResult> getWorkerPool(GetWorkerPoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:cloudbuild/v1alpha1:getWorkerPool
  arguments:
    # arguments dictionary

The following arguments are supported:

WorkerPoolId string
Project string

WorkerPoolId string
Project string

workerPoolId String
project String

workerPoolId string
project string

worker_pool_id str
project str

workerPoolId String
project String

getWorkerPool Result

The following output properties are available:

CreateTime string: Time at which the request to create the WorkerPool was received.
DeleteTime string: Time at which the request to delete the WorkerPool was received.
Name string: User-defined name of the WorkerPool.
Project string: The project ID of the GCP project for which the WorkerPool is created.
Regions List<string>: List of regions to create the WorkerPool. Regions can't be empty. If Cloud Build adds a new GCP region in the future, the existing WorkerPool will not be enabled in the new region automatically; you must add the new region to the regions field to enable the WorkerPool in that region.
ServiceAccountEmail string: The service account used to manage the WorkerPool. The service account must have the Compute Instance Admin (Beta) permission at the project level.
Status string: WorkerPool Status.
UpdateTime string: Time at which the request to update the WorkerPool was received.
WorkerConfig Pulumi.GoogleNative.CloudBuild.V1Alpha1.Outputs.WorkerConfigResponse: Configuration to be used for a creating workers in the WorkerPool.
WorkerCount string: Total number of workers to be created across all requested regions.

CreateTime string: Time at which the request to create the WorkerPool was received.
DeleteTime string: Time at which the request to delete the WorkerPool was received.
Name string: User-defined name of the WorkerPool.
Project string: The project ID of the GCP project for which the WorkerPool is created.
Regions []string: List of regions to create the WorkerPool. Regions can't be empty. If Cloud Build adds a new GCP region in the future, the existing WorkerPool will not be enabled in the new region automatically; you must add the new region to the regions field to enable the WorkerPool in that region.
ServiceAccountEmail string: The service account used to manage the WorkerPool. The service account must have the Compute Instance Admin (Beta) permission at the project level.
Status string: WorkerPool Status.
UpdateTime string: Time at which the request to update the WorkerPool was received.
WorkerConfig WorkerConfigResponse: Configuration to be used for a creating workers in the WorkerPool.
WorkerCount string: Total number of workers to be created across all requested regions.

createTime String: Time at which the request to create the WorkerPool was received.
deleteTime String: Time at which the request to delete the WorkerPool was received.
name String: User-defined name of the WorkerPool.
project String: The project ID of the GCP project for which the WorkerPool is created.
regions List<String>: List of regions to create the WorkerPool. Regions can't be empty. If Cloud Build adds a new GCP region in the future, the existing WorkerPool will not be enabled in the new region automatically; you must add the new region to the regions field to enable the WorkerPool in that region.
serviceAccountEmail String: The service account used to manage the WorkerPool. The service account must have the Compute Instance Admin (Beta) permission at the project level.
status String: WorkerPool Status.
updateTime String: Time at which the request to update the WorkerPool was received.
workerConfig WorkerConfigResponse: Configuration to be used for a creating workers in the WorkerPool.
workerCount String: Total number of workers to be created across all requested regions.

createTime string: Time at which the request to create the WorkerPool was received.
deleteTime string: Time at which the request to delete the WorkerPool was received.
name string: User-defined name of the WorkerPool.
project string: The project ID of the GCP project for which the WorkerPool is created.
regions string[]: List of regions to create the WorkerPool. Regions can't be empty. If Cloud Build adds a new GCP region in the future, the existing WorkerPool will not be enabled in the new region automatically; you must add the new region to the regions field to enable the WorkerPool in that region.
serviceAccountEmail string: The service account used to manage the WorkerPool. The service account must have the Compute Instance Admin (Beta) permission at the project level.
status string: WorkerPool Status.
updateTime string: Time at which the request to update the WorkerPool was received.
workerConfig WorkerConfigResponse: Configuration to be used for a creating workers in the WorkerPool.
workerCount string: Total number of workers to be created across all requested regions.

create_time str: Time at which the request to create the WorkerPool was received.
delete_time str: Time at which the request to delete the WorkerPool was received.
name str: User-defined name of the WorkerPool.
project str: The project ID of the GCP project for which the WorkerPool is created.
regions Sequence[str]: List of regions to create the WorkerPool. Regions can't be empty. If Cloud Build adds a new GCP region in the future, the existing WorkerPool will not be enabled in the new region automatically; you must add the new region to the regions field to enable the WorkerPool in that region.
service_account_email str: The service account used to manage the WorkerPool. The service account must have the Compute Instance Admin (Beta) permission at the project level.
status str: WorkerPool Status.
update_time str: Time at which the request to update the WorkerPool was received.
worker_config WorkerConfigResponse: Configuration to be used for a creating workers in the WorkerPool.
worker_count str: Total number of workers to be created across all requested regions.

createTime String: Time at which the request to create the WorkerPool was received.
deleteTime String: Time at which the request to delete the WorkerPool was received.
name String: User-defined name of the WorkerPool.
project String: The project ID of the GCP project for which the WorkerPool is created.
regions List<String>: List of regions to create the WorkerPool. Regions can't be empty. If Cloud Build adds a new GCP region in the future, the existing WorkerPool will not be enabled in the new region automatically; you must add the new region to the regions field to enable the WorkerPool in that region.
serviceAccountEmail String: The service account used to manage the WorkerPool. The service account must have the Compute Instance Admin (Beta) permission at the project level.
status String: WorkerPool Status.
updateTime String: Time at which the request to update the WorkerPool was received.
workerConfig Property Map: Configuration to be used for a creating workers in the WorkerPool.
workerCount String: Total number of workers to be created across all requested regions.

Supporting Types

NetworkResponse

Network string: Network on which the workers are created. "default" network is used if empty.
Project string: Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id.
Subnetwork string: Subnetwork on which the workers are created. "default" subnetwork is used if empty.

Network string: Network on which the workers are created. "default" network is used if empty.
Project string: Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id.
Subnetwork string: Subnetwork on which the workers are created. "default" subnetwork is used if empty.

network String: Network on which the workers are created. "default" network is used if empty.
project String: Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id.
subnetwork String: Subnetwork on which the workers are created. "default" subnetwork is used if empty.

network string: Network on which the workers are created. "default" network is used if empty.
project string: Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id.
subnetwork string: Subnetwork on which the workers are created. "default" subnetwork is used if empty.

network str: Network on which the workers are created. "default" network is used if empty.
project str: Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id.
subnetwork str: Subnetwork on which the workers are created. "default" subnetwork is used if empty.

network String: Network on which the workers are created. "default" network is used if empty.
project String: Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id.
subnetwork String: Subnetwork on which the workers are created. "default" subnetwork is used if empty.

WorkerConfigResponse

DiskSizeGb 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
MachineType 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
Network Pulumi.GoogleNative.CloudBuild.V1Alpha1.Inputs.NetworkResponse: 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.

DiskSizeGb 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
MachineType 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
Network NetworkResponse: 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.

diskSizeGb 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
machineType 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
network NetworkResponse: 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.

diskSizeGb 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
machineType 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
network NetworkResponse: 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.

disk_size_gb str: 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
machine_type str: 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
network NetworkResponse: 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 str: 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.

diskSizeGb 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
machineType 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
network Property Map: 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.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0