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

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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DisplayedProperty

Returns a new instance of DisplayedProperty.



717
718
719
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 717

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

Instance Attribute Details

#property_name ⇒ String

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 is given when attempting to update the schema. Corresponds to the JSON property propertyName

Returns:

  • (String) 


715
716
717
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 715

def property_name
  @property_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



722
723
724
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 722

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