Class: Google::Apis::CloudsearchV1::EnumOperatorOptions

Inherits:

Object

• Object
• Google::Apis::CloudsearchV1::EnumOperatorOptions

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

Used to provide a search operator for enum properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. For example, if you provide no operator for a priority enum property with possible values p0 and p1, a query that contains the term p0 will return items that have p0 as the value of the priority property, as well as any items that contain the string p0 in other fields. If you provide an operator name for the enum, such as priority, then search users can use that operator to refine results to only items that have p0 as this property's value, with the query priority:p0.

Instance Attribute Summary

• #operator_name ⇒ String

  Indicates the operator name required in the query in order to isolate the enum property.

Instance Method Summary

• #initialize(**args) ⇒ EnumOperatorOptions constructor

  A new instance of EnumOperatorOptions.

• #update!(**args) ⇒ Object

  Update properties of this object.

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ EnumOperatorOptions

Returns a new instance of EnumOperatorOptions

# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 688

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

Instance Attribute Details

#operator_name ⇒ String

Indicates the operator name required in the query in order to isolate the enum property. For example, if operatorName is priority and the property's name is priorityVal, then queries like priority:<value> will show results only where the value of the property named priorityVal matches <value>. By contrast, a search that uses the same <value> without an operator will return all items where <value> matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters. Corresponds to the JSON property operatorName

Returns:

• (String)

# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 686

def operator_name
  @operator_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 693

def update!(**args)
  @operator_name = args[:operator_name] if args.key?(:operator_name)
end