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

Inherits:

Object

• Object
• Google::Apis::CloudsearchV1::ObjectDisplayOptions

Includes:

Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport

Defined in:

generated/google/apis/cloudsearch_v1/classes.rb,
generated/google/apis/cloudsearch_v1/representations.rb,
generated/google/apis/cloudsearch_v1/representations.rb

Overview

The display options for an object.

Instance Attribute Summary

• #metalines ⇒ Array<Google::Apis::CloudsearchV1::Metaline>

  Defines the properties that will be displayed in the metalines of the search results.

• #object_display_label ⇒ String

  The user friendly label to display in the search result to inidicate the type of the item.

Instance Method Summary

• #initialize(**args) ⇒ ObjectDisplayOptions constructor

  A new instance of ObjectDisplayOptions.

• #update!(**args) ⇒ Object

  Update properties of this object.

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ObjectDisplayOptions

Returns a new instance of ObjectDisplayOptions

# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2438

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

Instance Attribute Details

#metalines ⇒ Array<Google::Apis::CloudsearchV1::Metaline>

Defines the properties that will be displayed in the metalines of the search results. The property values will be displayed in the order given here. If a property holds multiple values, all of the values will be diplayed 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

Returns:

• (Array<Google::Apis::CloudsearchV1::Metaline>)

# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2428

def metalines
  @metalines
end

#object_display_label ⇒ String

The user friendly label to display in the search result to inidicate the type of the item. This is OPTIONAL; if not given, an object label will not be displayed on the context line of the search results. The maximum length is 32 characters. Corresponds to the JSON property objectDisplayLabel

Returns:

• (String)

# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2436

def object_display_label
  @object_display_label
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2443

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