Class: Google::Apis::CloudsearchV1::PropertyDisplayOptions

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

The display options for a property.

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) ⇒ PropertyDisplayOptions

Returns a new instance of PropertyDisplayOptions



3199
3200
3201
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3199

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

Instance Attribute Details

#display_label ⇒ String

The user friendly label for the property that will be used if the property is specified to be displayed in ObjectDisplayOptions. If given, the display label will be shown in front of the property values when the property is part of the object display options. For example, if the property value is '1', the value by itself may not be useful context for the user. If the display name given was 'priority', then the user will see 'priority : 1' in the search results which provides clear conext to search users. This is OPTIONAL; if not given, only the property values will be displayed. The maximum length is 32 characters. Corresponds to the JSON property displayLabel

Returns:

  • (String) 


3197
3198
3199
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3197

def display_label
  @display_label
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3204
3205
3206
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3204

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