REST Resource: projects.agentPools

Resource: AgentPool

Represents an On-Premises Agent pool.

JSON representation 
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "bandwidthLimit": {
    object (BandwidthLimit)
  }
}
Fields
name

string

Required. Specifies a unique string that identifies the agent pool.

Format: projects/{projectId}/agentPools/{agentPoolId}
displayName

string

Specifies the client-specified AgentPool description.
state

enum (State)

Output only. Specifies the state of the AgentPool.
bandwidthLimit

object (BandwidthLimit)

Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.

State

The state of an AgentPool.

Enums
STATE_UNSPECIFIED Default value. This value is unused.
CREATING This is an initialization state. During this stage, the resources such as Pub/Sub topics are allocated for the AgentPool.
CREATED Determines that the AgentPool is created for use. At this state, Agents can join the AgentPool and participate in the transfer jobs in that pool.
DELETING Determines that the AgentPool deletion has been initiated, and all the resources are scheduled to be cleaned up and freed.

BandwidthLimit

Specifies a bandwidth limit for an agent pool.

JSON representation 
{
  "limitMbps": string
}
Fields
limitMbps

string (int64 format)

Bandwidth rate in megabytes per second, distributed across all the agents in the pool.

Methods

create

 Creates an agent pool resource.

delete

 Deletes an agent pool.

get

 Gets an agent pool.

list

 Lists agent pools.

patch

 Updates an existing agent pool resource.