1. Packages
  2. Google Cloud Native
  3. API Docs
  4. remotebuildexecution
  5. remotebuildexecution/v1alpha
  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

google-native.remotebuildexecution/v1alpha.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

Returns the specified worker pool.

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(instance_id: Optional[str] = None,
                    project: Optional[str] = None,
                    workerpool_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetWorkerPoolResult
def get_worker_pool_output(instance_id: Optional[pulumi.Input[str]] = None,
                    project: Optional[pulumi.Input[str]] = None,
                    workerpool_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:remotebuildexecution/v1alpha:getWorkerPool
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

InstanceId This property is required. string
WorkerpoolId This property is required. string
Project string
InstanceId This property is required. string
WorkerpoolId This property is required. string
Project string
instanceId This property is required. String
workerpoolId This property is required. String
project String
instanceId This property is required. string
workerpoolId This property is required. string
project string
instance_id This property is required. str
workerpool_id This property is required. str
project str
instanceId This property is required. String
workerpoolId This property is required. String
project String

getWorkerPool Result

The following output properties are available:

Autoscale Pulumi.GoogleNative.RemoteBuildExecution.V1Alpha.Outputs.GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscaleResponse
The autoscale policy to apply on a pool.
Channel string
Channel specifies the release channel of the pool.
Name string
WorkerPool resource name formatted as: projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]. name should not be populated when creating a worker pool since it is provided in the poolId field.
State string
State of the worker pool.
WorkerConfig Pulumi.GoogleNative.RemoteBuildExecution.V1Alpha.Outputs.GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfigResponse
Specifies the properties, such as machine type and disk size, used for creating workers in a worker pool.
WorkerCount string
The desired number of workers in the worker pool. Must be a value between 0 and 15000.
Autoscale GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscaleResponse
The autoscale policy to apply on a pool.
Channel string
Channel specifies the release channel of the pool.
Name string
WorkerPool resource name formatted as: projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]. name should not be populated when creating a worker pool since it is provided in the poolId field.
State string
State of the worker pool.
WorkerConfig GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfigResponse
Specifies the properties, such as machine type and disk size, used for creating workers in a worker pool.
WorkerCount string
The desired number of workers in the worker pool. Must be a value between 0 and 15000.
autoscale GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscaleResponse
The autoscale policy to apply on a pool.
channel String
Channel specifies the release channel of the pool.
name String
WorkerPool resource name formatted as: projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]. name should not be populated when creating a worker pool since it is provided in the poolId field.
state String
State of the worker pool.
workerConfig GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfigResponse
Specifies the properties, such as machine type and disk size, used for creating workers in a worker pool.
workerCount String
The desired number of workers in the worker pool. Must be a value between 0 and 15000.
autoscale GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscaleResponse
The autoscale policy to apply on a pool.
channel string
Channel specifies the release channel of the pool.
name string
WorkerPool resource name formatted as: projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]. name should not be populated when creating a worker pool since it is provided in the poolId field.
state string
State of the worker pool.
workerConfig GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfigResponse
Specifies the properties, such as machine type and disk size, used for creating workers in a worker pool.
workerCount string
The desired number of workers in the worker pool. Must be a value between 0 and 15000.
autoscale GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscaleResponse
The autoscale policy to apply on a pool.
channel str
Channel specifies the release channel of the pool.
name str
WorkerPool resource name formatted as: projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]. name should not be populated when creating a worker pool since it is provided in the poolId field.
state str
State of the worker pool.
worker_config GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfigResponse
Specifies the properties, such as machine type and disk size, used for creating workers in a worker pool.
worker_count str
The desired number of workers in the worker pool. Must be a value between 0 and 15000.
autoscale Property Map
The autoscale policy to apply on a pool.
channel String
Channel specifies the release channel of the pool.
name String
WorkerPool resource name formatted as: projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]. name should not be populated when creating a worker pool since it is provided in the poolId field.
state String
State of the worker pool.
workerConfig Property Map
Specifies the properties, such as machine type and disk size, used for creating workers in a worker pool.
workerCount String
The desired number of workers in the worker pool. Must be a value between 0 and 15000.

Supporting Types

GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfigResponse

