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 | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. Specifies a unique string that identifies the agent pool. Format: |
↳ 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 | |
|---|---|
| Type | Description |
string | |
setName
Required. Specifies a unique string that identifies the agent pool.
Format: projects/{project_id}/agentPools/{agent_pool_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Specifies the client-specified AgentPool description.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Specifies the client-specified AgentPool description.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. Specifies the state of the AgentPool.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. Specifies the state of the AgentPool.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBandwidthLimit
Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Cloud\StorageTransfer\V1\AgentPool\BandwidthLimit
|
| Returns | |
|---|---|
| Type | Description |
$this | |