Class: Aws::CloudSearch::Types::TextOptions

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

Overview

Note:

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

{
  default_value: "FieldValue",
  source_field: "FieldName",
  return_enabled: false,
  sort_enabled: false,
  highlight_enabled: false,
  analysis_scheme: "Word",
}

Options for text field. Present if `IndexFieldType` specifies the field is of type `text`. A `text` field is always searchable. All options are enabled by default.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#analysis_schemeString

The name of an analysis scheme for a `text` field.

Returns:

  • (String)

2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
# File 'lib/aws-sdk-cloudsearch/types.rb', line 2504

class TextOptions < Struct.new(
  :default_value,
  :source_field,
  :return_enabled,
  :sort_enabled,
  :highlight_enabled,
  :analysis_scheme)
  SENSITIVE = []
  include Aws::Structure
end

#default_valueString

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

Returns:

  • (String)

2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
# File 'lib/aws-sdk-cloudsearch/types.rb', line 2504

class TextOptions < Struct.new(
  :default_value,
  :source_field,
  :return_enabled,
  :sort_enabled,
  :highlight_enabled,
  :analysis_scheme)
  SENSITIVE = []
  include Aws::Structure
end

#highlight_enabledBoolean

Whether highlights can be returned for the field.

Returns:

  • (Boolean)

2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
# File 'lib/aws-sdk-cloudsearch/types.rb', line 2504

class TextOptions < Struct.new(
  :default_value,
  :source_field,
  :return_enabled,
  :sort_enabled,
  :highlight_enabled,
  :analysis_scheme)
  SENSITIVE = []
  include Aws::Structure
end

#return_enabledBoolean

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

Returns:

  • (Boolean)

2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
# File 'lib/aws-sdk-cloudsearch/types.rb', line 2504

class TextOptions < Struct.new(
  :default_value,
  :source_field,
  :return_enabled,
  :sort_enabled,
  :highlight_enabled,
  :analysis_scheme)
  SENSITIVE = []
  include Aws::Structure
end

#sort_enabledBoolean

Whether the field can be used to sort the search results.

Returns:

  • (Boolean)

2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
# File 'lib/aws-sdk-cloudsearch/types.rb', line 2504

class TextOptions < Struct.new(
  :default_value,
  :source_field,
  :return_enabled,
  :sort_enabled,
  :highlight_enabled,
  :analysis_scheme)
  SENSITIVE = []
  include Aws::Structure
end

#source_fieldString

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name `score` is reserved and cannot be used as a field name. To reference a document's ID, you can use the name `_id`.

Returns:

  • (String)

2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
# File 'lib/aws-sdk-cloudsearch/types.rb', line 2504

class TextOptions < Struct.new(
  :default_value,
  :source_field,
  :return_enabled,
  :sort_enabled,
  :highlight_enabled,
  :analysis_scheme)
  SENSITIVE = []
  include Aws::Structure
end