AcceleratorCount This property is required. string
The number of guest accelerator cards exposed to each VM.
AcceleratorType This property is required. string
The type of accelerator to attach to each VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80.
AcceleratorCount This property is required. string
The number of guest accelerator cards exposed to each VM.
AcceleratorType This property is required. string
The type of accelerator to attach to each VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80.
acceleratorCount This property is required. String
The number of guest accelerator cards exposed to each VM.
acceleratorType This property is required. String
The type of accelerator to attach to each VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80.
acceleratorCount This property is required. string
The number of guest accelerator cards exposed to each VM.
acceleratorType This property is required. string
The type of accelerator to attach to each VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80.
accelerator_count This property is required. str
The number of guest accelerator cards exposed to each VM.
accelerator_type This property is required. str
The type of accelerator to attach to each VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80.
acceleratorCount This property is required. String
The number of guest accelerator cards exposed to each VM.
acceleratorType This property is required. String
The type of accelerator to attach to each VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80.

GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscaleResponse

MaxSize This property is required. string
The maximal number of workers. Must be equal to or greater than min_size.
MinSize This property is required. string
The minimal number of workers. Must be greater than 0.
MaxSize This property is required. string
The maximal number of workers. Must be equal to or greater than min_size.
MinSize This property is required. string
The minimal number of workers. Must be greater than 0.
maxSize This property is required. String
The maximal number of workers. Must be equal to or greater than min_size.
minSize This property is required. String
The minimal number of workers. Must be greater than 0.
maxSize This property is required. string
The maximal number of workers. Must be equal to or greater than min_size.
minSize This property is required. string
The minimal number of workers. Must be greater than 0.
max_size This property is required. str
The maximal number of workers. Must be equal to or greater than min_size.
min_size This property is required. str
The minimal number of workers. Must be greater than 0.
maxSize This property is required. String
The maximal number of workers. Must be equal to or greater than min_size.
minSize This property is required. String
The minimal number of workers. Must be greater than 0.

GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfigResponse

