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

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

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 TextArrayOptions data as a hash:

{
  default_value: "FieldValue",
  source_fields: "FieldNameCommaList",
  return_enabled: false,
  highlight_enabled: false,
  analysis_scheme: "Word",
}

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.

Instance Attribute Summary collapse

Instance Attribute Details

#analysis_schemeString

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

Returns:

  • (String)


2235
2236
2237
2238
2239
2240
2241
2242
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 2235

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

#default_valueString

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

Returns:

  • (String)


2235
2236
2237
2238
2239
2240
2241
2242
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 2235

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

#highlight_enabledBoolean

Whether highlights can be returned for the field.

Returns:

  • (Boolean)


2235
2236
2237
2238
2239
2240
2241
2242
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 2235

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

#return_enabledBoolean

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

Returns:

  • (Boolean)


2235
2236
2237
2238
2239
2240
2241
2242
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 2235

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

#source_fieldsString

A list of source fields to map to the field.

Returns:

  • (String)


2235
2236
2237
2238
2239
2240
2241
2242
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 2235

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