AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing LiteralArrayOptions as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

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)

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

#facet_enabledBoolean

Whether facet information can be returned for the field.

Returns:

  • (Boolean)

    Whether facet information can be returned for the field.

#return_enabledBoolean

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

Returns:

  • (Boolean)

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

#search_enabledBoolean

Whether the contents of the field are searchable.

Returns:

  • (Boolean)

    Whether the contents of the field are searchable.

#source_fieldsString

A list of source fields to map to the field.

Returns:

  • (String)

    A list of source fields to map to the field.