Class: Google::Cloud::Dataproc::V1::ListSessionsRequest

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

Overview

A request to list sessions in a project.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns 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, create_time, and labels.

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. state = ACTIVE and labels.environment=production is a filter for sessions in an ACTIVE state that have a production environment label.

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, create_time, and labels.

    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. state = ACTIVE and labels.environment=production is a filter for sessions in an ACTIVE state that have a production environment label.

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



95
96
97
98
 
# File 'proto_docs/google/cloud/dataproc/v1/sessions.rb', line 95

class ListSessionsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

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



95
96
97
98
 
# File 'proto_docs/google/cloud/dataproc/v1/sessions.rb', line 95

class ListSessionsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

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



95
96
97
98
 
# File 'proto_docs/google/cloud/dataproc/v1/sessions.rb', line 95

class ListSessionsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns Required. The parent, which owns this collection of sessions.

Returns:

  • (::String) —

    Required. The parent, which owns this collection of sessions.



95
96
97
98
 
# File 'proto_docs/google/cloud/dataproc/v1/sessions.rb', line 95

class ListSessionsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end