Google Cloud Native v0.28.0, Feb 2 23

google-native.cloudbuild/v1alpha2.getWorkerPool

Returns details of 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/v1alpha2: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: 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.
NetworkConfig Pulumi.GoogleNative.CloudBuild.V1Alpha2.Outputs.NetworkConfigResponse: Network configuration for the WorkerPool.
Region string: Immutable. The region where the WorkerPool runs. Only "us-central1" is currently supported. Note that region cannot be changed once the WorkerPool is created.
State string: WorkerPool state.
UpdateTime string: Time at which the request to update the WorkerPool was received.
WorkerConfig Pulumi.GoogleNative.CloudBuild.V1Alpha2.Outputs.WorkerConfigResponse: Worker configuration for the WorkerPool.

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: 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.
NetworkConfig NetworkConfigResponse: Network configuration for the WorkerPool.
Region string: Immutable. The region where the WorkerPool runs. Only "us-central1" is currently supported. Note that region cannot be changed once the WorkerPool is created.
State string: WorkerPool state.
UpdateTime string: Time at which the request to update the WorkerPool was received.
WorkerConfig WorkerConfigResponse: Worker configuration for the WorkerPool.

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: 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.
networkConfig NetworkConfigResponse: Network configuration for the WorkerPool.
region String: Immutable. The region where the WorkerPool runs. Only "us-central1" is currently supported. Note that region cannot be changed once the WorkerPool is created.
state String: WorkerPool state.
updateTime String: Time at which the request to update the WorkerPool was received.
workerConfig WorkerConfigResponse: Worker configuration for the WorkerPool.

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: 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.
networkConfig NetworkConfigResponse: Network configuration for the WorkerPool.
region string: Immutable. The region where the WorkerPool runs. Only "us-central1" is currently supported. Note that region cannot be changed once the WorkerPool is created.
state string: WorkerPool state.
updateTime string: Time at which the request to update the WorkerPool was received.
workerConfig WorkerConfigResponse: Worker configuration for the WorkerPool.

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: 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.
network_config NetworkConfigResponse: Network configuration for the WorkerPool.
region str: Immutable. The region where the WorkerPool runs. Only "us-central1" is currently supported. Note that region cannot be changed once the WorkerPool is created.
state str: WorkerPool state.
update_time str: Time at which the request to update the WorkerPool was received.
worker_config WorkerConfigResponse: Worker configuration for the WorkerPool.

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: 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.
networkConfig Property Map: Network configuration for the WorkerPool.
region String: Immutable. The region where the WorkerPool runs. Only "us-central1" is currently supported. Note that region cannot be changed once the WorkerPool is created.
state String: WorkerPool state.
updateTime String: Time at which the request to update the WorkerPool was received.
workerConfig Property Map: Worker configuration for the WorkerPool.

Supporting Types

NetworkConfigResponse

PeeredNetwork string: 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.

PeeredNetwork string: 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.

peeredNetwork String: 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.

peeredNetwork string: 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.

peered_network str: 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.

peeredNetwork String: 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.

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

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

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

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

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

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

Package Details

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