Package com.targomo.client.api.request

Enum Class GeocodingRequest.Option

java.lang.Object

java.lang.Enum<GeocodingRequest.Option>

com.targomo.client.api.request.GeocodingRequest.Option

All Implemented Interfaces:

Serializable, Comparable<GeocodingRequest.Option>, java.lang.constant.Constable

Enclosing class:

GeocodingRequest

public static enum GeocodingRequest.Option
extends Enum<GeocodingRequest.Option>

Special Geocoding request options that can be set at creation of the request. For more details please see REST service documentation.

See Also:

• Documentation

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSE_LOCATION	Defines an origin point location that is used to sort geocoding candidates based on their proximity to the location.
FOR_STORAGE	Specifies whether the results of the operation will be persisted, if true an authentication is required and the operation execution will be charged to the account
MAX_LOCATIONS	If more geocode candidates are supposed to be returned; by default only the one best fitting candidate is returned
SEARCH_EXTENT	A set of bounding box coordinates that limit the search area to a specific region, e.g.
SOURCE_COUNTRY	Limits the candidates returned by the findAddressCandidates operation to the specified country or countries, e.g.
SPATIAL_REFERENCE	The spatial reference of the x/y coordinates returned by a geocode request, e.g.

Method Summary

Modifier and Type	Method	Description
static GeocodingRequest.Option	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GeocodingRequest.Option[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SOURCE_COUNTRY

public static final GeocodingRequest.Option SOURCE_COUNTRY

Limits the candidates returned by the findAddressCandidates operation to the specified country or countries, e.g. "sourceCountry=FRA,DEU,ESP"

See Also:

• Country Codes

SEARCH_EXTENT

public static final GeocodingRequest.Option SEARCH_EXTENT

A set of bounding box coordinates that limit the search area to a specific region, e.g. "-104,35.6,-94.32,41"

CLOSE_LOCATION

public static final GeocodingRequest.Option CLOSE_LOCATION

Defines an origin point location that is used to sort geocoding candidates based on their proximity to the location.

SPATIAL_REFERENCE

public static final GeocodingRequest.Option SPATIAL_REFERENCE

The spatial reference of the x/y coordinates returned by a geocode request, e.g. "outSR=102100"

See Also:

• PCS
• GCS

MAX_LOCATIONS

public static final GeocodingRequest.Option MAX_LOCATIONS

If more geocode candidates are supposed to be returned; by default only the one best fitting candidate is returned

FOR_STORAGE

public static final GeocodingRequest.Option FOR_STORAGE

Specifies whether the results of the operation will be persisted, if true an authentication is required and the operation execution will be charged to the account

Method Details

values

public static GeocodingRequest.Option[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static GeocodingRequest.Option valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null