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

Class: Aws::CloudSearch::Types::IntOptions

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

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

Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.

Instance Attribute Summary collapse

Instance Attribute Details

#default_valueInteger

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:

  • (Integer)


1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1822

class IntOptions < Struct.new(
  :default_value,
  :source_field,
  :facet_enabled,
  :search_enabled,
  :return_enabled,
  :sort_enabled)
  include Aws::Structure
end

#facet_enabledBoolean

Whether facet information can be returned for the field.

Returns:

  • (Boolean)


1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1822

class IntOptions < Struct.new(
  :default_value,
  :source_field,
  :facet_enabled,
  :search_enabled,
  :return_enabled,
  :sort_enabled)
  include Aws::Structure
end

#return_enabledBoolean

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

Returns:

  • (Boolean)


1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1822

class IntOptions < Struct.new(
  :default_value,
  :source_field,
  :facet_enabled,
  :search_enabled,
  :return_enabled,
  :sort_enabled)
  include Aws::Structure
end

#search_enabledBoolean

Whether the contents of the field are searchable.

Returns:

  • (Boolean)


1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1822

class IntOptions < Struct.new(
  :default_value,
  :source_field,
  :facet_enabled,
  :search_enabled,
  :return_enabled,
  :sort_enabled)
  include Aws::Structure
end

#sort_enabledBoolean

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

Returns:

  • (Boolean)


1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1822

class IntOptions < Struct.new(
  :default_value,
  :source_field,
  :facet_enabled,
  :search_enabled,
  :return_enabled,
  :sort_enabled)
  include Aws::Structure
end

#source_fieldString

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

Returns:

  • (String)


1822
1823
1824
1825
1826
1827
1828
1829
1830
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1822

class IntOptions < Struct.new(
  :default_value,
  :source_field,
  :facet_enabled,
  :search_enabled,
  :return_enabled,
  :sort_enabled)
  include Aws::Structure
end