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

Class CalculateRoutesResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.georoutes.model.GeoRoutesResponse

software.amazon.awssdk.services.georoutes.model.CalculateRoutesResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CalculateRoutesResponse.Builder,CalculateRoutesResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CalculateRoutesResponse.Builder

Method Summary

Modifier and Type	Method	Description
static CalculateRoutesResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNotices()	For responses, this returns true if the service returned a value for the Notices property.
boolean	hasRoutes()	For responses, this returns true if the service returned a value for the Routes property.
GeometryFormat	legGeometryFormat()	Specifies the format of the geometry returned for each leg of the route.
String	legGeometryFormatAsString()	Specifies the format of the geometry returned for each leg of the route.
List<RouteResponseNotice>	notices()	Notices are additional information returned that indicate issues that occurred during route calculation.
String	pricingBucket()	The pricing bucket for which the query is charged at.
List<Route>	routes()	The path from the origin to the destination.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CalculateRoutesResponse.Builder>	serializableBuilderClass()
CalculateRoutesResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.georoutes.model.GeoRoutesResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

legGeometryFormat

public final GeometryFormat legGeometryFormat()

Specifies the format of the geometry returned for each leg of the route.

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

Returns:

Specifies the format of the geometry returned for each leg of the route.

See Also:

GeometryFormat

legGeometryFormatAsString

public final String legGeometryFormatAsString()

Specifies the format of the geometry returned for each leg of the route.

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

Returns:

Specifies the format of the geometry returned for each leg of the route.

See Also:

GeometryFormat

hasNotices

public final boolean hasNotices()

For responses, this returns true if the service returned a value for the Notices 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.

notices

public final List<RouteResponseNotice> notices()

Notices are additional information returned that indicate issues that occurred during route calculation.

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 hasNotices() method.

Returns:

Notices are additional information returned that indicate issues that occurred during route calculation.

pricingBucket

public final String pricingBucket()

The pricing bucket for which the query is charged at.

Returns:

The pricing bucket for which the query is charged at.

hasRoutes

public final boolean hasRoutes()

For responses, this returns true if the service returned a value for the Routes 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.

routes

public final List<Route> routes()

The path from the origin to the destination.

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 hasRoutes() method.

Returns:

The path from the origin to the destination.

toBuilder

public CalculateRoutesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CalculateRoutesResponse.Builder,CalculateRoutesResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static CalculateRoutesResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

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