Class: Google::Apis::CloudsearchV1::TextOperatorOptions

Inherits:

Object

• Object
• Google::Apis::CloudsearchV1::TextOperatorOptions

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 text properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.

Instance Attribute Summary

• #exact_match_with_operator ⇒ Boolean (also: #exact_match_with_operator?)

  If true, the text value will be tokenized as one atomic value in operator searches and facet matches.

• #operator_name ⇒ String

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

Instance Method Summary

• #initialize(**args) ⇒ TextOperatorOptions constructor

  A new instance of TextOperatorOptions.

• #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) ⇒ TextOperatorOptions

Returns a new instance of TextOperatorOptions

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

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

Instance Attribute Details

#exact_match_with_operator ⇒ Boolean Also known as: exact_match_with_operator?

If true, the text value will be tokenized as one atomic value in operator searches and facet matches. For example, if the operator name is "genre" and the value is "science-fiction" the query restrictions "genre:science" and "genre:fiction" will not match the item; "genre:science-fiction" will. Value matching is case-sensitive and does not remove special characters. If false, the text will be tokenized. For example, if the value is "science-fiction" the queries "genre:science" and "genre:fiction" will match the item. Corresponds to the JSON property exactMatchWithOperator

Returns:

• (Boolean)

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

def exact_match_with_operator
  @exact_match_with_operator
end

#operator_name ⇒ String

Indicates the operator name required in the query in order to isolate the text property. For example, if operatorName is subject and the property's name is subjectLine, then queries like subject:<value> will show results only where the value of the property named subjectLine 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 text 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 4573

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 4580

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