# Google Cloud Storage Transfer V1 Client - Class UpdateAgentPoolRequest (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 UpdateAgentPoolRequest.

Specifies the request passed to UpdateAgentPool.

Generated from protobuf message `google.storagetransfer.v1.UpdateAgentPoolRequest`

## Namespace

Google \\ Cloud \\ StorageTransfer \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ agent_pool` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool` Required. The agent pool to update. `agent_pool` is expected to specify following fields: \* \* [name](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool#_Google_Cloud_StorageTransfer_V1_AgentPool__getName__) \* \* [display_name](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool#_Google_Cloud_StorageTransfer_V1_AgentPool__getDisplayName__) \* \* [bandwidth_limit](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool#_Google_Cloud_StorageTransfer_V1_AgentPool__getBandwidthLimit__) An `UpdateAgentPoolRequest` with any other fields is rejected with the error [INVALID_ARGUMENT](https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Code.html#_Google_Rpc_Code__INVALID_ARGUMENT). |
| `↳ update_mask` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/FieldMask` The [field mask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf) of the fields in `agentPool` to update in this request. The following `agentPool` fields can be updated: \* \* [display_name](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool#_Google_Cloud_StorageTransfer_V1_AgentPool__getDisplayName__) \* \* [bandwidth_limit](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool#_Google_Cloud_StorageTransfer_V1_AgentPool__getBandwidthLimit__) |

### getAgentPool

Required. The agent pool to update. `agent_pool` is expected to specify
following fields:

- [name](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool#_Google_Cloud_StorageTransfer_V1_AgentPool__getName__)
- [display_name](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool#_Google_Cloud_StorageTransfer_V1_AgentPool__getDisplayName__)
- [bandwidth_limit](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool#_Google_Cloud_StorageTransfer_V1_AgentPool__getBandwidthLimit__) An `UpdateAgentPoolRequest` with any other fields is rejected with the error [INVALID_ARGUMENT](https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Code.html#_Google_Rpc_Code__INVALID_ARGUMENT).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool|null` |   |

### hasAgentPool

### clearAgentPool

### setAgentPool

Required. The agent pool to update. `agent_pool` is expected to specify
following fields:

- [name](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool#_Google_Cloud_StorageTransfer_V1_AgentPool__getName__)
- [display_name](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool#_Google_Cloud_StorageTransfer_V1_AgentPool__getDisplayName__)
- [bandwidth_limit](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool#_Google_Cloud_StorageTransfer_V1_AgentPool__getBandwidthLimit__) An `UpdateAgentPoolRequest` with any other fields is rejected with the error [INVALID_ARGUMENT](https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Code.html#_Google_Rpc_Code__INVALID_ARGUMENT).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool` |

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

### getUpdateMask

The [field mask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf)
of the fields in `agentPool` to update in this request.

The following `agentPool` fields can be updated:

- [display_name](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool#_Google_Cloud_StorageTransfer_V1_AgentPool__getDisplayName__)
- [bandwidth_limit](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool#_Google_Cloud_StorageTransfer_V1_AgentPool__getBandwidthLimit__)

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/FieldMask|null` |   |

### hasUpdateMask

### clearUpdateMask

### setUpdateMask

The [field mask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf)
of the fields in `agentPool` to update in this request.

The following `agentPool` fields can be updated:

- [display_name](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool#_Google_Cloud_StorageTransfer_V1_AgentPool__getDisplayName__)
- [bandwidth_limit](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool#_Google_Cloud_StorageTransfer_V1_AgentPool__getBandwidthLimit__)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/FieldMask` |

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

### static::build

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `agentPool` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool` Required. The agent pool to update. `agent_pool` is expected to specify following fields: - - [name](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool#_Google_Cloud_StorageTransfer_V1_AgentPool__getName__) - - [display_name](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool#_Google_Cloud_StorageTransfer_V1_AgentPool__getDisplayName__) - - [bandwidth_limit](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool#_Google_Cloud_StorageTransfer_V1_AgentPool__getBandwidthLimit__) An `UpdateAgentPoolRequest` with any other fields is rejected with the error [INVALID_ARGUMENT](https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Code.html#_Google_Rpc_Code__INVALID_ARGUMENT). |
| `updateMask` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/FieldMask` The [field mask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf) of the fields in `agentPool` to update in this request. The following `agentPool` fields can be updated: - - [display_name](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool#_Google_Cloud_StorageTransfer_V1_AgentPool__getDisplayName__) - - [bandwidth_limit](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.AgentPool#_Google_Cloud_StorageTransfer_V1_AgentPool__getBandwidthLimit__) |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.UpdateAgentPoolRequest` |   |