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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb

Overview

Note:

When making an API call, you may pass LiteralArrayOptions data as a hash:

{
  default_value: "FieldValue",
  source_fields: "FieldNameCommaList",
  facet_enabled: false,
  search_enabled: false,
  return_enabled: false,
}

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.

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)


1961
1962
1963
1964
1965
1966
1967
1968
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1961

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

#facet_enabledBoolean

Whether facet information can be returned for the field.

Returns:

  • (Boolean)


1961
1962
1963
1964
1965
1966
1967
1968
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1961

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

#return_enabledBoolean

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

Returns:

  • (Boolean)


1961
1962
1963
1964
1965
1966
1967
1968
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1961

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

#search_enabledBoolean

Whether the contents of the field are searchable.

Returns:

  • (Boolean)


1961
1962
1963
1964
1965
1966
1967
1968
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1961

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

#source_fieldsString

A list of source fields to map to the field.

Returns:

  • (String)


1961
1962
1963
1964
1965
1966
1967
1968
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1961

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