Package software.amazon.awssdk.services.georoutes.model

Class CalculateRouteMatrixRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.georoutes.model.GeoRoutesRequest

software.amazon.awssdk.services.georoutes.model.CalculateRouteMatrixRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CalculateRouteMatrixRequest.Builder,CalculateRouteMatrixRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CalculateRouteMatrixRequest
extends GeoRoutesRequest
implements ToCopyableBuilder<CalculateRouteMatrixRequest.Builder,CalculateRouteMatrixRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CalculateRouteMatrixRequest.Builder

Method Summary

Modifier and Type	Method	Description
RouteMatrixAllowOptions	allow()	Features that are allowed while calculating.
RouteMatrixAvoidanceOptions	avoid()	Features that are avoided while calculating a route.
static CalculateRouteMatrixRequest.Builder	builder()
Boolean	departNow()	Uses the current time as the time of departure.
String	departureTime()	Time of departure from thr origin.
List<RouteMatrixDestination>	destinations()	List of destinations for the route.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
RouteMatrixExclusionOptions	exclude()	Features to be strictly excluded while calculating the route.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDestinations()	For responses, this returns true if the service returned a value for the Destinations property.
int	hashCode()
boolean	hasOrigins()	For responses, this returns true if the service returned a value for the Origins property.
String	key()	Optional: The API key to be used for authorization.
RoutingObjective	optimizeRoutingFor()	Specifies the optimization criteria for calculating a route.
String	optimizeRoutingForAsString()	Specifies the optimization criteria for calculating a route.
List<RouteMatrixOrigin>	origins()	The position in longitude and latitude for the origin.
RouteMatrixBoundary	routingBoundary()	Boundary within which the matrix is to be calculated.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CalculateRouteMatrixRequest.Builder>	serializableBuilderClass()
CalculateRouteMatrixRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
RouteMatrixTrafficOptions	traffic()	Traffic related options.
RouteMatrixTravelMode	travelMode()	Specifies the mode of transport when calculating a route.
String	travelModeAsString()	Specifies the mode of transport when calculating a route.
RouteMatrixTravelModeOptions	travelModeOptions()	Travel mode related options for the provided travel mode.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

allow

public final RouteMatrixAllowOptions allow()

Features that are allowed while calculating. a route

Returns:

Features that are allowed while calculating. a route

avoid

public final RouteMatrixAvoidanceOptions avoid()

Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.

Returns:

Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.

departNow

public final Boolean departNow()

Uses the current time as the time of departure.

Returns:

Uses the current time as the time of departure.

departureTime

public final String departureTime()

Time of departure from thr origin.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

Returns:

Time of departure from thr origin.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

hasDestinations

public final boolean hasDestinations()

For responses, this returns true if the service returned a value for the Destinations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

destinations

public final List<RouteMatrixDestination> destinations()

List of destinations for the route.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDestinations() method.

Returns:

List of destinations for the route.

exclude

public final RouteMatrixExclusionOptions exclude()

Features to be strictly excluded while calculating the route.

Returns:

Features to be strictly excluded while calculating the route.

key

public final String key()

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

Returns:

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

optimizeRoutingFor

public final RoutingObjective optimizeRoutingFor()

Specifies the optimization criteria for calculating a route.

Default Value: FastestRoute

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

Returns:

Specifies the optimization criteria for calculating a route.

Default Value: FastestRoute

See Also:

RoutingObjective

optimizeRoutingForAsString

public final String optimizeRoutingForAsString()

Specifies the optimization criteria for calculating a route.

Default Value: FastestRoute

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

Returns:

Specifies the optimization criteria for calculating a route.

Default Value: FastestRoute

See Also:

RoutingObjective

hasOrigins

public final boolean hasOrigins()

For responses, this returns true if the service returned a value for the Origins property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

origins

public final List<RouteMatrixOrigin> origins()

The position in longitude and latitude for the origin.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOrigins() method.

Returns:

The position in longitude and latitude for the origin.

routingBoundary

public final RouteMatrixBoundary routingBoundary()

Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.

When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.

Returns:

Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.

When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.

traffic

public final RouteMatrixTrafficOptions traffic()

Traffic related options.

Returns:

Traffic related options.

travelMode

public final RouteMatrixTravelMode travelMode()

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

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

Returns:

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

See Also:

RouteMatrixTravelMode

travelModeAsString

public final String travelModeAsString()

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

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

Returns:

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

See Also:

RouteMatrixTravelMode

travelModeOptions

public final RouteMatrixTravelModeOptions travelModeOptions()

Travel mode related options for the provided travel mode.

Returns:

Travel mode related options for the provided travel mode.

toBuilder

public CalculateRouteMatrixRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CalculateRouteMatrixRequest.Builder,CalculateRouteMatrixRequest>

Specified by:

toBuilder in class GeoRoutesRequest

builder

public static CalculateRouteMatrixRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo