Class RouteToll

java.lang.Object
software.amazon.awssdk.services.georoutes.model.RouteToll
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RouteToll.Builder,RouteToll>

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

Provides details about toll information along a route, including the payment sites, applicable toll rates, toll systems, and the country associated with the toll collection.

See Also:
  • Method Details

    • country

      public final String country()

      The alpha-2 or alpha-3 character code for the country.

      Returns:
      The alpha-2 or alpha-3 character code for the country.
    • hasPaymentSites

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

      public final List<RouteTollPaymentSite> paymentSites()

      Locations or sites where the toll fare is collected.

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

      Returns:
      Locations or sites where the toll fare is collected.
    • hasRates

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

      public final List<RouteTollRate> rates()

      Toll rates that need to be paid to travel this leg of the route.

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

      Returns:
      Toll rates that need to be paid to travel this leg of the route.
    • hasSystems

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

      public final List<Integer> systems()

      Toll systems are authorities that collect payments for the toll.

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

      Returns:
      Toll systems are authorities that collect payments for the toll.
    • toBuilder

      public RouteToll.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<RouteToll.Builder,RouteToll>
      Returns:
      a builder for type T
    • builder

      public static RouteToll.Builder builder()
    • serializableBuilderClass

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