[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-03 UTC."],[],[],null,["# Storage Transfer Service V1 API - Class Google::Cloud::StorageTransfer::V1::UpdateAgentPoolRequest (v1.6.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.6.0 (latest)](/ruby/docs/reference/google-cloud-storage_transfer-v1/latest/Google-Cloud-StorageTransfer-V1-UpdateAgentPoolRequest)\n- [1.5.0](/ruby/docs/reference/google-cloud-storage_transfer-v1/1.5.0/Google-Cloud-StorageTransfer-V1-UpdateAgentPoolRequest)\n- [1.4.1](/ruby/docs/reference/google-cloud-storage_transfer-v1/1.4.1/Google-Cloud-StorageTransfer-V1-UpdateAgentPoolRequest)\n- [1.3.0](/ruby/docs/reference/google-cloud-storage_transfer-v1/1.3.0/Google-Cloud-StorageTransfer-V1-UpdateAgentPoolRequest)\n- [1.2.0](/ruby/docs/reference/google-cloud-storage_transfer-v1/1.2.0/Google-Cloud-StorageTransfer-V1-UpdateAgentPoolRequest)\n- [1.1.1](/ruby/docs/reference/google-cloud-storage_transfer-v1/1.1.1/Google-Cloud-StorageTransfer-V1-UpdateAgentPoolRequest)\n- [1.0.0](/ruby/docs/reference/google-cloud-storage_transfer-v1/1.0.0/Google-Cloud-StorageTransfer-V1-UpdateAgentPoolRequest)\n- [0.10.0](/ruby/docs/reference/google-cloud-storage_transfer-v1/0.10.0/Google-Cloud-StorageTransfer-V1-UpdateAgentPoolRequest)\n- [0.9.2](/ruby/docs/reference/google-cloud-storage_transfer-v1/0.9.2/Google-Cloud-StorageTransfer-V1-UpdateAgentPoolRequest)\n- [0.8.0](/ruby/docs/reference/google-cloud-storage_transfer-v1/0.8.0/Google-Cloud-StorageTransfer-V1-UpdateAgentPoolRequest)\n- [0.7.0](/ruby/docs/reference/google-cloud-storage_transfer-v1/0.7.0/Google-Cloud-StorageTransfer-V1-UpdateAgentPoolRequest)\n- [0.6.1](/ruby/docs/reference/google-cloud-storage_transfer-v1/0.6.1/Google-Cloud-StorageTransfer-V1-UpdateAgentPoolRequest)\n- [0.5.0](/ruby/docs/reference/google-cloud-storage_transfer-v1/0.5.0/Google-Cloud-StorageTransfer-V1-UpdateAgentPoolRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-storage_transfer-v1/0.4.0/Google-Cloud-StorageTransfer-V1-UpdateAgentPoolRequest)\n- [0.3.0](/ruby/docs/reference/google-cloud-storage_transfer-v1/0.3.0/Google-Cloud-StorageTransfer-V1-UpdateAgentPoolRequest)\n- [0.2.0](/ruby/docs/reference/google-cloud-storage_transfer-v1/0.2.0/Google-Cloud-StorageTransfer-V1-UpdateAgentPoolRequest)\n- [0.1.2](/ruby/docs/reference/google-cloud-storage_transfer-v1/0.1.2/Google-Cloud-StorageTransfer-V1-UpdateAgentPoolRequest) \nReference documentation and code samples for the Storage Transfer Service V1 API class Google::Cloud::StorageTransfer::V1::UpdateAgentPoolRequest.\n\nSpecifies the request passed to UpdateAgentPool. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #agent_pool\n\n def agent_pool() -\u003e ::Google::Cloud::StorageTransfer::V1::AgentPool\n\n**Returns**\n\n- ([::Google::Cloud::StorageTransfer::V1::AgentPool](./Google-Cloud-StorageTransfer-V1-AgentPool)) ---\n\n Required. The agent pool to update. `agent_pool` is expected to specify\n following fields:\n - [name](/ruby/docs/reference/google-cloud-storage_transfer-v1/latest/Google-Cloud-StorageTransfer-V1-AgentPool#Google__Cloud__StorageTransfer__V1__AgentPool_name_instance_ \"Google::Cloud::StorageTransfer::V1::AgentPool#name (method)\")\n\n - [display_name](/ruby/docs/reference/google-cloud-storage_transfer-v1/latest/Google-Cloud-StorageTransfer-V1-AgentPool#Google__Cloud__StorageTransfer__V1__AgentPool_display_name_instance_ \"Google::Cloud::StorageTransfer::V1::AgentPool#display_name (method)\")\n\n - [bandwidth_limit](/ruby/docs/reference/google-cloud-storage_transfer-v1/latest/Google-Cloud-StorageTransfer-V1-AgentPool#Google__Cloud__StorageTransfer__V1__AgentPool_bandwidth_limit_instance_ \"Google::Cloud::StorageTransfer::V1::AgentPool#bandwidth_limit (method)\")\n An `UpdateAgentPoolRequest` with any other fields is rejected\n with the error [INVALID_ARGUMENT](/ruby/docs/reference/google-cloud-storage_transfer-v1/latest/Google-Rpc-Code#Google__Rpc__Code__INVALID_ARGUMENT \"Google::Rpc::Code::INVALID_ARGUMENT (constant)\").\n\n### #agent_pool=\n\n def agent_pool=(value) -\u003e ::Google::Cloud::StorageTransfer::V1::AgentPool\n\n**Parameter**\n\n- **value** ([::Google::Cloud::StorageTransfer::V1::AgentPool](./Google-Cloud-StorageTransfer-V1-AgentPool)) ---\n\n Required. The agent pool to update. `agent_pool` is expected to specify\n following fields:\n - [name](/ruby/docs/reference/google-cloud-storage_transfer-v1/latest/Google-Cloud-StorageTransfer-V1-AgentPool#Google__Cloud__StorageTransfer__V1__AgentPool_name_instance_ \"Google::Cloud::StorageTransfer::V1::AgentPool#name (method)\")\n\n - [display_name](/ruby/docs/reference/google-cloud-storage_transfer-v1/latest/Google-Cloud-StorageTransfer-V1-AgentPool#Google__Cloud__StorageTransfer__V1__AgentPool_display_name_instance_ \"Google::Cloud::StorageTransfer::V1::AgentPool#display_name (method)\")\n\n - [bandwidth_limit](/ruby/docs/reference/google-cloud-storage_transfer-v1/latest/Google-Cloud-StorageTransfer-V1-AgentPool#Google__Cloud__StorageTransfer__V1__AgentPool_bandwidth_limit_instance_ \"Google::Cloud::StorageTransfer::V1::AgentPool#bandwidth_limit (method)\")\n An `UpdateAgentPoolRequest` with any other fields is rejected\n with the error [INVALID_ARGUMENT](/ruby/docs/reference/google-cloud-storage_transfer-v1/latest/Google-Rpc-Code#Google__Rpc__Code__INVALID_ARGUMENT \"Google::Rpc::Code::INVALID_ARGUMENT (constant)\").\n\n**Returns**\n\n- ([::Google::Cloud::StorageTransfer::V1::AgentPool](./Google-Cloud-StorageTransfer-V1-AgentPool)) ---\n\n Required. The agent pool to update. `agent_pool` is expected to specify\n following fields:\n - [name](/ruby/docs/reference/google-cloud-storage_transfer-v1/latest/Google-Cloud-StorageTransfer-V1-AgentPool#Google__Cloud__StorageTransfer__V1__AgentPool_name_instance_ \"Google::Cloud::StorageTransfer::V1::AgentPool#name (method)\")\n\n - [display_name](/ruby/docs/reference/google-cloud-storage_transfer-v1/latest/Google-Cloud-StorageTransfer-V1-AgentPool#Google__Cloud__StorageTransfer__V1__AgentPool_display_name_instance_ \"Google::Cloud::StorageTransfer::V1::AgentPool#display_name (method)\")\n\n - [bandwidth_limit](/ruby/docs/reference/google-cloud-storage_transfer-v1/latest/Google-Cloud-StorageTransfer-V1-AgentPool#Google__Cloud__StorageTransfer__V1__AgentPool_bandwidth_limit_instance_ \"Google::Cloud::StorageTransfer::V1::AgentPool#bandwidth_limit (method)\")\n An `UpdateAgentPoolRequest` with any other fields is rejected\n with the error [INVALID_ARGUMENT](/ruby/docs/reference/google-cloud-storage_transfer-v1/latest/Google-Rpc-Code#Google__Rpc__Code__INVALID_ARGUMENT \"Google::Rpc::Code::INVALID_ARGUMENT (constant)\").\n\n### #update_mask\n\n def update_mask() -\u003e ::Google::Protobuf::FieldMask\n\n**Returns**\n\n- ([::Google::Protobuf::FieldMask](./Google-Protobuf-FieldMask)) ---\n\n The [field mask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf)\n of the fields in `agentPool` to update in this request.\n The following `agentPool` fields can be updated:\n - [display_name](/ruby/docs/reference/google-cloud-storage_transfer-v1/latest/Google-Cloud-StorageTransfer-V1-AgentPool#Google__Cloud__StorageTransfer__V1__AgentPool_display_name_instance_ \"Google::Cloud::StorageTransfer::V1::AgentPool#display_name (method)\")\n\n - [bandwidth_limit](/ruby/docs/reference/google-cloud-storage_transfer-v1/latest/Google-Cloud-StorageTransfer-V1-AgentPool#Google__Cloud__StorageTransfer__V1__AgentPool_bandwidth_limit_instance_ \"Google::Cloud::StorageTransfer::V1::AgentPool#bandwidth_limit (method)\")\n\n### #update_mask=\n\n def update_mask=(value) -\u003e ::Google::Protobuf::FieldMask\n\n**Parameter**\n\n- **value** ([::Google::Protobuf::FieldMask](./Google-Protobuf-FieldMask)) ---\n\n The [field mask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf)\n of the fields in `agentPool` to update in this request.\n The following `agentPool` fields can be updated:\n - [display_name](/ruby/docs/reference/google-cloud-storage_transfer-v1/latest/Google-Cloud-StorageTransfer-V1-AgentPool#Google__Cloud__StorageTransfer__V1__AgentPool_display_name_instance_ \"Google::Cloud::StorageTransfer::V1::AgentPool#display_name (method)\")\n\n - [bandwidth_limit](/ruby/docs/reference/google-cloud-storage_transfer-v1/latest/Google-Cloud-StorageTransfer-V1-AgentPool#Google__Cloud__StorageTransfer__V1__AgentPool_bandwidth_limit_instance_ \"Google::Cloud::StorageTransfer::V1::AgentPool#bandwidth_limit (method)\")\n\n**Returns**\n\n- ([::Google::Protobuf::FieldMask](./Google-Protobuf-FieldMask)) ---\n\n The [field mask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf)\n of the fields in `agentPool` to update in this request.\n The following `agentPool` fields can be updated:\n - [display_name](/ruby/docs/reference/google-cloud-storage_transfer-v1/latest/Google-Cloud-StorageTransfer-V1-AgentPool#Google__Cloud__StorageTransfer__V1__AgentPool_display_name_instance_ \"Google::Cloud::StorageTransfer::V1::AgentPool#display_name (method)\")\n\n - [bandwidth_limit](/ruby/docs/reference/google-cloud-storage_transfer-v1/latest/Google-Cloud-StorageTransfer-V1-AgentPool#Google__Cloud__StorageTransfer__V1__AgentPool_bandwidth_limit_instance_ \"Google::Cloud::StorageTransfer::V1::AgentPool#bandwidth_limit (method)\")"]]
