Cloud Dataproc V1 API - Class Google::Cloud::Dataproc::V1::ListSessionsRequest (v1.0.0)

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

A request to list sessions 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 sessions to return in the response.

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

    Example: state = ACTIVE and create_time < "2023-01-01T00:00:00Z" is a filter for sessions in an ACTIVE state 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 comparators.

#filter=

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

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

    Example: state = ACTIVE and create_time < "2023-01-01T00:00:00Z" is a filter for sessions in an ACTIVE state 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 comparators.

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

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

    Example: state = ACTIVE and create_time < "2023-01-01T00:00:00Z" is a filter for sessions in an ACTIVE state 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 comparators.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Optional. The maximum number of sessions to return in each response. The service may return fewer than this value.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The maximum number of sessions to return in each response. The service may return fewer than this value.
Returns
  • (::Integer) — Optional. The maximum number of sessions to return in each response. The service may return fewer than this value.

#page_token

def page_token() -> ::String
Returns
  • (::String) — Optional. A page token received from a previous ListSessions 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 ListSessions call. Provide this token to retrieve the subsequent page.
Returns
  • (::String) — Optional. A page token received from a previous ListSessions call. Provide this token to retrieve the subsequent page.

#parent

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

#parent=

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