Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSession

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

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSession.



16940
16941
16942
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 16940

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) 


16900
16901
16902
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 16900

def display_name
  @display_name
end

#end_time ⇒ String

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

Returns:

  • (String) 


16905
16906
16907
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 16905

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) 


16911
16912
16913
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 16911

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) 


16918
16919
16920
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 16918

def name
  @name
end

#start_time ⇒ String

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

Returns:

  • (String) 


16923
16924
16925
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 16923

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


16928
16929
16930
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 16928

def state
  @state
end

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

Turns. Corresponds to the JSON property turns

Returns:



16933
16934
16935
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 16933

def turns
  @turns
end

#user_pseudo_id ⇒ String

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

Returns:

  • (String) 


16938
16939
16940
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 16938

def user_pseudo_id
  @user_pseudo_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



16945
16946
16947
16948
16949
16950
16951
16952
16953
16954
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 16945

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