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



3495
3496
3497
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3495

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

Instance Attribute Details

#display_nameString

Display name of the operator Corresponds to the JSON property displayName

Returns:

  • (String)


3434
3435
3436
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3434

def display_name
  @display_name
end

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


3440
3441
3442
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3440

def enum_values
  @enum_values
end

#greater_than_operator_nameString

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)


3446
3447
3448
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3446

def greater_than_operator_name
  @greater_than_operator_name
end

#is_facetableBoolean Also known as: is_facetable?

Can this operator be used to get facets. Corresponds to the JSON property isFacetable

Returns:

  • (Boolean)


3451
3452
3453
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3451

def is_facetable
  @is_facetable
end

#is_repeatableBoolean Also known as: is_repeatable?

Indicates if multiple values can be set for this property. Corresponds to the JSON property isRepeatable

Returns:

  • (Boolean)


3457
3458
3459
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3457

def is_repeatable
  @is_repeatable
end

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


3464
3465
3466
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3464

def is_returnable
  @is_returnable
end

#is_sortableBoolean Also known as: is_sortable?

Can this operator be used to sort results. Corresponds to the JSON property isSortable

Returns:

  • (Boolean)


3470
3471
3472
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3470

def is_sortable
  @is_sortable
end

#is_suggestableBoolean Also known as: is_suggestable?

Can get suggestions for this field. Corresponds to the JSON property isSuggestable

Returns:

  • (Boolean)


3476
3477
3478
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3476

def is_suggestable
  @is_suggestable
end

#less_than_operator_nameString

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)


3483
3484
3485
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3483

def less_than_operator_name
  @less_than_operator_name
end

#operator_nameString

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

Returns:

  • (String)


3488
3489
3490
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3488

def operator_name
  @operator_name
end

#typeString

Type of the operator. Corresponds to the JSON property type

Returns:

  • (String)


3493
3494
3495
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3493

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3500

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