# Google Cloud Storage Transfer V1 Client - Class AgentPool (2.4.0)

2.4.0 (latest) 2.3.2 2.2.1 2.1.1 2.0.2 1.5.0 1.4.5 1.3.1 1.2.0 1.1.1 1.0.6 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 \\ V1

## 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: `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` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/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` | Enum of type [State](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool.State). |

### setState

Output only. Specifies the state of the AgentPool.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [State](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool.State). |

| **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** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/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` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool.BandwidthLimit` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |