Class: Google::Apis::CloudsearchV1::ContextAttribute

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudsearch_v1/classes.rb,
lib/google/apis/cloudsearch_v1/representations.rb,
lib/google/apis/cloudsearch_v1/representations.rb

Overview

A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ContextAttribute

Returns a new instance of ContextAttribute.



184
185
186
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 184

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

Instance Attribute Details

#nameString

The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A- Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched. Corresponds to the JSON property name

Returns:

  • (String)


175
176
177
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 175

def name
  @name
end

#valuesArray<String>

Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched. Corresponds to the JSON property values

Returns:

  • (Array<String>)


182
183
184
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 182

def values
  @values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



189
190
191
192
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 189

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