Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PanelInfo

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

Detailed panel information associated with a user event.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1PanelInfo

Returns a new instance of GoogleCloudDiscoveryengineV1PanelInfo.



6141
6142
6143
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6141

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) 


6117
6118
6119
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6117

def display_name
  @display_name
end

#documents ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentInfo>

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

Returns:



6122
6123
6124
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6122

def documents
  @documents
end

#panel_id ⇒ String

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

Returns:

  • (String) 


6127
6128
6129
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6127

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) 


6133
6134
6135
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6133

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) 


6139
6140
6141
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6139

def total_panels
  @total_panels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6146
6147
6148
6149
6150
6151
6152
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6146

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