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.



4051
4052
4053
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4051

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

Instance Attribute Details

#display_nameString

Display name of the operator Corresponds to the JSON property displayName

Returns:

  • (String)


3984
3985
3986
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3984

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


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

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)


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

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)


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

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)


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

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)


4014
4015
4016
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4014

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)


4020
4021
4022
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4020

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)


4026
4027
4028
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4026

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)


4033
4034
4035
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4033

def less_than_operator_name
  @less_than_operator_name
end

#object_typeString

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)


4039
4040
4041
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4039

def object_type
  @object_type
end

#operator_nameString

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

Returns:

  • (String)


4044
4045
4046
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4044

def operator_name
  @operator_name
end

#typeString

Type of the operator. Corresponds to the JSON property type

Returns:

  • (String)


4049
4050
4051
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4049

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4056

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