Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::ListSessionsRequest (v0.28.0)

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::ListSessionsRequest.

Request for ListSessions method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) —

    A comma-separated list of fields to filter by, in EBNF grammar.

    The supported fields are:

    • user_pseudo_id
    • state
    • display_name
    • starred
    • is_pinned
    • labels
    • create_time
    • update_time
    • collaborative_project

    Examples:

    • user_pseudo_id = some_id
    • display_name = "some_name"
    • starred = true
    • is_pinned=true AND (NOT labels:hidden)
    • create_time > "1970-01-01T12:00:00Z"
    • collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) —

    A comma-separated list of fields to filter by, in EBNF grammar.

    The supported fields are:

    • user_pseudo_id
    • state
    • display_name
    • starred
    • is_pinned
    • labels
    • create_time
    • update_time
    • collaborative_project

    Examples:

    • user_pseudo_id = some_id
    • display_name = "some_name"
    • starred = true
    • is_pinned=true AND (NOT labels:hidden)
    • create_time > "1970-01-01T12:00:00Z"
    • collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"
Returns
  • (::String) —

    A comma-separated list of fields to filter by, in EBNF grammar.

    The supported fields are:

    • user_pseudo_id
    • state
    • display_name
    • starred
    • is_pinned
    • labels
    • create_time
    • update_time
    • collaborative_project

    Examples:

    • user_pseudo_id = some_id
    • display_name = "some_name"
    • starred = true
    • is_pinned=true AND (NOT labels:hidden)
    • create_time > "1970-01-01T12:00:00Z"
    • collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"

#order_by

def order_by() -> ::String
Returns
  • (::String) —

    A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

    Supported fields:

    • update_time
    • create_time
    • session_name
    • is_pinned
    • display_name

    Example:

    • update_time desc
    • create_time
    • is_pinned desc,update_time desc: list sessions by is_pinned first, then by update_time.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::String) —

    A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

    Supported fields:

    • update_time
    • create_time
    • session_name
    • is_pinned
    • display_name

    Example:

    • update_time desc
    • create_time
    • is_pinned desc,update_time desc: list sessions by is_pinned first, then by update_time.
Returns
  • (::String) —

    A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

    Supported fields:

    • update_time
    • create_time
    • session_name
    • is_pinned
    • display_name

    Example:

    • update_time desc
    • create_time
    • is_pinned desc,update_time desc: list sessions by is_pinned first, then by update_time.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
Returns
  • (::Integer) — Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

#page_token

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

#page_token=

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

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The data store resource name. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The data store resource name. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}
Returns
  • (::String) — Required. The data store resource name. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}