class Google::Apis::CloudsearchV1::TextOperatorOptions

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.

Attributes

exact_match_with_operator[RW]

If true, the text value is 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” doesn't match the item; “genre:science-fiction” does. Value matching is case- sensitive and does not remove special characters. If false, the text is tokenized. For example, if the value is “science-fiction” the queries “genre: science” and “genre:fiction” matches the item. Corresponds to the JSON property `exactMatchWithOperator` @return [Boolean]

exact_match_with_operator?[RW]

If true, the text value is 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” doesn't match the item; “genre:science-fiction” does. Value matching is case- sensitive and does not remove special characters. If false, the text is tokenized. For example, if the value is “science-fiction” the queries “genre: science” and “genre:fiction” matches the item. Corresponds to the JSON property `exactMatchWithOperator` @return [Boolean]

operator_name[RW]

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>* 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 returns 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` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/cloudsearch_v1/classes.rb, line 4822
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/cloudsearch_v1/classes.rb, line 4827
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