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



3092
3093
3094
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3092

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

Instance Attribute Details

#display_nameString

Display name of the operator Corresponds to the JSON property displayName

Returns:

  • (String)


3031
3032
3033
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3031

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


3037
3038
3039
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3037

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)


3043
3044
3045
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3043

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)


3048
3049
3050
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3048

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)


3054
3055
3056
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3054

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)


3061
3062
3063
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3061

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)


3067
3068
3069
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3067

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)


3073
3074
3075
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3073

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)


3080
3081
3082
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3080

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)


3085
3086
3087
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3085

def operator_name
  @operator_name
end

#typeString

Type of the operator. Corresponds to the JSON property type

Returns:

  • (String)


3090
3091
3092
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3090

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3097

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