Class: Google::Apis::CloudsearchV1::PropertyDefinition
- Inherits:
-
Object
- Object
- Google::Apis::CloudsearchV1::PropertyDefinition
- 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 definition of a property within an object.
Instance Attribute Summary collapse
-
#boolean_property_options ⇒ Google::Apis::CloudsearchV1::BooleanPropertyOptions
Options for boolean properties.
-
#date_property_options ⇒ Google::Apis::CloudsearchV1::DatePropertyOptions
Options for date properties.
-
#display_options ⇒ Google::Apis::CloudsearchV1::PropertyDisplayOptions
The display options for a property.
-
#double_property_options ⇒ Google::Apis::CloudsearchV1::DoublePropertyOptions
Options for double properties.
-
#enum_property_options ⇒ Google::Apis::CloudsearchV1::EnumPropertyOptions
Options for enum properties, which allow you to define a restricted set of strings to match user queries, set rankings for those string values, and define an operator name to be paired with those strings so that users can narrow results to only items with a specific value.
-
#html_property_options ⇒ Google::Apis::CloudsearchV1::HtmlPropertyOptions
Options for html properties.
-
#integer_property_options ⇒ Google::Apis::CloudsearchV1::IntegerPropertyOptions
Options for integer properties.
-
#is_facetable ⇒ Boolean
(also: #is_facetable?)
Indicates that the property can be used for generating facets.
-
#is_repeatable ⇒ Boolean
(also: #is_repeatable?)
Indicates that multiple values are allowed for the property.
-
#is_returnable ⇒ Boolean
(also: #is_returnable?)
Indicates that the property identifies data that should be returned in search results via the Query API.
-
#is_sortable ⇒ Boolean
(also: #is_sortable?)
Indicates that the property can be used for sorting.
-
#is_wildcard_searchable ⇒ Boolean
(also: #is_wildcard_searchable?)
Indicates that users can perform wildcard search for this property.
-
#name ⇒ String
The name of the property.
-
#object_property_options ⇒ Google::Apis::CloudsearchV1::ObjectPropertyOptions
Options for object properties.
-
#text_property_options ⇒ Google::Apis::CloudsearchV1::TextPropertyOptions
Options for text properties.
-
#timestamp_property_options ⇒ Google::Apis::CloudsearchV1::TimestampPropertyOptions
Options for timestamp properties.
Instance Method Summary collapse
-
#initialize(**args) ⇒ PropertyDefinition
constructor
A new instance of PropertyDefinition.
-
#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) ⇒ PropertyDefinition
Returns a new instance of PropertyDefinition
2937 2938 2939 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2937 def initialize(**args) update!(**args) end |
Instance Attribute Details
#boolean_property_options ⇒ Google::Apis::CloudsearchV1::BooleanPropertyOptions
Options for boolean properties.
Corresponds to the JSON property booleanPropertyOptions
2817 2818 2819 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2817 def @boolean_property_options end |
#date_property_options ⇒ Google::Apis::CloudsearchV1::DatePropertyOptions
Options for date properties.
Corresponds to the JSON property datePropertyOptions
2822 2823 2824 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2822 def @date_property_options end |
#display_options ⇒ Google::Apis::CloudsearchV1::PropertyDisplayOptions
The display options for a property.
Corresponds to the JSON property displayOptions
2827 2828 2829 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2827 def @display_options end |
#double_property_options ⇒ Google::Apis::CloudsearchV1::DoublePropertyOptions
Options for double properties.
Corresponds to the JSON property doublePropertyOptions
2832 2833 2834 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2832 def @double_property_options end |
#enum_property_options ⇒ Google::Apis::CloudsearchV1::EnumPropertyOptions
Options for enum properties, which allow you to define a restricted set of
strings to match user queries, set rankings for those string values, and
define an operator name to be paired with those strings so that users can
narrow results to only items with a specific value. For example, for items in
a request tracking system with priority information, you could define p0 as
an allowable enum value and tie this enum to the operator name priority so
that search users could add priority:p0 to their query to restrict the set
of results to only those items indexed with the value p0.
Corresponds to the JSON property enumPropertyOptions
2844 2845 2846 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2844 def @enum_property_options end |
#html_property_options ⇒ Google::Apis::CloudsearchV1::HtmlPropertyOptions
Options for html properties.
Corresponds to the JSON property htmlPropertyOptions
2849 2850 2851 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2849 def @html_property_options end |
#integer_property_options ⇒ Google::Apis::CloudsearchV1::IntegerPropertyOptions
Options for integer properties.
Corresponds to the JSON property integerPropertyOptions
2854 2855 2856 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2854 def @integer_property_options end |
#is_facetable ⇒ Boolean Also known as: is_facetable?
Indicates that the property can be used for generating facets. Cannot be
true for properties whose type is object. IsReturnable must be true to set
this option.
Only supported for Boolean, Enum, and Text properties.
Corresponds to the JSON property isFacetable
2862 2863 2864 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2862 def is_facetable @is_facetable end |
#is_repeatable ⇒ Boolean Also known as: is_repeatable?
Indicates that multiple values are allowed for the property. For example, a
document only has one description but can have multiple comments. Cannot be
true for properties whose type is a boolean.
If set to false, properties that contain more than one value will cause the
indexing request for that item to be rejected.
Corresponds to the JSON property isRepeatable
2872 2873 2874 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2872 def is_repeatable @is_repeatable end |
#is_returnable ⇒ Boolean Also known as: is_returnable?
Indicates that the property identifies data that should be returned in
search results via the Query API. If set to true, indicates that Query
API users can use matching property fields in results. However, storing
fields requires more space allocation and uses more bandwidth for search
queries, which impacts performance over large datasets. Set to true here
only if the field is needed for search results. Cannot be true for
properties whose type is an object.
Corresponds to the JSON property isReturnable
2884 2885 2886 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2884 def is_returnable @is_returnable end |
#is_sortable ⇒ Boolean Also known as: is_sortable?
Indicates that the property can be used for sorting. Cannot be true for
properties that are repeatable. Cannot be true for properties whose type
is object or user identifier. IsReturnable must be true to set this option.
Only supported for Boolean, Date, Double, Integer, and Timestamp
properties.
Corresponds to the JSON property isSortable
2894 2895 2896 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2894 def is_sortable @is_sortable end |
#is_wildcard_searchable ⇒ Boolean Also known as: is_wildcard_searchable?
Indicates that users can perform wildcard search for this
property. Only supported for Text properties. IsReturnable must be true to
set this option. In a given datasource maximum of 5 properties can be
marked as is_wildcard_searchable.
Note: This is an alpha feature and is enabled for whitelisted users only.
Corresponds to the JSON property isWildcardSearchable
2904 2905 2906 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2904 def is_wildcard_searchable @is_wildcard_searchable end |
#name ⇒ String
The name of the property. Item indexing requests sent to the Indexing API
should set the property name
equal to this value. For example, if name is subject_line, then indexing
requests for document items with subject fields should set the
name for that field equal to
subject_line. Use the name as the identifier for the object property.
Once registered as a property for an object, you cannot re-use this name
for another property within that object.
The name must start with a letter and can only contain letters (A-Z, a-z)
or numbers (0-9).
The maximum length is 256 characters.
Corresponds to the JSON property name
2920 2921 2922 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2920 def name @name end |
#object_property_options ⇒ Google::Apis::CloudsearchV1::ObjectPropertyOptions
Options for object properties.
Corresponds to the JSON property objectPropertyOptions
2925 2926 2927 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2925 def @object_property_options end |
#text_property_options ⇒ Google::Apis::CloudsearchV1::TextPropertyOptions
Options for text properties.
Corresponds to the JSON property textPropertyOptions
2930 2931 2932 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2930 def @text_property_options end |
#timestamp_property_options ⇒ Google::Apis::CloudsearchV1::TimestampPropertyOptions
Options for timestamp properties.
Corresponds to the JSON property timestampPropertyOptions
2935 2936 2937 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2935 def @timestamp_property_options end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2942 def update!(**args) @boolean_property_options = args[:boolean_property_options] if args.key?(:boolean_property_options) @date_property_options = args[:date_property_options] if args.key?(:date_property_options) @display_options = args[:display_options] if args.key?(:display_options) @double_property_options = args[:double_property_options] if args.key?(:double_property_options) @enum_property_options = args[:enum_property_options] if args.key?(:enum_property_options) @html_property_options = args[:html_property_options] if args.key?(:html_property_options) @integer_property_options = args[:integer_property_options] if args.key?(:integer_property_options) @is_facetable = args[:is_facetable] if args.key?(:is_facetable) @is_repeatable = args[:is_repeatable] if args.key?(:is_repeatable) @is_returnable = args[:is_returnable] if args.key?(:is_returnable) @is_sortable = args[:is_sortable] if args.key?(:is_sortable) @is_wildcard_searchable = args[:is_wildcard_searchable] if args.key?(:is_wildcard_searchable) @name = args[:name] if args.key?(:name) @object_property_options = args[:object_property_options] if args.key?(:object_property_options) @text_property_options = args[:text_property_options] if args.key?(:text_property_options) @timestamp_property_options = args[:timestamp_property_options] if args.key?(:timestamp_property_options) end |