You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudSearch::Types::IndexField

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing IndexField as input to an Aws::Client method, you can use a vanilla Hash:

{
  index_field_name: "DynamicFieldName", # required
  index_field_type: "int", # required, accepts int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array
  int_options: {
    default_value: 1,
    source_field: "FieldName",
    facet_enabled: false,
    search_enabled: false,
    return_enabled: false,
    sort_enabled: false,
  },
  double_options: {
    default_value: 1.0,
    source_field: "FieldName",
    facet_enabled: false,
    search_enabled: false,
    return_enabled: false,
    sort_enabled: false,
  },
  literal_options: {
    default_value: "FieldValue",
    source_field: "FieldName",
    facet_enabled: false,
    search_enabled: false,
    return_enabled: false,
    sort_enabled: false,
  },
  text_options: {
    default_value: "FieldValue",
    source_field: "FieldName",
    return_enabled: false,
    sort_enabled: false,
    highlight_enabled: false,
    analysis_scheme: "Word",
  },
  date_options: {
    default_value: "FieldValue",
    source_field: "FieldName",
    facet_enabled: false,
    search_enabled: false,
    return_enabled: false,
    sort_enabled: false,
  },
  lat_lon_options: {
    default_value: "FieldValue",
    source_field: "FieldName",
    facet_enabled: false,
    search_enabled: false,
    return_enabled: false,
    sort_enabled: false,
  },
  int_array_options: {
    default_value: 1,
    source_fields: "FieldNameCommaList",
    facet_enabled: false,
    search_enabled: false,
    return_enabled: false,
  },
  double_array_options: {
    default_value: 1.0,
    source_fields: "FieldNameCommaList",
    facet_enabled: false,
    search_enabled: false,
    return_enabled: false,
  },
  literal_array_options: {
    default_value: "FieldValue",
    source_fields: "FieldNameCommaList",
    facet_enabled: false,
    search_enabled: false,
    return_enabled: false,
  },
  text_array_options: {
    default_value: "FieldValue",
    source_fields: "FieldNameCommaList",
    return_enabled: false,
    highlight_enabled: false,
    analysis_scheme: "Word",
  },
  date_array_options: {
    default_value: "FieldValue",
    source_fields: "FieldNameCommaList",
    facet_enabled: false,
    search_enabled: false,
    return_enabled: false,
  },
}

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#date_array_options ⇒ Types::DateArrayOptions

Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is of type date-array. All options are enabled by default.

Returns:

#date_options ⇒ Types::DateOptions

Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.

Returns:

#double_array_options ⇒ Types::DoubleArrayOptions

Options for a field that contains an array of double-precision 64-bit floating point values. Present if IndexFieldType specifies the field is of type double-array. All options are enabled by default.

Returns:

  • (Types::DoubleArrayOptions) —

    Options for a field that contains an array of double-precision 64-bit floating point values.

#double_options ⇒ Types::DoubleOptions

Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.

Returns:

#index_field_name ⇒ String

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.

Returns:

  • (String) —

    A string that represents the name of an index field.

#index_field_type ⇒ String

The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

Possible values:

  • int
  • double
  • literal
  • text
  • date
  • latlon
  • int-array
  • double-array
  • literal-array
  • text-array
  • date-array

Returns:

  • (String) —

    The type of field.

#int_array_options ⇒ Types::IntArrayOptions

Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType specifies the field is of type int-array. All options are enabled by default.

Returns:

#int_options ⇒ Types::IntOptions

Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.

Returns:

#lat_lon_options ⇒ Types::LatLonOptions

Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.

Returns:

#literal_array_options ⇒ Types::LiteralArrayOptions

Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array. All options are enabled by default.

Returns:

#literal_options ⇒ Types::LiteralOptions

Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.

Returns:

#text_array_options ⇒ Types::TextArrayOptions

Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.

Returns:

#text_options ⇒ Types::TextOptions

Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.

Returns: