Class: Aws::CloudSearch::Types::DoubleOptions

Inherits:

Struct

• Object
• Struct
• Aws::CloudSearch::Types::DoubleOptions

Includes:

Structure

Defined in:

lib/aws-sdk-cloudsearch/types.rb

Overview

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.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

Returns:

• (Float)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1212

class DoubleOptions < Struct.new(
  :default_value,
  :source_field,
  :facet_enabled,
  :search_enabled,
  :return_enabled,
  :sort_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#facet_enabled ⇒ Boolean

Whether facet information can be returned for the field.

Returns:

• (Boolean)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1212

class DoubleOptions < Struct.new(
  :default_value,
  :source_field,
  :facet_enabled,
  :search_enabled,
  :return_enabled,
  :sort_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#return_enabled ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1212

class DoubleOptions < Struct.new(
  :default_value,
  :source_field,
  :facet_enabled,
  :search_enabled,
  :return_enabled,
  :sort_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#search_enabled ⇒ Boolean

Whether the contents of the field are searchable.

Returns:

• (Boolean)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1212

class DoubleOptions < Struct.new(
  :default_value,
  :source_field,
  :facet_enabled,
  :search_enabled,
  :return_enabled,
  :sort_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#sort_enabled ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1212

class DoubleOptions < Struct.new(
  :default_value,
  :source_field,
  :facet_enabled,
  :search_enabled,
  :return_enabled,
  :sort_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#source_field ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cloudsearch/types.rb', line 1212

class DoubleOptions < Struct.new(
  :default_value,
  :source_field,
  :facet_enabled,
  :search_enabled,
  :return_enabled,
  :sort_enabled)
  SENSITIVE = []
  include Aws::Structure
end