Storage Transfer Service V1 API - Class Google::Cloud::StorageTransfer::V1::ListAgentPoolsRequest (v1.8.1)

Reference documentation and code samples for the Storage Transfer Service V1 API class Google::Cloud::StorageTransfer::V1::ListAgentPoolsRequest.

The request passed to ListAgentPools.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) — An optional list of query parameters specified as JSON text in the form of:

    {"agentPoolNames":["agentpool1","agentpool2",...]}

    Since agentPoolNames support multiple values, its values must be specified with array notation. When the filter is either empty or not provided, the list returns all agent pools for the project.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — An optional list of query parameters specified as JSON text in the form of:

    {"agentPoolNames":["agentpool1","agentpool2",...]}

    Since agentPoolNames support multiple values, its values must be specified with array notation. When the filter is either empty or not provided, the list returns all agent pools for the project.

Returns
  • (::String) — An optional list of query parameters specified as JSON text in the form of:

    {"agentPoolNames":["agentpool1","agentpool2",...]}

    Since agentPoolNames support multiple values, its values must be specified with array notation. When the filter is either empty or not provided, the list returns all agent pools for the project.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — The list page size. The max allowed value is 256.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — The list page size. The max allowed value is 256.
Returns
  • (::Integer) — The list page size. The max allowed value is 256.

#page_token

def page_token() -> ::String
Returns
  • (::String) — The list page token.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — The list page token.
Returns
  • (::String) — The list page token.

#project_id

def project_id() -> ::String
Returns
  • (::String) — Required. The ID of the Google Cloud project that owns the job.

#project_id=

def project_id=(value) -> ::String
Parameter
  • value (::String) — Required. The ID of the Google Cloud project that owns the job.
Returns
  • (::String) — Required. The ID of the Google Cloud project that owns the job.