Accelerator This property is required. Pulumi.GoogleNative.RemoteBuildExecution.V1Alpha.Inputs.GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfigResponse
The accelerator card attached to each VM.
DiskSizeGb This property is required. string
Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/
DiskType This property is required. string
Disk Type to use for the worker. See Storage options. Currently only pd-standard and pd-ssd are supported.
Labels This property is required. Dictionary<string, string>
Labels associated with the workers. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International letters are permitted. Label keys must start with a letter. Label values are optional. There can not be more than 64 labels per resource.
MachineType This property is required. string
Machine type of the worker, such as e2-standard-2. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that f1-micro and g1-small are not yet supported.
MaxConcurrentActions This property is required. string
The maximum number of actions a worker can execute concurrently.
MinCpuPlatform This property is required. string
Minimum CPU platform to use when creating the worker. See CPU Platforms.
NetworkAccess This property is required. string
Determines the type of network access granted to workers. Possible values: - "public": Workers can connect to the public internet. - "private": Workers can only connect to Google APIs and services. - "restricted-private": Workers can only connect to Google APIs that are reachable through restricted.googleapis.com (199.36.153.4/30).
Reserved This property is required. bool
Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See Preemptible VMs for more details.
SoleTenantNodeType This property is required. string
The node type name to be used for sole-tenant nodes.
VmImage This property is required. string
The name of the image used by each VM.
Accelerator This property is required. GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfigResponse
The accelerator card attached to each VM.
DiskSizeGb This property is required. string
Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/
DiskType This property is required. string
Disk Type to use for the worker. See Storage options. Currently only pd-standard and pd-ssd are supported.
Labels This property is required. map[string]string
Labels associated with the workers. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International letters are permitted. Label keys must start with a letter. Label values are optional. There can not be more than 64 labels per resource.
MachineType This property is required. string
Machine type of the worker, such as e2-standard-2. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that f1-micro and g1-small are not yet supported.
MaxConcurrentActions This property is required. string
The maximum number of actions a worker can execute concurrently.
MinCpuPlatform This property is required. string
Minimum CPU platform to use when creating the worker. See CPU Platforms.
NetworkAccess This property is required. string
Determines the type of network access granted to workers. Possible values: - "public": Workers can connect to the public internet. - "private": Workers can only connect to Google APIs and services. - "restricted-private": Workers can only connect to Google APIs that are reachable through restricted.googleapis.com (199.36.153.4/30).
Reserved This property is required. bool
Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See Preemptible VMs for more details.
SoleTenantNodeType This property is required. string
The node type name to be used for sole-tenant nodes.
VmImage This property is required. string
The name of the image used by each VM.
accelerator This property is required. GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfigResponse
The accelerator card attached to each VM.
diskSizeGb This property is required. String
Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/
diskType This property is required. String
Disk Type to use for the worker. See Storage options. Currently only pd-standard and pd-ssd are supported.
labels This property is required. Map<String,String>
Labels associated with the workers. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International letters are permitted. Label keys must start with a letter. Label values are optional. There can not be more than 64 labels per resource.
machineType This property is required. String
Machine type of the worker, such as e2-standard-2. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that f1-micro and g1-small are not yet supported.
maxConcurrentActions This property is required. String
The maximum number of actions a worker can execute concurrently.
minCpuPlatform This property is required. String
Minimum CPU platform to use when creating the worker. See CPU Platforms.
networkAccess This property is required. String
Determines the type of network access granted to workers. Possible values: - "public": Workers can connect to the public internet. - "private": Workers can only connect to Google APIs and services. - "restricted-private": Workers can only connect to Google APIs that are reachable through restricted.googleapis.com (199.36.153.4/30).
reserved This property is required. Boolean
Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See Preemptible VMs for more details.
soleTenantNodeType This property is required. String
The node type name to be used for sole-tenant nodes.
vmImage This property is required. String
The name of the image used by each VM.
accelerator This property is required. GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfigResponse
The accelerator card attached to each VM.
diskSizeGb This property is required. string
Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/
diskType This property is required. string
Disk Type to use for the worker. See Storage options. Currently only pd-standard and pd-ssd are supported.
labels This property is required. {[key: string]: string}
Labels associated with the workers. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International letters are permitted. Label keys must start with a letter. Label values are optional. There can not be more than 64 labels per resource.
machineType This property is required. string
Machine type of the worker, such as e2-standard-2. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that f1-micro and g1-small are not yet supported.
maxConcurrentActions This property is required. string
The maximum number of actions a worker can execute concurrently.
minCpuPlatform This property is required. string
Minimum CPU platform to use when creating the worker. See CPU Platforms.
networkAccess This property is required. string
Determines the type of network access granted to workers. Possible values: - "public": Workers can connect to the public internet. - "private": Workers can only connect to Google APIs and services. - "restricted-private": Workers can only connect to Google APIs that are reachable through restricted.googleapis.com (199.36.153.4/30).
reserved This property is required. boolean
Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See Preemptible VMs for more details.
soleTenantNodeType This property is required. string
The node type name to be used for sole-tenant nodes.
vmImage This property is required. string
The name of the image used by each VM.
accelerator This property is required. GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfigResponse
The accelerator card attached to each VM.
disk_size_gb This property is required. str
Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/
disk_type This property is required. str
Disk Type to use for the worker. See Storage options. Currently only pd-standard and pd-ssd are supported.
labels This property is required. Mapping[str, str]
Labels associated with the workers. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International letters are permitted. Label keys must start with a letter. Label values are optional. There can not be more than 64 labels per resource.
machine_type This property is required. str
Machine type of the worker, such as e2-standard-2. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that f1-micro and g1-small are not yet supported.
max_concurrent_actions This property is required. str
The maximum number of actions a worker can execute concurrently.
min_cpu_platform This property is required. str
Minimum CPU platform to use when creating the worker. See CPU Platforms.
network_access This property is required. str
Determines the type of network access granted to workers. Possible values: - "public": Workers can connect to the public internet. - "private": Workers can only connect to Google APIs and services. - "restricted-private": Workers can only connect to Google APIs that are reachable through restricted.googleapis.com (199.36.153.4/30).
reserved This property is required. bool
Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See Preemptible VMs for more details.
sole_tenant_node_type This property is required. str
The node type name to be used for sole-tenant nodes.
vm_image This property is required. str
The name of the image used by each VM.
accelerator This property is required. Property Map
The accelerator card attached to each VM.
diskSizeGb This property is required. String
Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/
diskType This property is required. String
Disk Type to use for the worker. See Storage options. Currently only pd-standard and pd-ssd are supported.
labels This property is required. Map<String>
Labels associated with the workers. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International letters are permitted. Label keys must start with a letter. Label values are optional. There can not be more than 64 labels per resource.
machineType This property is required. String
Machine type of the worker, such as e2-standard-2. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that f1-micro and g1-small are not yet supported.
maxConcurrentActions This property is required. String
The maximum number of actions a worker can execute concurrently.
minCpuPlatform This property is required. String
Minimum CPU platform to use when creating the worker. See CPU Platforms.
networkAccess This property is required. String
Determines the type of network access granted to workers. Possible values: - "public": Workers can connect to the public internet. - "private": Workers can only connect to Google APIs and services. - "restricted-private": Workers can only connect to Google APIs that are reachable through restricted.googleapis.com (199.36.153.4/30).
reserved This property is required. Boolean
Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See Preemptible VMs for more details.
soleTenantNodeType This property is required. String
The node type name to be used for sole-tenant nodes.
vmImage This property is required. String
The name of the image used by each VM.

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