Class: Google::Apis::CloudsearchV1::EnumValuePair

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

The enumeration value pair defines two things: a required string value and an optional integer value. The string value defines the necessary query term required to retrieve that item, such as p0 for a priority item. The integer value determines the ranking of that string value relative to other enumerated values for the same property. For example, you might associate p0 with 0 and define another enum pair such as p1 and 1. You must use the integer value in combination with ordered ranking to set the ranking of a given value relative to other enumerated values for the same property name. Here, a ranking order of DESCENDING for priority properties results in a ranking boost for items indexed with a value of p0 compared to items indexed with a value of p1. Without a specified ranking order, the integer value has no effect on item ranking.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EnumValuePair

Returns a new instance of EnumValuePair.



965
966
967
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 965

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

Instance Attribute Details

#integer_value ⇒ Fixnum

The integer value of the EnumValuePair which must be non-negative. Optional. Corresponds to the JSON property integerValue

Returns:

  • (Fixnum) 


958
959
960
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 958

def integer_value
  @integer_value
end

#string_value ⇒ String

The string value of the EnumValuePair. The maximum length is 32 characters. Corresponds to the JSON property stringValue

Returns:

  • (String) 


963
964
965
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 963

def string_value
  @string_value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



970
971
972
973
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 970

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