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

Class CalculateRouteMatrixResponse

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.CalculateRouteMatrixResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CalculateRouteMatrixResponse.Builder,CalculateRouteMatrixResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CalculateRouteMatrixResponse.Builder

Method Summary

Modifier and Type	Method	Description
static CalculateRouteMatrixResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	errorCount()	The count of error results in the route matrix.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRouteMatrix()	For responses, this returns true if the service returned a value for the RouteMatrix property.
String	pricingBucket()	The pricing bucket for which the query is charged at.
List<List<RouteMatrixEntry>>	routeMatrix()	The calculated route matrix containing the results for all pairs of Origins to Destination positions.
RouteMatrixBoundary	routingBoundary()	Boundary within which the matrix is to be calculated.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CalculateRouteMatrixResponse.Builder>	serializableBuilderClass()
CalculateRouteMatrixResponse.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

errorCount

public final Integer errorCount()

The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.

Returns:

The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.

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.

hasRouteMatrix

public final boolean hasRouteMatrix()

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

routeMatrix

public final List<List<RouteMatrixEntry>> routeMatrix()

The calculated route matrix containing the results for all pairs of Origins to Destination positions. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destination positions.

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

Returns:

The calculated route matrix containing the results for all pairs of Origins to Destination positions. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destination positions.

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.

toBuilder

public CalculateRouteMatrixResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CalculateRouteMatrixResponse.Builder,CalculateRouteMatrixResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static CalculateRouteMatrixResponse.Builder builder()

serializableBuilderClass

public static Class<? extends CalculateRouteMatrixResponse.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