Google Cloud Native v0.30.0, Apr 14 23

google-native.cloudbuild/v1.getWorkerPool

Explore with Pulumi AI

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(location: Optional[str] = None,
                    project: Optional[str] = None,
                    worker_pool_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetWorkerPoolResult
def get_worker_pool_output(location: Optional[pulumi.Input[str]] = None,
                    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/v1:getWorkerPool
  arguments:
    # arguments dictionary

The following arguments are supported:

Location string
WorkerPoolId string
Project string

Location string
WorkerPoolId string
Project string

location String
workerPoolId String
project String

location string
workerPoolId string
project string

location str
worker_pool_id str
project str

location String
workerPoolId String
project String

getWorkerPool Result

The following output properties are available:

Annotations Dictionary<string, string>: User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
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.
DisplayName string: A user-specified, human-readable name for the WorkerPool. If provided, this value must be 1-63 characters.
Etag string: 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.
Name string: 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.
PrivatePoolV1Config Pulumi.GoogleNative.CloudBuild.V1.Outputs.PrivatePoolV1ConfigResponse: Legacy Private Pool configuration.
State string: WorkerPool state.
Uid string: A unique identifier for the WorkerPool.
UpdateTime string: Time at which the request to update the WorkerPool was received.

Annotations map[string]string: User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
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.
DisplayName string: A user-specified, human-readable name for the WorkerPool. If provided, this value must be 1-63 characters.
Etag string: 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.
Name string: 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.
PrivatePoolV1Config PrivatePoolV1ConfigResponse: Legacy Private Pool configuration.
State string: WorkerPool state.
Uid string: A unique identifier for the WorkerPool.
UpdateTime string: Time at which the request to update the WorkerPool was received.

annotations Map<String,String>: User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
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.
displayName String: A user-specified, human-readable name for the WorkerPool. If provided, this value must be 1-63 characters.
etag String: 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.
name String: 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.
privatePoolV1Config PrivatePoolV1ConfigResponse: Legacy Private Pool configuration.
state String: WorkerPool state.
uid String: A unique identifier for the WorkerPool.
updateTime String: Time at which the request to update the WorkerPool was received.

annotations {[key: string]: string}: User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
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.
displayName string: A user-specified, human-readable name for the WorkerPool. If provided, this value must be 1-63 characters.
etag string: 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.
name string: 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.
privatePoolV1Config PrivatePoolV1ConfigResponse: Legacy Private Pool configuration.
state string: WorkerPool state.
uid string: A unique identifier for the WorkerPool.
updateTime string: Time at which the request to update the WorkerPool was received.

annotations Mapping[str, str]: User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
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.
display_name str: A user-specified, human-readable name for the WorkerPool. If provided, this value must be 1-63 characters.
etag str: 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.
name str: 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.
private_pool_v1_config PrivatePoolV1ConfigResponse: Legacy Private Pool configuration.
state str: WorkerPool state.
uid str: A unique identifier for the WorkerPool.
update_time str: Time at which the request to update the WorkerPool was received.

annotations Map<String>: User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
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.
displayName String: A user-specified, human-readable name for the WorkerPool. If provided, this value must be 1-63 characters.
etag String: 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.
name String: 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.
privatePoolV1Config Property Map: Legacy Private Pool configuration.
state String: WorkerPool state.
uid String: A unique identifier for the WorkerPool.
updateTime String: Time at which the request to update the WorkerPool was received.

Supporting Types

NetworkConfigResponse

EgressOption string: Option to configure network egress for the workers.
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 service producer 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. See Understanding network configuration options
PeeredNetworkIpRange string: Immutable. Subnet IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. 192.168.0.0/29 would specify an IP range starting at 192.168.0.0 with a prefix size of 29 bits. /16 would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of /24 will be used.

EgressOption string: Option to configure network egress for the workers.
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 service producer 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. See Understanding network configuration options
PeeredNetworkIpRange string: Immutable. Subnet IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. 192.168.0.0/29 would specify an IP range starting at 192.168.0.0 with a prefix size of 29 bits. /16 would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of /24 will be used.

egressOption String: Option to configure network egress for the workers.
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 service producer 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. See Understanding network configuration options
peeredNetworkIpRange String: Immutable. Subnet IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. 192.168.0.0/29 would specify an IP range starting at 192.168.0.0 with a prefix size of 29 bits. /16 would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of /24 will be used.

egressOption string: Option to configure network egress for the workers.
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 service producer 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. See Understanding network configuration options
peeredNetworkIpRange string: Immutable. Subnet IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. 192.168.0.0/29 would specify an IP range starting at 192.168.0.0 with a prefix size of 29 bits. /16 would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of /24 will be used.

egress_option str: Option to configure network egress for the workers.
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 service producer 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. See Understanding network configuration options
peered_network_ip_range str: Immutable. Subnet IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. 192.168.0.0/29 would specify an IP range starting at 192.168.0.0 with a prefix size of 29 bits. /16 would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of /24 will be used.

egressOption String: Option to configure network egress for the workers.
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 service producer 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. See Understanding network configuration options
peeredNetworkIpRange String: Immutable. Subnet IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. 192.168.0.0/29 would specify an IP range starting at 192.168.0.0 with a prefix size of 29 bits. /16 would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of /24 will be used.

PrivatePoolV1ConfigResponse

NetworkConfig Pulumi.GoogleNative.CloudBuild.V1.Inputs.NetworkConfigResponse: Network configuration for the pool.
WorkerConfig Pulumi.GoogleNative.CloudBuild.V1.Inputs.WorkerConfigResponse: Machine configuration for the workers in the pool.

NetworkConfig NetworkConfigResponse: Network configuration for the pool.
WorkerConfig WorkerConfigResponse: Machine configuration for the workers in the pool.

networkConfig NetworkConfigResponse: Network configuration for the pool.
workerConfig WorkerConfigResponse: Machine configuration for the workers in the pool.

networkConfig NetworkConfigResponse: Network configuration for the pool.
workerConfig WorkerConfigResponse: Machine configuration for the workers in the pool.

network_config NetworkConfigResponse: Network configuration for the pool.
worker_config WorkerConfigResponse: Machine configuration for the workers in the pool.

networkConfig Property Map: Network configuration for the pool.
workerConfig Property Map: Machine configuration for the workers in the pool.

WorkerConfigResponse

DiskSizeGb string: Size of the disk attached to the worker, in GB. See Worker pool config file. Specify a value of up to 2000. If 0 is specified, Cloud Build will use a standard disk size.
MachineType string: Machine type of a worker, such as e2-medium. See Worker pool config file. If left blank, Cloud Build will use a sensible default.

DiskSizeGb string: Size of the disk attached to the worker, in GB. See Worker pool config file. Specify a value of up to 2000. If 0 is specified, Cloud Build will use a standard disk size.
MachineType string: Machine type of a worker, such as e2-medium. See Worker pool config file. If left blank, Cloud Build will use a sensible default.

diskSizeGb String: Size of the disk attached to the worker, in GB. See Worker pool config file. Specify a value of up to 2000. If 0 is specified, Cloud Build will use a standard disk size.
machineType String: Machine type of a worker, such as e2-medium. See Worker pool config file. If left blank, Cloud Build will use a sensible default.

diskSizeGb string: Size of the disk attached to the worker, in GB. See Worker pool config file. Specify a value of up to 2000. If 0 is specified, Cloud Build will use a standard disk size.
machineType string: Machine type of a worker, such as e2-medium. See Worker pool config file. If left blank, Cloud Build will use a sensible default.

disk_size_gb str: Size of the disk attached to the worker, in GB. See Worker pool config file. Specify a value of up to 2000. If 0 is specified, Cloud Build will use a standard disk size.
machine_type str: Machine type of a worker, such as e2-medium. See Worker pool config file. If left blank, Cloud Build will use a sensible default.

diskSizeGb String: Size of the disk attached to the worker, in GB. See Worker pool config file. Specify a value of up to 2000. If 0 is specified, Cloud Build will use a standard disk size.
machineType String: Machine type of a worker, such as e2-medium. See Worker pool config file. If left blank, Cloud Build will use a sensible default.

Package Details

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