Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession

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

External session proto definition.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaSession

Returns a new instance of GoogleCloudDiscoveryengineV1betaSession.



21465
21466
21467
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 21465

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

Instance Attribute Details

#display_name ⇒ String

Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. Corresponds to the JSON property displayName

Returns:

  • (String) 


21425
21426
21427
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 21425

def display_name
  @display_name
end

#end_time ⇒ String

Output only. The time the session finished. Corresponds to the JSON property endTime

Returns:

  • (String) 


21430
21431
21432
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 21430

def end_time
  @end_time
end

#is_pinned ⇒ Boolean Also known as: is_pinned?

Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. Corresponds to the JSON property isPinned

Returns:

  • (Boolean) 


21436
21437
21438
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 21436

def is_pinned
  @is_pinned
end

#name ⇒ String

Immutable. Fully qualified name projects/project/locations/global/ collections/collection/engines/engine/sessions/* Corresponds to the JSON property name

Returns:

  • (String) 


21443
21444
21445
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 21443

def name
  @name
end

#start_time ⇒ String

Output only. The time the session started. Corresponds to the JSON property startTime

Returns:

  • (String) 


21448
21449
21450
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 21448

def start_time
  @start_time
end

#state ⇒ String

The state of the session. Corresponds to the JSON property state

Returns:

  • (String) 


21453
21454
21455
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 21453

def state
  @state
end

#turns ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSessionTurn>

Turns. Corresponds to the JSON property turns

Returns:



21458
21459
21460
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 21458

def turns
  @turns
end

#user_pseudo_id ⇒ String

A unique identifier for tracking users. Corresponds to the JSON property userPseudoId

Returns:

  • (String) 


21463
21464
21465
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 21463

def user_pseudo_id
  @user_pseudo_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



21470
21471
21472
21473
21474
21475
21476
21477
21478
21479
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 21470

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @end_time = args[:end_time] if args.key?(:end_time)
  @is_pinned = args[:is_pinned] if args.key?(:is_pinned)
  @name = args[:name] if args.key?(:name)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
  @turns = args[:turns] if args.key?(:turns)
  @user_pseudo_id = args[:user_pseudo_id] if args.key?(:user_pseudo_id)
end