Class: Google::Apis::CloudsearchV1::DisplayedProperty

Inherits:
Object
  • Object
show all
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

A reference to a top-level property within the object that should be displayed in search results. The values of the chosen properties will be displayed in the search results along with the dislpay label for that property if one is specified. If a display label is not specified, only the values will be shown.

Instance Attribute Summary collapse

Instance Method Summary collapse

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

#to_json

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

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ DisplayedProperty

Returns a new instance of DisplayedProperty



492
493
494
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 492

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

Instance Attribute Details

#property_nameString

The name of the top-level property as defined in a property definition for the object. If the name is not a defined property in the schema, an error will be given when attempting to update the schema. Corresponds to the JSON property propertyName

Returns:

  • (String)


490
491
492
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 490

def property_name
  @property_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



497
498
499
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 497

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