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

Methods

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ agent_pool`	`Google\Cloud\StorageTransfer\V1\AgentPool` Required. The agent pool to update. `agent_pool` is expected to specify following fields: * name * display_name * bandwidth_limit An `UpdateAgentPoolRequest` with any other fields is rejected with the error INVALID_ARGUMENT.
`↳ update_mask`	`Google\Protobuf\FieldMask` The field mask of the fields in `agentPool` to update in this request. The following `agentPool` fields can be updated: * display_name * bandwidth_limit

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

name
display_name
bandwidth_limit An UpdateAgentPoolRequest with any other fields is rejected with the error INVALID_ARGUMENT.

Returns
Type	Description
`Google\Cloud\StorageTransfer\V1\AgentPool\|null`

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

name
display_name
bandwidth_limit An UpdateAgentPoolRequest with any other fields is rejected with the error INVALID_ARGUMENT.

Parameter
Name	Description
`var`	`Google\Cloud\StorageTransfer\V1\AgentPool`

Returns
Type	Description
`$this`

The field mask of the fields in agentPool to update in this request.

The following agentPool fields can be updated:

Returns
Type	Description
`Google\Protobuf\FieldMask\|null`

The field mask of the fields in agentPool to update in this request.

The following agentPool fields can be updated:

Parameter
Name	Description
`var`	`Google\Protobuf\FieldMask`

Returns
Type	Description
`$this`