Google Cloud Storage Transfer V1 Client - Class AgentPool (1.0.6)

Reference documentation and code samples for the Google Cloud Storage Transfer V1 Client class AgentPool.

Represents an On-Premises Agent pool.

Generated from protobuf message google.storagetransfer.v1.AgentPool

Methods

__construct

Constructor.

Parameters
NameDescription
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}

Returns
TypeDescription
string

setName

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

Format: projects/{project_id}/agentPools/{agent_pool_id}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

Specifies the client-specified AgentPool description.

Returns
TypeDescription
string

setDisplayName

Specifies the client-specified AgentPool description.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. Specifies the state of the AgentPool.

Returns
TypeDescription
int

setState

Output only. Specifies the state of the AgentPool.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getBandwidthLimit

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

Returns
TypeDescription
Google\Cloud\StorageTransfer\V1\AgentPool\BandwidthLimit|null

hasBandwidthLimit

clearBandwidthLimit

setBandwidthLimit

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

Parameter
NameDescription
var Google\Cloud\StorageTransfer\V1\AgentPool\BandwidthLimit
Returns
TypeDescription
$this