Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSession

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

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSession.



17583
17584
17585
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17583

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) 


17530
17531
17532
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17530

def display_name
  @display_name
end

#end_time ⇒ String

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

Returns:

  • (String) 


17535
17536
17537
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17535

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) 


17541
17542
17543
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17541

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


17548
17549
17550
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17548

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) 


17554
17555
17556
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17554

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) 


17561
17562
17563
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17561

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) 


17566
17567
17568
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17566

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


17571
17572
17573
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17571

def state
  @state
end

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

Turns. Corresponds to the JSON property turns

Returns:



17576
17577
17578
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17576

def turns
  @turns
end

#user_pseudo_id ⇒ String

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

Returns:

  • (String) 


17581
17582
17583
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17581

def user_pseudo_id
  @user_pseudo_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



17588
17589
17590
17591
17592
17593
17594
17595
17596
17597
17598
17599
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17588

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