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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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.

Constant Summary collapse

SENSITIVE =
[]

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)

1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
# File 'lib/aws-sdk-cloudsearch/types.rb', line 1987

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

#facet_enabledBoolean

Whether facet information can be returned for the field.

Returns:

  • (Boolean)

1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
# File 'lib/aws-sdk-cloudsearch/types.rb', line 1987

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

#return_enabledBoolean

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

Returns:

  • (Boolean)

1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
# File 'lib/aws-sdk-cloudsearch/types.rb', line 1987

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

#search_enabledBoolean

Whether the contents of the field are searchable.

Returns:

  • (Boolean)

1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
# File 'lib/aws-sdk-cloudsearch/types.rb', line 1987

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

#sort_enabledBoolean

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

Returns:

  • (Boolean)

1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
# File 'lib/aws-sdk-cloudsearch/types.rb', line 1987

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

#source_fieldString

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

Returns:

  • (String)

1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
# File 'lib/aws-sdk-cloudsearch/types.rb', line 1987

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