Class CalculateIsolinesResponse

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.CalculateIsolinesResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CalculateIsolinesResponse.Builder,CalculateIsolinesResponse>
@Generated("software.amazon.awssdk:codegen") public final class CalculateIsolinesResponse extends GeoRoutesResponse implements ToCopyableBuilder<CalculateIsolinesResponse.Builder,CalculateIsolinesResponse>

  • Method Details

    • arrivalTime

      public final String arrivalTime()

      Time of arrival at the destination, used for traffic calculations. This attribute is returned only if the Destination and ArrivalTime attributes were provided in the request.

      Time format: YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

      Examples:

      2020-04-22T17:57:24Z

      2020-04-22T17:57:24+02:00

      Returns:
      Time of arrival at the destination, used for traffic calculations. This attribute is returned only if the Destination and ArrivalTime attributes were provided in the request.

      Time format: YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

      Examples:

      2020-04-22T17:57:24Z

      2020-04-22T17:57:24+02:00

    • departureTime

      public final String departureTime()

      Time of departure from the origin, used for traffic calculations. This attribute is returned when Origin was provided in the request and either a specific departure time was requested ( DepartureTime) or DepartNow was set to true.

      Time format: YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

      Examples:

      2020-04-22T17:57:24Z

      2020-04-22T17:57:24+02:00

      Returns:
      Time of departure from the origin, used for traffic calculations. This attribute is returned when Origin was provided in the request and either a specific departure time was requested ( DepartureTime) or DepartNow was set to true.

      Time format: YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

      Examples:

      2020-04-22T17:57:24Z

      2020-04-22T17:57:24+02:00

    • isolineGeometryFormat

      public final GeometryFormat isolineGeometryFormat()

      The format of the returned geometries, matching the format specified in the request. Either FlexiblePolyline for compact encoding or Simple for GeoJSON-compatible coordinates.

      Default value:FlexiblePolyline

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

      Returns:
      The format of the returned geometries, matching the format specified in the request. Either FlexiblePolyline for compact encoding or Simple for GeoJSON-compatible coordinates.

      Default value:FlexiblePolyline

      See Also:

    • isolineGeometryFormatAsString

      public final String isolineGeometryFormatAsString()

      The format of the returned geometries, matching the format specified in the request. Either FlexiblePolyline for compact encoding or Simple for GeoJSON-compatible coordinates.

      Default value:FlexiblePolyline

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

      Returns:
      The format of the returned geometries, matching the format specified in the request. Either FlexiblePolyline for compact encoding or Simple for GeoJSON-compatible coordinates.

      Default value:FlexiblePolyline

      See Also:

    • hasIsolines

      public final boolean hasIsolines()
      For responses, this returns true if the service returned a value for the Isolines 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.

    • isolines

      public final List<Isoline> isolines()

      Reachable areas, or isolines, for each threshold specified in the request.

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

      Returns:
      Reachable areas, or isolines, for each threshold specified in the request.

    • pricingBucket

      public final String pricingBucket()

      The pricing bucket applied to this calculation. Different buckets apply based on the travel mode and thresholds used.

      Returns:
      The pricing bucket applied to this calculation. Different buckets apply based on the travel mode and thresholds used.

    • hasSnappedDestination

      public final boolean hasSnappedDestination()
      For responses, this returns true if the service returned a value for the SnappedDestination 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.

    • snappedDestination

      public final List<Double> snappedDestination()

      The actual point on the road network used for calculations, which may differ from the requested destination if Destination was not directly on a road.

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

      Returns:
      The actual point on the road network used for calculations, which may differ from the requested destination if Destination was not directly on a road.

    • hasSnappedOrigin

      public final boolean hasSnappedOrigin()
      For responses, this returns true if the service returned a value for the SnappedOrigin 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.

    • snappedOrigin

      public final List<Double> snappedOrigin()

      The actual point on the road network used for calculations, which may differ from the requested origin if Origin was not directly on a road.

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

      Returns:
      The actual point on the road network used for calculations, which may differ from the requested origin if Origin was not directly on a road.

    • toBuilder

      public CalculateIsolinesResponse.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<CalculateIsolinesResponse.Builder,CalculateIsolinesResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static CalculateIsolinesResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CalculateIsolinesResponse.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)
      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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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