Cloud Dataproc V1 API - Class Google::Cloud::Dataproc::V1::ListBatchesRequest (v0.19.0)

Reference documentation and code samples for the Cloud Dataproc V1 API class Google::Cloud::Dataproc::V1::ListBatchesRequest.

A request to list batch workloads in a project.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) — Optional. A filter for the batches to return in the response.

    A filter is a logical expression constraining the values of various fields in each batch resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND/OR). Supported fields are batch_id, batch_uuid, state, and create_time.

    e.g. state = RUNNING and create_time < "2023-01-01T00:00:00Z" filters for batches in state RUNNING that were created before 2023-01-01

    See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparisons.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — Optional. A filter for the batches to return in the response.

    A filter is a logical expression constraining the values of various fields in each batch resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND/OR). Supported fields are batch_id, batch_uuid, state, and create_time.

    e.g. state = RUNNING and create_time < "2023-01-01T00:00:00Z" filters for batches in state RUNNING that were created before 2023-01-01

    See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparisons.

Returns
  • (::String) — Optional. A filter for the batches to return in the response.

    A filter is a logical expression constraining the values of various fields in each batch resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND/OR). Supported fields are batch_id, batch_uuid, state, and create_time.

    e.g. state = RUNNING and create_time < "2023-01-01T00:00:00Z" filters for batches in state RUNNING that were created before 2023-01-01

    See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparisons.

#order_by

def order_by() -> ::String
Returns
  • (::String) — Optional. Field(s) on which to sort the list of batches.

    Currently the only supported sort orders are unspecified (empty) and create_time desc to sort by most recently created batches first.

    See https://google.aip.dev/132#ordering for more details.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::String) — Optional. Field(s) on which to sort the list of batches.

    Currently the only supported sort orders are unspecified (empty) and create_time desc to sort by most recently created batches first.

    See https://google.aip.dev/132#ordering for more details.

Returns
  • (::String) — Optional. Field(s) on which to sort the list of batches.

    Currently the only supported sort orders are unspecified (empty) and create_time desc to sort by most recently created batches first.

    See https://google.aip.dev/132#ordering for more details.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Optional. The maximum number of batches to return in each response. The service may return fewer than this value. The default page size is 20; the maximum page size is 1000.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The maximum number of batches to return in each response. The service may return fewer than this value. The default page size is 20; the maximum page size is 1000.
Returns
  • (::Integer) — Optional. The maximum number of batches to return in each response. The service may return fewer than this value. The default page size is 20; the maximum page size is 1000.

#page_token

def page_token() -> ::String
Returns
  • (::String) — Optional. A page token received from a previous ListBatches call. Provide this token to retrieve the subsequent page.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — Optional. A page token received from a previous ListBatches call. Provide this token to retrieve the subsequent page.
Returns
  • (::String) — Optional. A page token received from a previous ListBatches call. Provide this token to retrieve the subsequent page.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The parent, which owns this collection of batches.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The parent, which owns this collection of batches.
Returns
  • (::String) — Required. The parent, which owns this collection of batches.