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

Inherits:

Struct

Object
Struct
Aws::CloudSearch::Types::IndexField

show all

Includes:: Structure

Defined in:: lib/aws-sdk-cloudsearch/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#date_array_options ⇒ Types::DateArrayOptions

Options for a field that contains an array of dates.
#date_options ⇒ Types::DateOptions

Options for a date field.
#double_array_options ⇒ 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.
#index_field_name ⇒ String

A string that represents the name of an index field.
#index_field_type ⇒ String

The type of field.
#int_array_options ⇒ Types::IntArrayOptions

Options for a field that contains an array of 64-bit signed integers.
#int_options ⇒ Types::IntOptions

Options for a 64-bit signed integer field.
#lat_lon_options ⇒ Types::LatLonOptions

Options for a latlon field.
#literal_array_options ⇒ Types::LiteralArrayOptions

Options for a field that contains an array of literal strings.
#literal_options ⇒ Types::LiteralOptions

Options for literal field.
#text_array_options ⇒ Types::TextArrayOptions

Options for a field that contains an array of text strings.
#text_options ⇒ Types::TextOptions

Options for text field.

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:

(Types::DateArrayOptions)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1400

class IndexField < Struct.new(
  :index_field_name,
  :index_field_type,
  :int_options,
  :double_options,
  :literal_options,
  :text_options,
  :date_options,
  :lat_lon_options,
  :int_array_options,
  :double_array_options,
  :literal_array_options,
  :text_array_options,
  :date_array_options)
  SENSITIVE = []
  include Aws::Structure
end

#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:

(Types::DateOptions)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1400

class IndexField < Struct.new(
  :index_field_name,
  :index_field_type,
  :int_options,
  :double_options,
  :literal_options,
  :text_options,
  :date_options,
  :lat_lon_options,
  :int_array_options,
  :double_array_options,
  :literal_array_options,
  :text_array_options,
  :date_array_options)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1400

class IndexField < Struct.new(
  :index_field_name,
  :index_field_type,
  :int_options,
  :double_options,
  :literal_options,
  :text_options,
  :date_options,
  :lat_lon_options,
  :int_array_options,
  :double_array_options,
  :literal_array_options,
  :text_array_options,
  :date_array_options)
  SENSITIVE = []
  include Aws::Structure
end

#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:

(Types::DoubleOptions)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1400

class IndexField < Struct.new(
  :index_field_name,
  :index_field_type,
  :int_options,
  :double_options,
  :literal_options,
  :text_options,
  :date_options,
  :lat_lon_options,
  :int_array_options,
  :double_array_options,
  :literal_array_options,
  :text_array_options,
  :date_array_options)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1400

class IndexField < Struct.new(
  :index_field_name,
  :index_field_type,
  :int_options,
  :double_options,
  :literal_options,
  :text_options,
  :date_options,
  :lat_lon_options,
  :int_array_options,
  :double_array_options,
  :literal_array_options,
  :text_array_options,
  :date_array_options)
  SENSITIVE = []
  include Aws::Structure
end

#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][1: in the *Amazon CloudSearch Developer

Guide*.

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html

Returns:

(String)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1400

class IndexField < Struct.new(
  :index_field_name,
  :index_field_type,
  :int_options,
  :double_options,
  :literal_options,
  :text_options,
  :date_options,
  :lat_lon_options,
  :int_array_options,
  :double_array_options,
  :literal_array_options,
  :text_array_options,
  :date_array_options)
  SENSITIVE = []
  include Aws::Structure
end

#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:

(Types::IntArrayOptions)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1400

class IndexField < Struct.new(
  :index_field_name,
  :index_field_type,
  :int_options,
  :double_options,
  :literal_options,
  :text_options,
  :date_options,
  :lat_lon_options,
  :int_array_options,
  :double_array_options,
  :literal_array_options,
  :text_array_options,
  :date_array_options)
  SENSITIVE = []
  include Aws::Structure
