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.



16029
16030
16031
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16029

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) 


15962
15963
15964
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15962

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


15968
15969
15970
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15968

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) 


15974
15975
15976
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15974

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) 


15979
15980
15981
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15979

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) 


15985
15986
15987
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15985

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) 


15992
15993
15994
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15992

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) 


15998
15999
16000
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15998

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) 


16004
16005
16006
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16004

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) 


16011
16012
16013
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16011

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) 


16017
16018
16019
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16017

def object_type
  @object_type
end

#operator_name ⇒ String

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

Returns:

  • (String) 


16022
16023
16024
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16022

def operator_name
  @operator_name
end

#type ⇒ String

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

Returns:

  • (String) 


16027
16028
16029
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16027

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



16034
16035
16036
16037
16038
16039
16040
16041
16042
16043
16044
16045
16046
16047
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 16034

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