Class: Google::Apis::CloudsearchV1::ObjectDisplayOptions

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

The display options for an object.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ObjectDisplayOptions

Returns a new instance of ObjectDisplayOptions.



2914
2915
2916
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2914

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

Instance Attribute Details

#metalinesArray<Google::Apis::CloudsearchV1::Metaline>

Defines the properties that are displayed in the metalines of the search results. The property values are displayed in the order given here. If a property holds multiple values, all of the values are displayed before the next properties. For this reason, it is a good practice to specify singular properties before repeated properties in this list. All of the properties must set is_returnable to true. The maximum number of metalines is 3. Corresponds to the JSON property metalines



2904
2905
2906
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2904

def metalines
  @metalines
end

#object_display_labelString

The user friendly label to display in the search result to indicate the type of the item. This is OPTIONAL; if not provided, an object label isn't displayed on the context line of the search results. The maximum length is 64 characters. Corresponds to the JSON property objectDisplayLabel

Returns:

  • (String)


2912
2913
2914
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2912

def object_display_label
  @object_display_label
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2919
2920
2921
2922
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2919

def update!(**args)
  @metalines = args[:metalines] if args.key?(:metalines)
  @object_display_label = args[:object_display_label] if args.key?(:object_display_label)
end