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

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

Overview

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

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#default_value ⇒ Integer

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) 


1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
 
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1504

class IntOptions < 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) 


1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
 
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1504

class IntOptions < 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) 


1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
 
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1504

class IntOptions < 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) 


1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
 
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1504

class IntOptions < 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) 


1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
 
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1504

class IntOptions < 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) 


1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
 
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1504

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