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
__construct
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. |
↳ update_mask |
Google\Protobuf\FieldMask
The field mask of the fields in |
getAgentPool
Required. The agent pool to update. agent_pool is expected to specify following
fields:
- name
- display_name
- bandwidth_limit
An
UpdateAgentPoolRequestwith any other fields is rejected with the error INVALID_ARGUMENT.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\StorageTransfer\V1\AgentPool|null | |
hasAgentPool
clearAgentPool
setAgentPool
Required. The agent pool to update. agent_pool is expected to specify following
fields:
- name
- display_name
- bandwidth_limit
An
UpdateAgentPoolRequestwith any other fields is rejected with the error INVALID_ARGUMENT.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\StorageTransfer\V1\AgentPool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateMask
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 | |
hasUpdateMask
clearUpdateMask
setUpdateMask
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 | |