Class: Google::Apis::CloudsearchV1::PropertyDisplayOptions
- Inherits:
-
Object
- Object
- Google::Apis::CloudsearchV1::PropertyDisplayOptions
- 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
-
#display_label ⇒ String
The user friendly label for the property that will be used if the property is specified to be displayed in ObjectDisplayOptions.
Instance Method Summary collapse
-
#initialize(**args) ⇒ PropertyDisplayOptions
constructor
A new instance of PropertyDisplayOptions.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ PropertyDisplayOptions
Returns a new instance of PropertyDisplayOptions
2979 2980 2981 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2979 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
2977 2978 2979 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2977 def display_label @display_label end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2984 2985 2986 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2984 def update!(**args) @display_label = args[:display_label] if args.key?(:display_label) end |