Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListSessionsRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/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.



12392
12393
12394
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 12392

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

Instance Attribute Details

#filter ⇒ String

A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" Corresponds to the JSON property filter

Returns:

  • (String) 


12363
12364
12365
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 12363

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 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) 


12372
12373
12374
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 12372

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) 


12378
12379
12380
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 12378

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) 


12384
12385
12386
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 12384

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) 


12390
12391
12392
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 12390

def parent
  @parent
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12397
12398
12399
12400
12401
12402
12403
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 12397

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