LatLonOptions (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.cloudsearchv2.model

Class LatLonOptions

java.lang.Object
- com.amazonaws.services.cloudsearchv2.model.LatLonOptions

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class LatLonOptions
extends Object
implements Serializable, Cloneable 
```
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.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

LatLonOptions ()

Constructors
Constructor and Description
`LatLonOptions ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`LatLonOptions`	`clone ()`
`boolean`	`equals (Object obj)`
`String`	`getDefaultValue ()` A value to use for the field if the field isn't specified for a document.
`Boolean`	`getFacetEnabled ()` Whether facet information can be returned for the field.
`Boolean`	`getReturnEnabled ()` Whether the contents of the field can be returned in the search results.
`Boolean`	`getSearchEnabled ()` Whether the contents of the field are searchable.
`Boolean`	`getSortEnabled ()` Whether the field can be used to sort the search results.
`String`	`getSourceField ()`
`int`	`hashCode ()`
`Boolean`	`isFacetEnabled ()` Whether facet information can be returned for the field.
`Boolean`	`isReturnEnabled ()` Whether the contents of the field can be returned in the search results.
`Boolean`	`isSearchEnabled ()` Whether the contents of the field are searchable.
`Boolean`	`isSortEnabled ()` Whether the field can be used to sort the search results.
`void`	`setDefaultValue (String defaultValue)` A value to use for the field if the field isn't specified for a document.
`void`	`setFacetEnabled (Boolean facetEnabled)` Whether facet information can be returned for the field.
`void`	`setReturnEnabled (Boolean returnEnabled)` Whether the contents of the field can be returned in the search results.
`void`	`setSearchEnabled (Boolean searchEnabled)` Whether the contents of the field are searchable.
`void`	`setSortEnabled (Boolean sortEnabled)` Whether the field can be used to sort the search results.
`void`	`setSourceField (String sourceField)`
`String`	`toString ()` Returns a string representation of this object.
`LatLonOptions`	`withDefaultValue (String defaultValue)` A value to use for the field if the field isn't specified for a document.
`LatLonOptions`	`withFacetEnabled (Boolean facetEnabled)` Whether facet information can be returned for the field.
`LatLonOptions`	`withReturnEnabled (Boolean returnEnabled)` Whether the contents of the field can be returned in the search results.
`LatLonOptions`	`withSearchEnabled (Boolean searchEnabled)` Whether the contents of the field are searchable.
`LatLonOptions`	`withSortEnabled (Boolean sortEnabled)` Whether the field can be used to sort the search results.
`LatLonOptions`	`withSourceField (String sourceField)`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - LatLonOptions
```
public LatLonOptions()
```
- Method Detail
  - setDefaultValue
```
public void setDefaultValue(String defaultValue)
```
    A value to use for the field if the field isn't specified for a document.
    
    Parameters:
    
    defaultValue - A value to use for the field if the field isn't specified for a document.
  - getDefaultValue
```
public String getDefaultValue()
```
    A value to use for the field if the field isn't specified for a document.
    
    Returns:
    
    A value to use for the field if the field isn't specified for a document.
  - withDefaultValue
```
public LatLonOptions withDefaultValue(String defaultValue)
```
    A value to use for the field if the field isn't specified for a document.
    
    Parameters:
    
    defaultValue - A value to use for the field if the field isn't specified for a document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceField
```
public void setSourceField(String sourceField)
```
    Parameters:
    
    sourceField -
  - getSourceField
```
public String getSourceField()
```
    Returns:
  - withSourceField
```
public LatLonOptions withSourceField(String sourceField)
```
    Parameters:
    
    sourceField -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFacetEnabled
```
public void setFacetEnabled(Boolean facetEnabled)
```
    Whether facet information can be returned for the field.
    
    Parameters:
    
    facetEnabled - Whether facet information can be returned for the field.
  - getFacetEnabled
```
public Boolean getFacetEnabled()
```
    Whether facet information can be returned for the field.
    
    Returns:
    
    Whether facet information can be returned for the field.
  - withFacetEnabled
```
public LatLonOptions withFacetEnabled(Boolean facetEnabled)
```
    Whether facet information can be returned for the field.
    
    Parameters:
    
    facetEnabled - Whether facet information can be returned for the field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isFacetEnabled
```
public Boolean isFacetEnabled()
```
    Whether facet information can be returned for the field.
    
    Returns:
    
    Whether facet information can be returned for the field.
  - setSearchEnabled
```
public void setSearchEnabled(Boolean searchEnabled)
```
    Whether the contents of the field are searchable.
    
    Parameters:
    
    searchEnabled - Whether the contents of the field are searchable.
  - getSearchEnabled
```
public Boolean getSearchEnabled()
```
    Whether the contents of the field are searchable.
    
    Returns:
    
    Whether the contents of the field are searchable.
  - withSearchEnabled
```
public LatLonOptions withSearchEnabled(Boolean searchEnabled)
```
    Whether the contents of the field are searchable.
    
    Parameters:
    
    searchEnabled - Whether the contents of the field are searchable.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isSearchEnabled
```
public Boolean isSearchEnabled()
```
    Whether the contents of the field are searchable.
    
    Returns:
    
    Whether the contents of the field are searchable.
  - setReturnEnabled
```
public void setReturnEnabled(Boolean returnEnabled)
```
    Whether the contents of the field can be returned in the search results.
    
    Parameters:
    
    returnEnabled - Whether the contents of the field can be returned in the search results.
  - getReturnEnabled
```
public Boolean getReturnEnabled()
```
    Whether the contents of the field can be returned in the search results.
    
    Returns:
    
    Whether the contents of the field can be returned in the search results.
  - withReturnEnabled
```
public LatLonOptions withReturnEnabled(Boolean returnEnabled)
```
    Whether the contents of the field can be returned in the search results.
    
    Parameters:
    
    returnEnabled - Whether the contents of the field can be returned in the search results.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isReturnEnabled
```
public Boolean isReturnEnabled()
```
    Whether the contents of the field can be returned in the search results.
    
    Returns:
    
    Whether the contents of the field can be returned in the search results.
  - setSortEnabled
```
public void setSortEnabled(Boolean sortEnabled)
```
    Whether the field can be used to sort the search results.
    
    Parameters:
    
    sortEnabled - Whether the field can be used to sort the search results.
  - getSortEnabled
```
public Boolean getSortEnabled()
```
    Whether the field can be used to sort the search results.
    
    Returns:
    
    Whether the field can be used to sort the search results.
  - withSortEnabled
```
public LatLonOptions withSortEnabled(Boolean sortEnabled)
```
    Whether the field can be used to sort the search results.
    
    Parameters:
    
    sortEnabled - Whether the field can be used to sort the search results.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isSortEnabled
```
public Boolean isSortEnabled()
```
    Whether the field can be used to sort the search results.
    
    Returns:
    
    Whether the field can be used to sort the search results.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public LatLonOptions clone()
```
    Overrides:
    
    clone in class Object

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class LatLonOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LatLonOptions

Method Detail

setDefaultValue

getDefaultValue

withDefaultValue

setSourceField

getSourceField

withSourceField

setFacetEnabled

getFacetEnabled

withFacetEnabled

isFacetEnabled

setSearchEnabled

getSearchEnabled

withSearchEnabled

isSearchEnabled

setReturnEnabled

getReturnEnabled

withReturnEnabled

isReturnEnabled

setSortEnabled

getSortEnabled

withSortEnabled

isSortEnabled

toString

equals

hashCode

clone