Class RouteRoad

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

The road on the route.

See Also:

  • Method Details

    • hasRoadName

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

    • roadName

      public final List<LocalizedString> roadName()

      Name of the road (localized).

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

      Returns:
      Name of the road (localized).

    • hasRouteNumber

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

    • routeNumber

      public final List<RouteNumber> routeNumber()

      Route number of the 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 hasRouteNumber() method.

      Returns:
      Route number of the road.

    • hasTowards

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

    • towards

      public final List<LocalizedString> towards()

      Names of destinations that can be reached when traveling on the 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 hasTowards() method.

      Returns:
      Names of destinations that can be reached when traveling on the road.

    • type

      public final RouteRoadType type()

      The type of road.

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

      Returns:
      The type of road.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of road.

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

      Returns:
      The type of road.
      See Also:

    • toBuilder

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

    • builder

      public static RouteRoad.Builder builder()

    • serializableBuilderClass

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