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
- Struct
- Aws::CloudSearch::Types::DoubleOptions
- Defined in:
- (unknown)
Overview
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
-
#default_value ⇒ Float
A value to use for the field if the field isn\'t specified for a document.
-
#facet_enabled ⇒ Boolean
Whether facet information can be returned for the field.
-
#return_enabled ⇒ Boolean
Whether the contents of the field can be returned in the search results.
-
#search_enabled ⇒ Boolean
Whether the contents of the field are searchable.
-
#sort_enabled ⇒ Boolean
Whether the field can be used to sort the search results.
-
#source_field ⇒ String
The name of the source field to map to the field.
Instance Attribute Details
#default_value ⇒ Float
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.
#facet_enabled ⇒ Boolean
Whether facet information can be returned for the field.
#return_enabled ⇒ Boolean
Whether the contents of the field can be returned in the search results.
#search_enabled ⇒ Boolean
Whether the contents of the field are searchable.
#sort_enabled ⇒ Boolean
Whether the field can be used to sort the search results.
#source_field ⇒ String
The name of the source field to map to the field.