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.



4007
4008
4009
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4007

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) 


3940
3941
3942
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3940

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


3946
3947
3948
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3946

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) 


3952
3953
3954
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3952

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) 


3957
3958
3959
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3957

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) 


3963
3964
3965
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3963

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) 


3970
3971
3972
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3970

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) 


3976
3977
3978
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3976

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) 


3982
3983
3984
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3982

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) 


3989
3990
3991
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3989

def less_than_operator_name
  @less_than_operator_name
end

#object_type ⇒ String

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) 


3995
3996
3997
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3995

def object_type
  @object_type
end

#operator_name ⇒ String

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

Returns:

  • (String) 


4000
4001
4002
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4000

def operator_name
  @operator_name
end

#type ⇒ String

Type of the operator. Corresponds to the JSON property type

Returns:

  • (String) 


4005
4006
4007
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4005

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4012

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