Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession

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

External session proto definition.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaSession

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSession.



17060
17061
17062
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 17060

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) 


17020
17021
17022
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 17020

def display_name
  @display_name
end

#end_time ⇒ String

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

Returns:

  • (String) 


17025
17026
17027
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 17025

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) 


17031
17032
17033
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 17031

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) 


17038
17039
17040
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 17038

def name
  @name
end

#start_time ⇒ String

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

Returns:

  • (String) 


17043
17044
17045
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 17043

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


17048
17049
17050
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 17048

def state
  @state
end

#turns ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSessionTurn>

Turns. Corresponds to the JSON property turns

Returns:



17053
17054
17055
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 17053

def turns
  @turns
end

#user_pseudo_id ⇒ String

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

Returns:

  • (String) 


17058
17059
17060
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 17058

def user_pseudo_id
  @user_pseudo_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



17065
17066
17067
17068
17069
17070
17071
17072
17073
17074
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 17065

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