Class: Google::Apis::CloudsearchV1::EnterpriseTopazSidekickCardMetadata

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudsearch_v1/classes.rb,
lib/google/apis/cloudsearch_v1/representations.rb,
lib/google/apis/cloudsearch_v1/representations.rb

Overview

Card metadata.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EnterpriseTopazSidekickCardMetadata

Returns a new instance of EnterpriseTopazSidekickCardMetadata.



1786
1787
1788
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1786

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

Instance Attribute Details

#card_category ⇒ String

Declares a preference for how this card should be packed in MSCR. All cards in a response must correspond to a single category. As a result, cards may be dropped from the response if this field is set. Any card that does not match the category of the card with the highest priority in the response will be dropped. Corresponds to the JSON property cardCategory

Returns:

  • (String) 


1748
1749
1750
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1748

def card_category
  @card_category
end

#card_id ⇒ String

An ID to identify the card and match actions to it. Be thoughtful of new card IDs since actions will be associated to that ID. E.g., if two card IDs collide, the system will think that the actions have been applied to the same card. Similarly, if EAS can return multiple cards of the same type (e.g., Meetings), ensure that the card_id identifies a given instance of the card so that, e.g., dismissals only affect the dismissed card as opposed to affecting all meeting cards. Corresponds to the JSON property cardId

Returns:

  • (String) 


1759
1760
1761
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1759

def card_id
  @card_id
end

#chronology ⇒ String

Chronology. Corresponds to the JSON property chronology

Returns:

  • (String) 


1764
1765
1766
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1764

def chronology
  @chronology
end

#debug_info ⇒ String

Debug info (only reported if request's debug_level > 0). Corresponds to the JSON property debugInfo

Returns:

  • (String) 


1769
1770
1771
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1769

def debug_info
  @debug_info
end

#nlp_metadata ⇒ Google::Apis::CloudsearchV1::EnterpriseTopazSidekickNlpMetadata

Metadata about the NLP interpretation of the query. Corresponds to the JSON property nlpMetadata

Returns:



1774
1775
1776
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1774

def nlp_metadata
  @nlp_metadata
end

#ranking_params ⇒ Google::Apis::CloudsearchV1::EnterpriseTopazSidekickRankingParams

Ranking params. Corresponds to the JSON property rankingParams

Returns:



1779
1780
1781
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1779

def ranking_params
  @ranking_params
end

#render_mode ⇒ String

Render mode. Corresponds to the JSON property renderMode

Returns:

  • (String) 


1784
1785
1786
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1784

def render_mode
  @render_mode
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1791
1792
1793
1794
1795
1796
1797
1798
1799
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1791

def update!(**args)
  @card_category = args[:card_category] if args.key?(:card_category)
  @card_id = args[:card_id] if args.key?(:card_id)
  @chronology = args[:chronology] if args.key?(:chronology)
  @debug_info = args[:debug_info] if args.key?(:debug_info)
  @nlp_metadata = args[:nlp_metadata] if args.key?(:nlp_metadata)
  @ranking_params = args[:ranking_params] if args.key?(:ranking_params)
  @render_mode = args[:render_mode] if args.key?(:render_mode)
end