Class: Google::Apis::CloudsearchV1::HtmlOperatorOptions

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

Used to provide a search operator for html 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 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) ⇒ HtmlOperatorOptions

Returns a new instance of HtmlOperatorOptions



1197
1198
1199
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1197

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

Instance Attribute Details

#operator_nameString

Indicates the operator name required in the query in order to isolate the html 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 html 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)


1195
1196
1197
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1195

def operator_name
  @operator_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1202
1203
1204
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1202

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