Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPanelInfo

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

Detailed panel information associated with a user event.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaPanelInfo

Returns a new instance of GoogleCloudDiscoveryengineV1betaPanelInfo.



17795
17796
17797
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17795

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) 


17771
17772
17773
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17771

def display_name
  @display_name
end

#documents ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentInfo>

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

Returns:



17776
17777
17778
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17776

def documents
  @documents
end

#panel_id ⇒ String

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

Returns:

  • (String) 


17781
17782
17783
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17781

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) 


17787
17788
17789
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17787

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) 


17793
17794
17795
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17793

def total_panels
  @total_panels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



17800
17801
17802
17803
17804
17805
17806
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17800

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