Class IsolineAvoidanceAreaGeometry

java.lang.Object
software.amazon.awssdk.services.georoutes.model.IsolineAvoidanceAreaGeometry
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<IsolineAvoidanceAreaGeometry.Builder,IsolineAvoidanceAreaGeometry>
@Generated("software.amazon.awssdk:codegen") public final class IsolineAvoidanceAreaGeometry extends Object implements SdkPojo, Serializable, ToCopyableBuilder<IsolineAvoidanceAreaGeometry.Builder,IsolineAvoidanceAreaGeometry>

Defines an area to avoid during calculations using one of several supported geometry types. The service will prefer routes that avoid these areas when possible.

See Also:

  • Method Details

    • 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()

      A rectangular area defined by its southwest and northeast corners: [min longitude, min latitude, max longitude, max latitude].

      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:
      A rectangular area defined by its southwest and northeast corners: [min longitude, min latitude, max longitude, max latitude].

    • corridor

      public final Corridor corridor()

      A buffer zone around a line, defined by a series of coordinates and a radius in meters.

      Returns:
      A buffer zone around a line, defined by a series of coordinates and a radius in meters.

    • 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()

      A polygon defined by a list of coordinate rings. The first ring defines the outer boundary; subsequent rings will be ignored.

      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:
      A polygon defined by a list of coordinate rings. The first ring defines the outer boundary; subsequent rings will be ignored.

    • polylineCorridor

      public final PolylineCorridor polylineCorridor()

      A buffer zone around a compressed polyline, defined by an encoded polyline string and a radius in meters. For more information on polyline encoding, see https://github.com/aws-geospatial/polyline.

      Returns:
      A buffer zone around a compressed polyline, defined by an encoded polyline string and a radius in meters. For more information on polyline encoding, see https://github.com/aws-geospatial/polyline.

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

    • polylinePolygon

      public final List<String> polylinePolygon()

      A polygon defined by encoded polyline strings. The first string defines the outer boundary; subsequent strings will be ignored. For more information on polyline encoding, see https://github.com/aws-geospatial/polyline.

      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 polygon defined by encoded polyline strings. The first string defines the outer boundary; subsequent strings will be ignored. For more information on polyline encoding, see https://github.com/aws-geospatial/polyline.

    • toBuilder

      public IsolineAvoidanceAreaGeometry.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<IsolineAvoidanceAreaGeometry.Builder,IsolineAvoidanceAreaGeometry>
      Returns:
      a builder for type T

    • builder

      public static IsolineAvoidanceAreaGeometry.Builder builder()

    • serializableBuilderClass

      public static Class<? extends IsolineAvoidanceAreaGeometry.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.