software.amazon.awssdk.services.location.model

Class RouteMatrixEntryError

java.lang.Object

software.amazon.awssdk.services.location.model.RouteMatrixEntryError

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RouteMatrixEntryError.Builder,RouteMatrixEntryError>

@Generated(value="software.amazon.awssdk:codegen")
public final class RouteMatrixEntryError
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RouteMatrixEntryError.Builder,RouteMatrixEntryError>

An error corresponding to the calculation of a route between the DeparturePosition and DestinationPosition.

The error code can be one of the following:

• RouteNotFound - Unable to find a valid route with the given parameters.

• RouteTooLong - Route calculation went beyond the maximum size of a route and was terminated before completion.

• PositionsNotFound - One or more of the input positions were not found on the route network.

• DestinationPositionNotFound - The destination position was not found on the route network.

• DeparturePositionNotFound - The departure position was not found on the route network.

• OtherValidationError - The given inputs were not valid or a route was not found. More information is given in the error Message

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RouteMatrixEntryError.Builder

Method Summary

Modifier and Type	Method and Description
static RouteMatrixEntryError.Builder	builder()
RouteMatrixErrorCode	code() The type of error which occurred for the route calculation.
String	codeAsString() The type of error which occurred for the route calculation.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	message() A message about the error that occurred for the route calculation.
List<SdkField<?>>	sdkFields()
static Class<? extends RouteMatrixEntryError.Builder>	serializableBuilderClass()
RouteMatrixEntryError.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

code

public final RouteMatrixErrorCode code()

The type of error which occurred for the route calculation.

If the service returns an enum value that is not available in the current SDK version, code will return RouteMatrixErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from codeAsString().

Returns:

The type of error which occurred for the route calculation.

See Also:

RouteMatrixErrorCode

codeAsString

public final String codeAsString()

The type of error which occurred for the route calculation.

If the service returns an enum value that is not available in the current SDK version, code will return RouteMatrixErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from codeAsString().

Returns:

The type of error which occurred for the route calculation.

See Also:

RouteMatrixErrorCode

message

public final String message()

A message about the error that occurred for the route calculation.

Returns:

A message about the error that occurred for the route calculation.

toBuilder

public RouteMatrixEntryError.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RouteMatrixEntryError.Builder,RouteMatrixEntryError>

builder

public static RouteMatrixEntryError.Builder builder()

serializableBuilderClass

public static Class<? extends RouteMatrixEntryError.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo