Class: Aws::CloudSearch::Types::LiteralArrayOptions

Inherits:

Struct

• Object
• Struct
• Aws::CloudSearch::Types::LiteralArrayOptions

Includes:

Structure

Defined in:

lib/aws-sdk-cloudsearch/types.rb

Overview

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.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #default_value ⇒ String

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

• #facet_enabled ⇒ Boolean

  Whether facet information can be returned for the field.

• #return_enabled ⇒ Boolean

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

• #search_enabled ⇒ Boolean

  Whether the contents of the field are searchable.

• #source_fields ⇒ String

  A list of source fields to map to the field.

Instance Attribute Details

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

class LiteralArrayOptions < Struct.new(
  :default_value,
  :source_fields,
  :facet_enabled,
  :search_enabled,
  :return_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#facet_enabled ⇒ Boolean

Whether facet information can be returned for the field.

Returns:

• (Boolean)

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

class LiteralArrayOptions < Struct.new(
  :default_value,
  :source_fields,
  :facet_enabled,
  :search_enabled,
  :return_enabled)
  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 1644

class LiteralArrayOptions < Struct.new(
  :default_value,
  :source_fields,
  :facet_enabled,
  :search_enabled,
  :return_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#search_enabled ⇒ Boolean

Whether the contents of the field are searchable.

Returns:

• (Boolean)

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

class LiteralArrayOptions < Struct.new(
  :default_value,
  :source_fields,
  :facet_enabled,
  :search_enabled,
  :return_enabled)
  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 1644

class LiteralArrayOptions < Struct.new(
  :default_value,
  :source_fields,
  :facet_enabled,
  :search_enabled,
  :return_enabled)
  SENSITIVE = []
  include Aws::Structure
end