Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaListSessionsRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1beta/classes.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb

Overview

Request for ListSessions method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaListSessionsRequest

Returns a new instance of GoogleCloudDiscoveryengineV1alphaListSessionsRequest.



13609
13610
13611
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 13609

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#filter ⇒ 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" Corresponds to the JSON property filter

Returns:

  • (String) 


13580
13581
13582
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 13580

def filter
  @filter
end

#order_by ⇒ 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. Corresponds to the JSON property orderBy

Returns:

  • (String) 


13589
13590
13591
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 13589

def order_by
  @order_by
end

#page_size ⇒ Fixnum

Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


13595
13596
13597
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 13595

def page_size
  @page_size
end

#page_token ⇒ String

A page token, received from a previous ListSessions call. Provide this to retrieve the subsequent page. Corresponds to the JSON property pageToken

Returns:

  • (String) 


13601
13602
13603
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 13601

def page_token
  @page_token
end

#parent ⇒ String

Required. The data store resource name. Format: projects/project/locations/ location/collections/collection/dataStores/data_store_id` Corresponds to the JSON propertyparent`

Returns:

  • (String) 


13607
13608
13609
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 13607

def parent
  @parent
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13614
13615
13616
13617
13618
13619
13620
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 13614

def update!(**args)
  @filter = args[:filter] if args.key?(:filter)
  @order_by = args[:order_by] if args.key?(:order_by)
  @page_size = args[:page_size] if args.key?(:page_size)
  @page_token = args[:page_token] if args.key?(:page_token)
  @parent = args[:parent] if args.key?(:parent)
end