NAME

Paws::CloudSearch::IndexField

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::CloudSearch::IndexField object:

$service_obj->Method(Att1 => { DateArrayOptions => $value, ..., TextOptions => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::CloudSearch::IndexField object:

$result = $service_obj->Method(...);
$result->Att1->DateArrayOptions

DESCRIPTION

Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType.

ATTRIBUTES

DateArrayOptions => Paws::CloudSearch::DateArrayOptions

DateOptions => Paws::CloudSearch::DateOptions

DoubleArrayOptions => Paws::CloudSearch::DoubleArrayOptions

DoubleOptions => Paws::CloudSearch::DoubleOptions

REQUIRED IndexFieldName => Str

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.