Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session

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

Overview

External session proto definition.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1Session

Returns a new instance of GoogleCloudDiscoveryengineV1Session.



9791
9792
9793
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9791

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) 


9751
9752
9753
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9751

def display_name
  @display_name
end

#end_time ⇒ String

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

Returns:

  • (String) 


9756
9757
9758
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9756

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) 


9762
9763
9764
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9762

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) 


9769
9770
9771
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9769

def name
  @name
end

#start_time ⇒ String

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

Returns:

  • (String) 


9774
9775
9776
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9774

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


9779
9780
9781
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9779

def state
  @state
end

#turns ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SessionTurn>

Turns. Corresponds to the JSON property turns

Returns:



9784
9785
9786
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9784

def turns
  @turns
end

#user_pseudo_id ⇒ String

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

Returns:

  • (String) 


9789
9790
9791
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9789

def user_pseudo_id
  @user_pseudo_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9796

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