1. Packages
  2. Google Cloud Native
  3. API Docs
  4. storagetransfer
  5. storagetransfer/v1
  6. getAgentPool

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.storagetransfer/v1.getAgentPool

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

Gets an agent pool.

Using getAgentPool

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 getAgentPool(args: GetAgentPoolArgs, opts?: InvokeOptions): Promise<GetAgentPoolResult>
function getAgentPoolOutput(args: GetAgentPoolOutputArgs, opts?: InvokeOptions): Output<GetAgentPoolResult>
Copy
def get_agent_pool(agent_pool_id: Optional[str] = None,
                   project: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetAgentPoolResult
def get_agent_pool_output(agent_pool_id: Optional[pulumi.Input[str]] = None,
                   project: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetAgentPoolResult]
Copy
func LookupAgentPool(ctx *Context, args *LookupAgentPoolArgs, opts ...InvokeOption) (*LookupAgentPoolResult, error)
func LookupAgentPoolOutput(ctx *Context, args *LookupAgentPoolOutputArgs, opts ...InvokeOption) LookupAgentPoolResultOutput
Copy

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

public static class GetAgentPool 
{
    public static Task<GetAgentPoolResult> InvokeAsync(GetAgentPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetAgentPoolResult> Invoke(GetAgentPoolInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAgentPoolResult> getAgentPool(GetAgentPoolArgs args, InvokeOptions options)
public static Output<GetAgentPoolResult> getAgentPool(GetAgentPoolArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:storagetransfer/v1:getAgentPool
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AgentPoolId This property is required. string
Project string
AgentPoolId This property is required. string
Project string
agentPoolId This property is required. String
project String
agentPoolId This property is required. string
project string
agent_pool_id This property is required. str
project str
agentPoolId This property is required. String
project String

getAgentPool Result

The following output properties are available:

BandwidthLimit Pulumi.GoogleNative.StorageTransfer.V1.Outputs.BandwidthLimitResponse
Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
DisplayName string
Specifies the client-specified AgentPool description.
Name string
Specifies a unique string that identifies the agent pool. Format: projects/{project_id}/agentPools/{agent_pool_id}
State string
Specifies the state of the AgentPool.
BandwidthLimit BandwidthLimitResponse
Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
DisplayName string
Specifies the client-specified AgentPool description.
Name string
Specifies a unique string that identifies the agent pool. Format: projects/{project_id}/agentPools/{agent_pool_id}
State string
Specifies the state of the AgentPool.
bandwidthLimit BandwidthLimitResponse
Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
displayName String
Specifies the client-specified AgentPool description.
name String
Specifies a unique string that identifies the agent pool. Format: projects/{project_id}/agentPools/{agent_pool_id}
state String
Specifies the state of the AgentPool.
bandwidthLimit BandwidthLimitResponse
Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
displayName string
Specifies the client-specified AgentPool description.
name string
Specifies a unique string that identifies the agent pool. Format: projects/{project_id}/agentPools/{agent_pool_id}
state string
Specifies the state of the AgentPool.
bandwidth_limit BandwidthLimitResponse
Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
display_name str
Specifies the client-specified AgentPool description.
name str
Specifies a unique string that identifies the agent pool. Format: projects/{project_id}/agentPools/{agent_pool_id}
state str
Specifies the state of the AgentPool.
bandwidthLimit Property Map
Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
displayName String
Specifies the client-specified AgentPool description.
name String
Specifies a unique string that identifies the agent pool. Format: projects/{project_id}/agentPools/{agent_pool_id}
state String
Specifies the state of the AgentPool.

Supporting Types

BandwidthLimitResponse

LimitMbps This property is required. string
Bandwidth rate in megabytes per second, distributed across all the agents in the pool.
LimitMbps This property is required. string
Bandwidth rate in megabytes per second, distributed across all the agents in the pool.
limitMbps This property is required. String
Bandwidth rate in megabytes per second, distributed across all the agents in the pool.
limitMbps This property is required. string
Bandwidth rate in megabytes per second, distributed across all the agents in the pool.
limit_mbps This property is required. str
Bandwidth rate in megabytes per second, distributed across all the agents in the pool.
limitMbps This property is required. String
Bandwidth rate in megabytes per second, distributed across all the agents in the pool.

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