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.



33498
33499
33500
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 33498

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) 


33445
33446
33447
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 33445

def display_name
  @display_name
end

#end_time ⇒ String

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

Returns:

  • (String) 


33450
33451
33452
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 33450

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) 


33456
33457
33458
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 33456

def is_pinned
  @is_pinned
end

#labels ⇒ Array<String>

Optional. The labels for the session. Can be set as filter in ListSessionsRequest. Corresponds to the JSON property labels

Returns:

  • (Array<String>) 


33463
33464
33465
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 33463

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


33469
33470
33471
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 33469

def name
  @name
end

#pending_async_assist_operation_id ⇒ String

Output only. Full resource name of an in-progress AsyncAssist operation for this session, e.g. projects/*/locations/*/collections/*/engines/*/sessions/*/ operations/*. Set when the operation starts and cleared when it finishes. Corresponds to the JSON property pendingAsyncAssistOperationId

Returns:

  • (String) 


33476
33477
33478
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 33476

def pending_async_assist_operation_id
  @pending_async_assist_operation_id
end

#start_time ⇒ String

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

Returns:

  • (String) 


33481
33482
33483
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 33481

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


33486
33487
33488
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 33486

def state
  @state
end

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

Turns. Corresponds to the JSON property turns

Returns:



33491
33492
33493
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 33491

def turns
  @turns
end

#user_pseudo_id ⇒ String

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

Returns:

  • (String) 


33496
33497
33498
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 33496

def user_pseudo_id
  @user_pseudo_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



33503
33504
33505
33506
33507
33508
33509
33510
33511
33512
33513
33514
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 33503

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)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @pending_async_assist_operation_id = args[:pending_async_assist_operation_id] if args.key?(:pending_async_assist_operation_id)
  @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