Reference documentation and code samples for the Google Cloud Storage Transfer V1 Client class AgentPool.
Represents an agent pool.
Generated from protobuf message google.storagetransfer.v1.AgentPool
Namespace
Google \ Cloud \ StorageTransfer \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. Specifies a unique string that identifies the agent pool. Format: projects/{project_id}/agentPools/{agent_pool_id}
↳ display_name
string
Specifies the client-specified AgentPool description.
↳ state
int
Output only. Specifies the state of the AgentPool.
↳ bandwidth_limit
Google\Cloud\StorageTransfer\V1\AgentPool\BandwidthLimit
Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
getName
Required. Specifies a unique string that identifies the agent pool.
Format: projects/{project_id}/agentPools/{agent_pool_id}
string
setName
Required. Specifies a unique string that identifies the agent pool.
Format: projects/{project_id}/agentPools/{agent_pool_id}
var
string
$this
getDisplayName
Specifies the client-specified AgentPool description.
string
setDisplayName
Specifies the client-specified AgentPool description.
var
string
$this
getState
Output only. Specifies the state of the AgentPool.
int
setState
Output only. Specifies the state of the AgentPool.
var
int
$this
getBandwidthLimit
Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
hasBandwidthLimit
clearBandwidthLimit
setBandwidthLimit
Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
$this
