Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. cloudbuild
  5. cloudbuild/v1beta1
  6. getWorkerPool

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.cloudbuild/v1beta1.getWorkerPool

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

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>
Copy
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]
Copy
func LookupWorkerPool(ctx *Context, args *LookupWorkerPoolArgs, opts ...InvokeOption) (*LookupWorkerPoolResult, error)
func LookupWorkerPoolOutput(ctx *Context, args *LookupWorkerPoolOutputArgs, opts ...InvokeOption) LookupWorkerPoolResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetWorkerPoolResult> getWorkerPool(GetWorkerPoolArgs args, InvokeOptions options)
public static Output<GetWorkerPoolResult> getWorkerPool(GetWorkerPoolArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:cloudbuild/v1beta1:getWorkerPool
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Location This property is required. string
WorkerPoolId This property is required. string
Project string
Location This property is required. string
WorkerPoolId This property is required. string
Project string
location This property is required. String
workerPoolId This property is required. String
project String
location This property is required. string
workerPoolId This property is required. string
project string
location This property is required. str
worker_pool_id This property is required. str
project str
location This property is required. String
workerPoolId This property is required. 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.
NetworkConfig Pulumi.GoogleNative.CloudBuild.V1Beta1.Outputs.NetworkConfigResponse
Network configuration for the WorkerPool.
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.
WorkerConfig Pulumi.GoogleNative.CloudBuild.V1Beta1.Outputs.WorkerConfigResponse
Worker configuration for the WorkerPool.
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.
NetworkConfig NetworkConfigResponse
Network configuration for the WorkerPool.
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.
WorkerConfig WorkerConfigResponse
Worker configuration for the WorkerPool.
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.
networkConfig NetworkConfigResponse
Network configuration for the WorkerPool.
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.
workerConfig WorkerConfigResponse
Worker configuration for the WorkerPool.
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.
networkConfig NetworkConfigResponse
Network configuration for the WorkerPool.
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.
workerConfig WorkerConfigResponse
Worker configuration for the WorkerPool.
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.
network_config NetworkConfigResponse
Network configuration for the WorkerPool.
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.
worker_config WorkerConfigResponse
Worker configuration for the WorkerPool.
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.
networkConfig Property Map
Network configuration for the WorkerPool.
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.
workerConfig Property Map
Worker configuration for the WorkerPool.

Supporting Types

NetworkConfigResponse

PeeredNetwork This property is required. 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
PeeredNetwork This property is required. 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
peeredNetwork This property is required. 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
peeredNetwork This property is required. 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
peered_network This property is required. 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
peeredNetwork This property is required. 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

WorkerConfigResponse

DiskSizeGb This property is required. string
Size of the disk attached to the worker, in GB. See Worker pool config file. Specify a value of up to 1000. If 0 is specified, Cloud Build will use a standard disk size.
MachineType This property is required. string
Machine type of a worker, such as n1-standard-1. See Worker pool config file. If left blank, Cloud Build will use n1-standard-1.
NoExternalIp This property is required. bool
If true, workers are created without any public address, which prevents network egress to public IPs.
DiskSizeGb This property is required. string
Size of the disk attached to the worker, in GB. See Worker pool config file. Specify a value of up to 1000. If 0 is specified, Cloud Build will use a standard disk size.
MachineType This property is required. string
Machine type of a worker, such as n1-standard-1. See Worker pool config file. If left blank, Cloud Build will use n1-standard-1.
NoExternalIp This property is required. bool
If true, workers are created without any public address, which prevents network egress to public IPs.
diskSizeGb This property is required. String
Size of the disk attached to the worker, in GB. See Worker pool config file. Specify a value of up to 1000. If 0 is specified, Cloud Build will use a standard disk size.
machineType This property is required. String
Machine type of a worker, such as n1-standard-1. See Worker pool config file. If left blank, Cloud Build will use n1-standard-1.
noExternalIp This property is required. Boolean
If true, workers are created without any public address, which prevents network egress to public IPs.
diskSizeGb This property is required. string
Size of the disk attached to the worker, in GB. See Worker pool config file. Specify a value of up to 1000. If 0 is specified, Cloud Build will use a standard disk size.
machineType This property is required. string
Machine type of a worker, such as n1-standard-1. See Worker pool config file. If left blank, Cloud Build will use n1-standard-1.
noExternalIp This property is required. boolean
If true, workers are created without any public address, which prevents network egress to public IPs.
disk_size_gb This property is required. str
Size of the disk attached to the worker, in GB. See Worker pool config file. Specify a value of up to 1000. If 0 is specified, Cloud Build will use a standard disk size.
machine_type This property is required. str
Machine type of a worker, such as n1-standard-1. See Worker pool config file. If left blank, Cloud Build will use n1-standard-1.
no_external_ip This property is required. bool
If true, workers are created without any public address, which prevents network egress to public IPs.
diskSizeGb This property is required. String
Size of the disk attached to the worker, in GB. See Worker pool config file. Specify a value of up to 1000. If 0 is specified, Cloud Build will use a standard disk size.
machineType This property is required. String
Machine type of a worker, such as n1-standard-1. See Worker pool config file. If left blank, Cloud Build will use n1-standard-1.
noExternalIp This property is required. Boolean
If true, workers are created without any public address, which prevents network egress to public IPs.

Package Details

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

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native