Class: Google::Apis::CloudsearchV1::HtmlPropertyOptions

Inherits:

Object

• Object
• Google::Apis::CloudsearchV1::HtmlPropertyOptions

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

Options for html properties.

Instance Attribute Summary

• #operator_options ⇒ Google::Apis::CloudsearchV1::HtmlOperatorOptions

  Used to provide a search operator for html properties.

• #retrieval_importance ⇒ Google::Apis::CloudsearchV1::RetrievalImportance

  Indicates the search quality importance of the tokens within the field when used for retrieval.

Instance Method Summary

• #initialize(**args) ⇒ HtmlPropertyOptions constructor

  A new instance of HtmlPropertyOptions.

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

Returns a new instance of HtmlPropertyOptions

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

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

Instance Attribute Details

#operator_options ⇒ Google::Apis::CloudsearchV1::HtmlOperatorOptions

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. Corresponds to the JSON property operatorOptions

Returns:

• (Google::Apis::CloudsearchV1::HtmlOperatorOptions)

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

def operator_options
  @operator_options
end

#retrieval_importance ⇒ Google::Apis::CloudsearchV1::RetrievalImportance

Indicates the search quality importance of the tokens within the field when used for retrieval. Can only be set to DEFAULT or NONE. Corresponds to the JSON property retrievalImportance

Returns:

• (Google::Apis::CloudsearchV1::RetrievalImportance)

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

def retrieval_importance
  @retrieval_importance
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

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

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