Resource: AgentPool
Represents an agent pool.
JSON representation |
---|
{ "name": string, "displayName": string, "state": enum ( |
Fields | |
---|---|
name |
Required. Specifies a unique string that identifies the agent pool. Format: |
displayName |
Specifies the client-specified AgentPool description. |
state |
Output only. Specifies the state of the AgentPool. |
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, resources 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 |
Bandwidth rate in megabytes per second, distributed across all the agents in the pool. |
Methods |
|
---|---|
|
Creates an agent pool resource. |
|
Deletes an agent pool. |
|
Gets an agent pool. |
|
Lists agent pools. |
|
Updates an existing agent pool resource. |