Google Cloud Storage Transfer V1 Client - Class UpdateAgentPoolRequest (1.3.1)

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

getAgentPool

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

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

hasAgentPool

clearAgentPool

setAgentPool

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

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

getUpdateMask

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

The following agentPool fields can be updated:

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

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

The following agentPool fields can be updated:

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
agentPool Google\Cloud\StorageTransfer\V1\AgentPool

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

updateMask Google\Protobuf\FieldMask

The field mask of the fields in agentPool to update in this request. The following agentPool fields can be updated:

Returns
TypeDescription
Google\Cloud\StorageTransfer\V1\UpdateAgentPoolRequest