Class: Aws::CloudSearch::Types::TextArrayOptions

Inherits:

Struct

• Object
• Struct
• Aws::CloudSearch::Types::TextArrayOptions

Includes:

Structure

Defined in:

lib/aws-sdk-cloudsearch/types.rb

Overview

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.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #analysis_scheme ⇒ String

  The name of an analysis scheme for a ‘text-array` field.

• #default_value ⇒ String

  A value to use for the field if the field isn’t specified for a document.

• #highlight_enabled ⇒ Boolean

  Whether highlights can be returned for the field.

• #return_enabled ⇒ Boolean

  Whether the contents of the field can be returned in the search results.

• #source_fields ⇒ String

  A list of source fields to map to the field.

Instance Attribute Details

#analysis_scheme ⇒ String

The name of an analysis scheme for a ‘text-array` field.

Returns:

• (String)

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

class TextArrayOptions < Struct.new(
  :default_value,
  :source_fields,
  :return_enabled,
  :highlight_enabled,
  :analysis_scheme)
  SENSITIVE = []
  include Aws::Structure
end

#default_value ⇒ String

A value to use for the field if the field isn’t specified for a document.

Returns:

• (String)

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

class TextArrayOptions < Struct.new(
  :default_value,
  :source_fields,
  :return_enabled,
  :highlight_enabled,
  :analysis_scheme)
  SENSITIVE = []
  include Aws::Structure
end

#highlight_enabled ⇒ Boolean

Whether highlights can be returned for the field.

Returns:

• (Boolean)

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

class TextArrayOptions < Struct.new(
  :default_value,
  :source_fields,
  :return_enabled,
  :highlight_enabled,
  :analysis_scheme)
  SENSITIVE = []
  include Aws::Structure
end

#return_enabled ⇒ Boolean

Whether the contents of the field can be returned in the search results.

Returns:

• (Boolean)

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

class TextArrayOptions < Struct.new(
  :default_value,
  :source_fields,
  :return_enabled,
  :highlight_enabled,
  :analysis_scheme)
  SENSITIVE = []
  include Aws::Structure
end

#source_fields ⇒ String

A list of source fields to map to the field.

Returns:

• (String)

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

class TextArrayOptions < Struct.new(
  :default_value,
  :source_fields,
  :return_enabled,
  :highlight_enabled,
  :analysis_scheme)
  SENSITIVE = []
  include Aws::Structure
end