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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
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 operator that can be used in a Search/Suggest request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ QueryOperator

Returns a new instance of QueryOperator



3249
3250
3251
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3249

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) 


3188
3189
3190
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3188

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>) 


3194
3195
3196
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3194

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) 


3200
3201
3202
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3200

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) 


3205
3206
3207
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3205

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) 


3211
3212
3213
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3211

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) 


3218
3219
3220
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3218

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) 


3224
3225
3226
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3224

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) 


3230
3231
3232
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3230

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) 


3237
3238
3239
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3237

def less_than_operator_name
  @less_than_operator_name
end

#operator_name ⇒ String

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

Returns:

  • (String) 


3242
3243
3244
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3242

def operator_name
  @operator_name
end

#type ⇒ String

Type of the operator. Corresponds to the JSON property type

Returns:

  • (String) 


3247
3248
3249
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3247

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3254

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)
  @operator_name = args[:operator_name] if args.key?(:operator_name)
  @type = args[:type] if args.key?(:type)
end