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

Class RouteMatrixBoundaryGeometry

java.lang.Object

software.amazon.awssdk.services.georoutes.model.RouteMatrixBoundaryGeometry

All Implemented Interfaces:

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

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

Geometry of the routing boundary.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RouteMatrixBoundaryGeometry.Builder

Method Summary

Modifier and Type	Method	Description
RouteMatrixAutoCircle	autoCircle()	Provides the circle that was used while calculating the route.
List<Double>	boundingBox()	Geometry defined as a bounding box.
static RouteMatrixBoundaryGeometry.Builder	builder()
Circle	circle()	Geometry defined as a circle.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBoundingBox()	For responses, this returns true if the service returned a value for the BoundingBox property.
int	hashCode()
boolean	hasPolygon()	For responses, this returns true if the service returned a value for the Polygon property.
List<List<List<Double>>>	polygon()	Geometry defined as a polygon with only one linear ring.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RouteMatrixBoundaryGeometry.Builder>	serializableBuilderClass()
RouteMatrixBoundaryGeometry.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

autoCircle

public final RouteMatrixAutoCircle autoCircle()

Provides the circle that was used while calculating the route.

Returns:

Provides the circle that was used while calculating the route.

circle

public final Circle circle()

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

Returns:

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

hasBoundingBox

public final boolean hasBoundingBox()

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

boundingBox

public final List<Double> boundingBox()

Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.

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

Returns:

Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.

hasPolygon

public final boolean hasPolygon()

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

polygon

public final List<List<List<Double>>> polygon()

Geometry defined as a polygon with only one linear ring.

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

Returns:

Geometry defined as a polygon with only one linear ring.

toBuilder

public RouteMatrixBoundaryGeometry.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RouteMatrixBoundaryGeometry.Builder,RouteMatrixBoundaryGeometry>

builder

public static RouteMatrixBoundaryGeometry.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo