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::DoubleOptions

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

Overview

Note:

When passing DoubleOptions as input to an Aws::Client method, you can use a vanilla Hash:

{
  default_value: 1.0,
  source_field: "FieldName",
  facet_enabled: false,
  search_enabled: false,
  return_enabled: false,
  sort_enabled: false,
}

Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#default_valueFloat

A value to use for the field if the field isn\'t specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

Returns:

  • (Float)

    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.

#sort_enabledBoolean

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

Returns:

  • (Boolean)

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

#source_fieldString

The name of the source field to map to the field.

Returns:

  • (String)

    The name of the source field to map to the field.