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

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 a property.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PropertyDisplayOptions

Returns a new instance of PropertyDisplayOptions.



3144
3145
3146
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3144

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

Instance Attribute Details

#display_label ⇒ String

The user friendly label for the property that is used if the property is specified to be displayed in ObjectDisplayOptions. If provided, the display label is 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 sees 'priority : 1' in the search results which provides clear context to search users. This is OPTIONAL; if not given, only the property values are displayed. The maximum length is 64 characters. Corresponds to the JSON property displayLabel

Returns:

  • (String) 


3142
3143
3144
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3142

def display_label
  @display_label
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3149
3150
3151
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3149

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