Class: Google::Apis::CloudsearchV1::QueryOperator
- Inherits:
-
Object
- Object
- Google::Apis::CloudsearchV1::QueryOperator
- 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 definition of a operator that can be used in a Search/Suggest request.
Instance Attribute Summary collapse
-
#display_name ⇒ String
Display name of the operator Corresponds to the JSON property
displayName. -
#enum_values ⇒ Array<String>
Potential list of values for the opeatror field.
-
#greater_than_operator_name ⇒ String
Indicates the operator name that can be used to isolate the property using the greater-than operator.
-
#is_facetable ⇒ Boolean
(also: #is_facetable?)
Can this operator be used to get facets.
-
#is_repeatable ⇒ Boolean
(also: #is_repeatable?)
Indicates if multiple values can be set for this property.
-
#is_returnable ⇒ Boolean
(also: #is_returnable?)
Will the property associated with this facet be returned as part of search results.
-
#is_sortable ⇒ Boolean
(also: #is_sortable?)
Can this operator be used to sort results.
-
#is_suggestable ⇒ Boolean
(also: #is_suggestable?)
Can get suggestions for this field.
-
#less_than_operator_name ⇒ String
Indicates the operator name that can be used to isolate the property using the less-than operator.
-
#object_type ⇒ String
The name of the object corresponding to the operator.
-
#operator_name ⇒ String
The name of the operator.
-
#type ⇒ String
The type of the operator.
Instance Method Summary collapse
-
#initialize(**args) ⇒ QueryOperator
constructor
A new instance of QueryOperator.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ QueryOperator
Returns a new instance of QueryOperator.
4189 4190 4191 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4189 def initialize(**args) update!(**args) end |
Instance Attribute Details
#display_name ⇒ String
Display name of the operator
Corresponds to the JSON property displayName
4122 4123 4124 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4122 def display_name @display_name end |
#enum_values ⇒ Array<String>
Potential list of values for the opeatror field. This field is only filled
when we can safely enumerate all the possible values of this operator.
Corresponds to the JSON property enumValues
4128 4129 4130 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4128 def enum_values @enum_values end |
#greater_than_operator_name ⇒ String
Indicates the operator name that can be used to isolate the property using the
greater-than operator.
Corresponds to the JSON property greaterThanOperatorName
4134 4135 4136 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4134 def greater_than_operator_name @greater_than_operator_name end |
#is_facetable ⇒ Boolean Also known as: is_facetable?
Can this operator be used to get facets.
Corresponds to the JSON property isFacetable
4139 4140 4141 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4139 def is_facetable @is_facetable end |
#is_repeatable ⇒ Boolean Also known as: is_repeatable?
Indicates if multiple values can be set for this property.
Corresponds to the JSON property isRepeatable
4145 4146 4147 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4145 def is_repeatable @is_repeatable end |
#is_returnable ⇒ Boolean Also known as: is_returnable?
Will the property associated with this facet be returned as part of search
results.
Corresponds to the JSON property isReturnable
4152 4153 4154 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4152 def is_returnable @is_returnable end |
#is_sortable ⇒ Boolean Also known as: is_sortable?
Can this operator be used to sort results.
Corresponds to the JSON property isSortable
4158 4159 4160 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4158 def is_sortable @is_sortable end |
#is_suggestable ⇒ Boolean Also known as: is_suggestable?
Can get suggestions for this field.
Corresponds to the JSON property isSuggestable
4164 4165 4166 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4164 def is_suggestable @is_suggestable end |
#less_than_operator_name ⇒ String
Indicates the operator name that can be used to isolate the property using the
less-than operator.
Corresponds to the JSON property lessThanOperatorName
4171 4172 4173 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4171 def less_than_operator_name @less_than_operator_name end |
#object_type ⇒ String
The name of the object corresponding to the operator. This field is only
filled for schema-specific operators, and is unset for common operators.
Corresponds to the JSON property objectType
4177 4178 4179 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4177 def object_type @object_type end |
#operator_name ⇒ String
The name of the operator.
Corresponds to the JSON property operatorName
4182 4183 4184 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4182 def operator_name @operator_name end |
#type ⇒ String
The type of the operator.
Corresponds to the JSON property type
4187 4188 4189 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4187 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4194 def update!(**args) @display_name = args[:display_name] if args.key?(:display_name) @enum_values = args[:enum_values] if args.key?(:enum_values) @greater_than_operator_name = args[:greater_than_operator_name] if args.key?(:greater_than_operator_name) @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_suggestable = args[:is_suggestable] if args.key?(:is_suggestable) @less_than_operator_name = args[:less_than_operator_name] if args.key?(:less_than_operator_name) @object_type = args[:object_type] if args.key?(:object_type) @operator_name = args[:operator_name] if args.key?(:operator_name) @type = args[:type] if args.key?(:type) end |