end

#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:

(Types::IntOptions)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1400

class IndexField < Struct.new(
  :index_field_name,
  :index_field_type,
  :int_options,
  :double_options,
  :literal_options,
  :text_options,
  :date_options,
  :lat_lon_options,
  :int_array_options,
  :double_array_options,
  :literal_array_options,
  :text_array_options,
  :date_array_options)
  SENSITIVE = []
  include Aws::Structure
end

#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:

(Types::LatLonOptions)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1400

class IndexField < Struct.new(
  :index_field_name,
  :index_field_type,
  :int_options,
  :double_options,
  :literal_options,
  :text_options,
  :date_options,
  :lat_lon_options,
  :int_array_options,
  :double_array_options,
  :literal_array_options,
  :text_array_options,
  :date_array_options)
  SENSITIVE = []
  include Aws::Structure
end

#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:

(Types::LiteralArrayOptions)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1400

class IndexField < Struct.new(
  :index_field_name,
  :index_field_type,
  :int_options,
  :double_options,
  :literal_options,
  :text_options,
  :date_options,
  :lat_lon_options,
  :int_array_options,
  :double_array_options,
  :literal_array_options,
  :text_array_options,
  :date_array_options)
  SENSITIVE = []
  include Aws::Structure
end

#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:

(Types::LiteralOptions)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1400

class IndexField < Struct.new(
  :index_field_name,
  :index_field_type,
  :int_options,
  :double_options,
  :literal_options,
  :text_options,
  :date_options,
  :lat_lon_options,
  :int_array_options,
  :double_array_options,
  :literal_array_options,
  :text_array_options,
  :date_array_options)
  SENSITIVE = []
  include Aws::Structure
end

#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:

(Types::TextArrayOptions)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1400

class IndexField < Struct.new(
  :index_field_name,
  :index_field_type,
  :int_options,
  :double_options,
  :literal_options,
  :text_options,
  :date_options,
  :lat_lon_options,
  :int_array_options,
  :double_array_options,
  :literal_array_options,
  :text_array_options,
  :date_array_options)
  SENSITIVE = []
  include Aws::Structure
end

#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:

(Types::TextOptions)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1400

class IndexField < Struct.new(
  :index_field_name,
  :index_field_type,
  :int_options,
  :double_options,
  :literal_options,
  :text_options,
  :date_options,
  :lat_lon_options,
  :int_array_options,
  :double_array_options,
  :literal_array_options,
  :text_array_options,
  :date_array_options)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#date_array_options ⇒ Types::DateArrayOptions

#date_options ⇒ Types::DateOptions

#double_array_options ⇒ Types::DoubleArrayOptions

#double_options ⇒ Types::DoubleOptions

#index_field_name ⇒ String

#index_field_type ⇒ String

#int_array_options ⇒ Types::IntArrayOptions

#int_options ⇒ Types::IntOptions

#lat_lon_options ⇒ Types::LatLonOptions

#literal_array_options ⇒ Types::LiteralArrayOptions

#literal_options ⇒ Types::LiteralOptions

#text_array_options ⇒ Types::TextArrayOptions

#text_options ⇒ Types::TextOptions

#date_array_options ⇒ `Types::DateArrayOptions`

#date_options ⇒ `Types::DateOptions`

#double_array_options ⇒ `Types::DoubleArrayOptions`

#double_options ⇒ `Types::DoubleOptions`

#index_field_name ⇒ `String`

#index_field_type ⇒ `String`

#int_array_options ⇒ `Types::IntArrayOptions`

#int_options ⇒ `Types::IntOptions`

#lat_lon_options ⇒ `Types::LatLonOptions`

#literal_array_options ⇒ `Types::LiteralArrayOptions`

#literal_options ⇒ `Types::LiteralOptions`

#text_array_options ⇒ `Types::TextArrayOptions`

#text_options ⇒ `Types::TextOptions`