Class EnumPropertyOptions

The options for enum properties, which allow you to define a restricted set of strings to match user queries, set rankings for those string values, and define an operator name to be paired with those strings so that users can narrow results to only items with a specific value. For example, for items in a request tracking system with priority information, you could define p0 as an allowable enum value and tie this enum to the operator name priority so that search users could add priority:p0 to their query to restrict the set of results to only those items indexed with the value p0.

Inheritance

object

EnumPropertyOptions

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudSearch.v1.Data

Assembly: Google.Apis.CloudSearch.v1.dll

Syntax

public class EnumPropertyOptions : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

OperatorOptions

If set, describes how the enum should be used as a search operator.

Declaration

[JsonProperty("operatorOptions")]
public virtual EnumOperatorOptions OperatorOptions { get; set; }

Property Value

Type	Description
EnumOperatorOptions

OrderedRanking

Used to specify the ordered ranking for the enumeration that determines how the integer values provided in the possible EnumValuePairs are used to rank results. If specified, integer values must be provided for all possible EnumValuePair values given for this property. Can only be used if isRepeatable is false.

Declaration

[JsonProperty("orderedRanking")]
public virtual string OrderedRanking { get; set; }

Property Value

Type	Description
string

PossibleValues

The list of possible values for the enumeration property. All EnumValuePairs must provide a string value. If you specify an integer value for one EnumValuePair, then all possible EnumValuePairs must provide an integer value. Both the string value and integer value must be unique over all possible values. Once set, possible values cannot be removed or modified. If you supply an ordered ranking and think you might insert additional enum values in the future, leave gaps in the initial integer values to allow adding a value in between previously registered values. The maximum number of elements is 100.

Declaration

[JsonProperty("possibleValues")]
public virtual IList<EnumValuePair> PossibleValues { get; set; }

Property Value

Type	Description
IList<EnumValuePair>

Implements

IDirectResponseSchema