View Source GoogleApi.CloudSearch.V1.Model.EnumValuePair (google_api_cloud_search v0.24.0)

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.

Attributes

  • integerValue (type: integer(), default: nil) - The integer value of the EnumValuePair which must be non-negative. Optional.
  • stringValue (type: String.t, default: nil) - The string value of the EnumValuePair. The maximum length is 32 characters.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.CloudSearch.V1.Model.EnumValuePair{
  integerValue: integer() | nil,
  stringValue: String.t() | nil
}

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.