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

Class: Aws::CloudSearch::Types::LatLonOptions

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

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

Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.

Instance Attribute Summary collapse

Instance Attribute Details

#default_valueString

A value to use for the field if the field isn't specified for a document.

Returns:

  • (String)


1890
1891
1892
1893
1894
1895
1896
1897
1898
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1890

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


1890
1891
1892
1893
1894
1895
1896
1897
1898
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1890

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


1890
1891
1892
1893
1894
1895
1896
1897
1898
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1890

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


1890
1891
1892
1893
1894
1895
1896
1897
1898
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1890

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


1890
1891
1892
1893
1894
1895
1896
1897
1898
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1890

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

#source_fieldString

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

Returns:

  • (String)


1890
1891
1892
1893
1894
1895
1896
1897
1898
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1890

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