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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudsearch/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 collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#default_valueString

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

Returns:

  • (String)


1644
1645
1646
1647
1648
1649
1650
1651
1652
# File 'gems/aws-sdk-cloudsearch/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_enabledBoolean

Whether facet information can be returned for the field.

Returns:

  • (Boolean)


1644
1645
1646
1647
1648
1649
1650
1651
1652
# File 'gems/aws-sdk-cloudsearch/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_enabledBoolean

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

Returns:

  • (Boolean)


1644
1645
1646
1647
1648
1649
1650
1651
1652
# File 'gems/aws-sdk-cloudsearch/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_enabledBoolean

Whether the contents of the field are searchable.

Returns:

  • (Boolean)


1644
1645
1646
1647
1648
1649
1650
1651
1652
# File 'gems/aws-sdk-cloudsearch/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_fieldsString

A list of source fields to map to the field.

Returns:

  • (String)


1644
1645
1646
1647
1648
1649
1650
1651
1652
# File 'gems/aws-sdk-cloudsearch/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