Enum SearchError
- Last UpdatedJun 10, 2025
- 3 minute read
- java.lang.Object
-
- java.lang.Enum<SearchError>
-
- com.here.sdk.search.SearchError
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<SearchError>
public enum SearchError extends java.lang.Enum<SearchError>
Specifies possible errors that may result from a search query.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description AUTHENTICATION_FAILED
Search operation is not authenticated.BAD_REQUEST
Bad network requestEXCEEDED_USAGE_LIMIT
Credentials exceeded the allowed requests limit.FILTER_EMPTY
Filter is emptyFILTER_TOO_LONG
Filter is too long, max.FORBIDDEN
The credentials given do not provide access to the resource requested.HTTP_ERROR
Network request error.INVALID_AREA
Box or circle area of query is invalidINVALID_CORRIDOR_POLYLINE
Corridor area polyline size is less than 2 pointsINVALID_CUSTOM_OPTION_FORMAT
Custom options are set in an invalid format in the queryINVALID_PARAMETER
Deprecated.Will be removed in v4.24.0.INVALID_TRUCK_CLASS
Light truck class is passed in the filterINVALID_URL
Url is invalidMAX_ITEMS_OUT_OF_RANGE
Should be in the range [1, 100].NO_RESULTS_FOUND
No results found.OFFLINE
The device does not have an internet connection.OPERATION_CANCELLED
Operation cancelled.OPERATION_FAILED
Operation failed due to an internal error.PARSING_ERROR
Error while parsing response data.PROXY_AUTHENTICATION_FAILED
Proxy is not authenticated.PROXY_SERVER_UNREACHABLE
Proxy server unreachable.QUERY_EMPTY
Empty queryQUERY_TOO_LONG
Query is too long, max.SERVER_UNREACHABLE
Server unreachable.TIMED_OUT
The request timed out.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static SearchError
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static SearchError[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
AUTHENTICATION_FAILED
public static final SearchError AUTHENTICATION_FAILED
Search operation is not authenticated. Check your credentials.
-
MAX_ITEMS_OUT_OF_RANGE
public static final SearchError MAX_ITEMS_OUT_OF_RANGE
Should be in the range [1, 100].
-
PARSING_ERROR
public static final SearchError PARSING_ERROR
Error while parsing response data.
-
NO_RESULTS_FOUND
public static final SearchError NO_RESULTS_FOUND
No results found.
-
HTTP_ERROR
public static final SearchError HTTP_ERROR
Network request error.
-
SERVER_UNREACHABLE
public static final SearchError SERVER_UNREACHABLE
Server unreachable.
-
INVALID_PARAMETER
@Deprecated public static final SearchError INVALID_PARAMETER
Deprecated.Will be removed in v4.24.0. Use newly added concrete errors instead.
At least one of the parameters has an invalid value.
-
FORBIDDEN
public static final SearchError FORBIDDEN
The credentials given do not provide access to the resource requested.
-
EXCEEDED_USAGE_LIMIT
public static final SearchError EXCEEDED_USAGE_LIMIT
Credentials exceeded the allowed requests limit.
-
OPERATION_FAILED
public static final SearchError OPERATION_FAILED
Operation failed due to an internal error.
-
OPERATION_CANCELLED
public static final SearchError OPERATION_CANCELLED
Operation cancelled.
-
TIMED_OUT
public static final SearchError TIMED_OUT
The request timed out.
-
OFFLINE
public static final SearchError OFFLINE
The device does not have an internet connection.
-
QUERY_TOO_LONG
public static final SearchError QUERY_TOO_LONG
Query is too long, max. size is 300 characters.
-
FILTER_TOO_LONG
public static final SearchError FILTER_TOO_LONG
Filter is too long, max. size is 300 characters.
-
PROXY_AUTHENTICATION_FAILED
public static final SearchError PROXY_AUTHENTICATION_FAILED
Proxy is not authenticated. Check your proxy credentials.
-
PROXY_SERVER_UNREACHABLE
public static final SearchError PROXY_SERVER_UNREACHABLE
Proxy server unreachable.
-
QUERY_EMPTY
public static final SearchError QUERY_EMPTY
Empty query
-
INVALID_AREA
public static final SearchError INVALID_AREA
Box or circle area of query is invalid
-
FILTER_EMPTY
public static final SearchError FILTER_EMPTY
Filter is empty
-
INVALID_CORRIDOR_POLYLINE
public static final SearchError INVALID_CORRIDOR_POLYLINE
Corridor area polyline size is less than 2 points
-
INVALID_URL
public static final SearchError INVALID_URL
Url is invalid
-
INVALID_CUSTOM_OPTION_FORMAT
public static final SearchError INVALID_CUSTOM_OPTION_FORMAT
Custom options are set in an invalid format in the query
-
INVALID_TRUCK_CLASS
public static final SearchError INVALID_TRUCK_CLASS
Light truck class is passed in the filter
-
BAD_REQUEST
public static final SearchError BAD_REQUEST
Bad network request
-
-
Method Detail
-
values
public static SearchError[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (SearchError c : SearchError.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SearchError valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
-