Reference documentation and code samples for the Storage Transfer Service V1 API class Google::Cloud::StorageTransfer::V1::AgentPool.
Represents an agent pool.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#bandwidth_limit
def bandwidth_limit() -> ::Google::Cloud::StorageTransfer::V1::AgentPool::BandwidthLimit
Returns
- (::Google::Cloud::StorageTransfer::V1::AgentPool::BandwidthLimit) — Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
#bandwidth_limit=
def bandwidth_limit=(value) -> ::Google::Cloud::StorageTransfer::V1::AgentPool::BandwidthLimit
Parameter
- value (::Google::Cloud::StorageTransfer::V1::AgentPool::BandwidthLimit) — Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
Returns
- (::Google::Cloud::StorageTransfer::V1::AgentPool::BandwidthLimit) — Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
#display_name
def display_name() -> ::String
Returns
- (::String) — Specifies the client-specified AgentPool description.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Specifies the client-specified AgentPool description.
Returns
- (::String) — Specifies the client-specified AgentPool description.
#name
def name() -> ::String
Returns
-
(::String) — Required. Specifies a unique string that identifies the agent pool.
Format:
projects/{project_id}/agentPools/{agent_pool_id}
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Required. Specifies a unique string that identifies the agent pool.
Format:
projects/{project_id}/agentPools/{agent_pool_id}
Returns
-
(::String) — Required. Specifies a unique string that identifies the agent pool.
Format:
projects/{project_id}/agentPools/{agent_pool_id}
#state
def state() -> ::Google::Cloud::StorageTransfer::V1::AgentPool::State
Returns
- (::Google::Cloud::StorageTransfer::V1::AgentPool::State) — Output only. Specifies the state of the AgentPool.