Class: Google::Cloud::StorageTransfer::V1::AgentPool

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/storagetransfer/v1/transfer_types.rb

Overview

Represents an agent pool.

Defined Under Namespace

Modules: State Classes: BandwidthLimit

Instance Attribute Summary collapse

Instance Attribute Details

#bandwidth_limit ⇒ ::Google::Cloud::StorageTransfer::V1::AgentPool::BandwidthLimit

Returns Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.

Returns:



589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 589

class AgentPool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies a bandwidth limit for an agent pool.
  # @!attribute [rw] limit_mbps
  #   @return [::Integer]
  #     Bandwidth rate in megabytes per second, distributed across all the agents
  #     in the pool.
  class BandwidthLimit
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state of an AgentPool.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # This is an initialization state. During this stage, resources are
    # allocated for the AgentPool.
    CREATING = 1

    # Determines that the AgentPool is created for use. At this state, Agents
    # can join the AgentPool and participate in the transfer jobs in that pool.
    CREATED = 2

    # Determines that the AgentPool deletion has been initiated, and all the
    # resources are scheduled to be cleaned up and freed.
    DELETING = 3
  end
end

#display_name ⇒ ::String

Returns Specifies the client-specified AgentPool description.

Returns:

  • (::String) —

    Specifies the client-specified AgentPool description.



589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 589

class AgentPool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies a bandwidth limit for an agent pool.
  # @!attribute [rw] limit_mbps
  #   @return [::Integer]
  #     Bandwidth rate in megabytes per second, distributed across all the agents
  #     in the pool.
  class BandwidthLimit
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state of an AgentPool.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # This is an initialization state. During this stage, resources are
    # allocated for the AgentPool.
    CREATING = 1

    # Determines that the AgentPool is created for use. At this state, Agents
    # can join the AgentPool and participate in the transfer jobs in that pool.
    CREATED = 2

    # Determines that the AgentPool deletion has been initiated, and all the
    # resources are scheduled to be cleaned up and freed.
    DELETING = 3
  end
end

#name ⇒ ::String

Returns 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}



589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 589

class AgentPool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies a bandwidth limit for an agent pool.
  # @!attribute [rw] limit_mbps
  #   @return [::Integer]
  #     Bandwidth rate in megabytes per second, distributed across all the agents
  #     in the pool.
  class BandwidthLimit
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state of an AgentPool.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # This is an initialization state. During this stage, resources are
    # allocated for the AgentPool.
    CREATING = 1

    # Determines that the AgentPool is created for use. At this state, Agents
    # can join the AgentPool and participate in the transfer jobs in that pool.
    CREATED = 2

    # Determines that the AgentPool deletion has been initiated, and all the
    # resources are scheduled to be cleaned up and freed.
    DELETING = 3
  end
end

#state ⇒ ::Google::Cloud::StorageTransfer::V1::AgentPool::State (readonly)

Returns Output only. Specifies the state of the AgentPool.

Returns:



589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 589

class AgentPool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies a bandwidth limit for an agent pool.
  # @!attribute [rw] limit_mbps
  #   @return [::Integer]
  #     Bandwidth rate in megabytes per second, distributed across all the agents
  #     in the pool.
  class BandwidthLimit
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state of an AgentPool.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # This is an initialization state. During this stage, resources are
    # allocated for the AgentPool.
    CREATING = 1

    # Determines that the AgentPool is created for use. At this state, Agents
    # can join the AgentPool and participate in the transfer jobs in that pool.
    CREATED = 2

    # Determines that the AgentPool deletion has been initiated, and all the
    # resources are scheduled to be cleaned up and freed.
    DELETING = 3
  end
end