Class RouteAvoidanceAreaGeometry
- java.lang.Object
-
- software.amazon.awssdk.services.georoutes.model.RouteAvoidanceAreaGeometry
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<RouteAvoidanceAreaGeometry.Builder,RouteAvoidanceAreaGeometry>
@Generated("software.amazon.awssdk:codegen") public final class RouteAvoidanceAreaGeometry extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RouteAvoidanceAreaGeometry.Builder,RouteAvoidanceAreaGeometry>
Geometry of the area to be avoided.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceRouteAvoidanceAreaGeometry.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<Double>boundingBox()Geometry defined as a bounding box.static RouteAvoidanceAreaGeometry.Builderbuilder()Corridorcorridor()Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasBoundingBox()For responses, this returns true if the service returned a value for the BoundingBox property.inthashCode()booleanhasPolygon()For responses, this returns true if the service returned a value for the Polygon property.booleanhasPolylinePolygon()For responses, this returns true if the service returned a value for the PolylinePolygon property.List<List<List<Double>>>polygon()Geometry defined as a polygon with only one linear ring.PolylineCorridorpolylineCorridor()Geometry defined as an encoded corridor - an encoded polyline with a radius that defines the width of the corridor.List<String>polylinePolygon()A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings).Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends RouteAvoidanceAreaGeometry.Builder>serializableBuilderClass()RouteAvoidanceAreaGeometry.BuildertoBuilder()StringtoString()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
-
corridor
public final Corridor corridor()
Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.
- Returns:
- Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.
-
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 theisEmpty()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 theisEmpty()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.
-
polylineCorridor
public final PolylineCorridor polylineCorridor()
Geometry defined as an encoded corridor - an encoded polyline with a radius that defines the width of the corridor.
- Returns:
- Geometry defined as an encoded corridor - an encoded polyline with a radius that defines the width of the corridor.
-
hasPolylinePolygon
public final boolean hasPolylinePolygon()
For responses, this returns true if the service returned a value for the PolylinePolygon property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
polylinePolygon
public final List<String> polylinePolygon()
A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings). For more information on polyline encoding, see https://github .com/heremaps/flexiblepolyline/blob/master/README.md.
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
hasPolylinePolygon()method.- Returns:
- A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings). For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.
-
toBuilder
public RouteAvoidanceAreaGeometry.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<RouteAvoidanceAreaGeometry.Builder,RouteAvoidanceAreaGeometry>
-
builder
public static RouteAvoidanceAreaGeometry.Builder builder()
-
serializableBuilderClass
public static Class<? extends RouteAvoidanceAreaGeometry.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-