Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPanelInfo

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

Detailed panel information associated with a user event.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaPanelInfo

Returns a new instance of GoogleCloudDiscoveryengineV1alphaPanelInfo.



12699
12700
12701
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 12699

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#display_name ⇒ String

The display name of the panel. Corresponds to the JSON property displayName

Returns:

  • (String) 


12675
12676
12677
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 12675

def display_name
  @display_name
end

#documents ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentInfo>

Optional. The document IDs associated with this panel. Corresponds to the JSON property documents

Returns:



12680
12681
12682
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 12680

def documents
  @documents
end

#panel_id ⇒ String

Required. The panel ID. Corresponds to the JSON property panelId

Returns:

  • (String) 


12685
12686
12687
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 12685

def panel_id
  @panel_id
end

#panel_position ⇒ Fixnum

The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set. Corresponds to the JSON property panelPosition

Returns:

  • (Fixnum) 


12691
12692
12693
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 12691

def panel_position
  @panel_position
end

#total_panels ⇒ Fixnum

The total number of panels, including this one, shown to the user. Must be set if panel_position is set. Corresponds to the JSON property totalPanels

Returns:

  • (Fixnum) 


12697
12698
12699
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 12697

def total_panels
  @total_panels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12704
12705
12706
12707
12708
12709
12710
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 12704

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @documents = args[:documents] if args.key?(:documents)
  @panel_id = args[:panel_id] if args.key?(:panel_id)
  @panel_position = args[:panel_position] if args.key?(:panel_position)
  @total_panels = args[:total_panels] if args.key?(:total_panels)
end