Class: Google::Apis::CloudsearchV1::QueryOperator

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 definition of a operator that can be used in a Search/Suggest request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ QueryOperator

Returns a new instance of QueryOperator.



4188
4189
4190
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4188

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

Instance Attribute Details

#display_name ⇒ String

Display name of the operator Corresponds to the JSON property displayName

Returns:

  • (String) 


4121
4122
4123
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4121

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

Returns:

  • (Array<String>) 


4127
4128
4129
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4127

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

Returns:

  • (String) 


4133
4134
4135
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4133

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

Returns:

  • (Boolean) 


4138
4139
4140
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4138

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

Returns:

  • (Boolean) 


4144
4145
4146
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4144

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

Returns:

  • (Boolean) 


4151
4152
4153
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4151

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

Returns:

  • (Boolean) 


4157
4158
4159
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4157

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

Returns:

  • (Boolean) 


4163
4164
4165
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4163

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

Returns:

  • (String) 


4170
4171
4172
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4170

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

Returns:

  • (String) 


4176
4177
4178
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4176

def object_type
  @object_type
end

#operator_name ⇒ String

The name of the operator. Corresponds to the JSON property operatorName

Returns:

  • (String) 


4181
4182
4183
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4181

def operator_name
  @operator_name
end

#type ⇒ String

The type of the operator. Corresponds to the JSON property type

Returns:

  • (String) 


4186
4187
4188
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4186

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4193

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