Class RoutePedestrianSpan

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

Span computed for the requested SpanAdditionalFeatures.

See Also:

  • Method Details

    • bestCaseDuration

      public final Long bestCaseDuration()

      Duration of the computed span without traffic congestion.

      Unit: seconds

      Returns:
      Duration of the computed span without traffic congestion.

      Unit: seconds

    • country

      public final String country()

      3 letter Country code corresponding to the Span.

      Returns:
      3 letter Country code corresponding to the Span.

    • distance

      public final Long distance()

      Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

      Returns:
      Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

    • duration

      public final Long duration()

      Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

      Unit: seconds

      Returns:
      Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.

      Unit: seconds

    • dynamicSpeed

      public final RouteSpanDynamicSpeedDetails dynamicSpeed()

      Dynamic speed details corresponding to the span.

      Unit: kilometers per hour

      Returns:
      Dynamic speed details corresponding to the span.

      Unit: kilometers per hour

    • functionalClassification

      public final Integer functionalClassification()

      A numerical value indicating the functional classification of the road segment corresponding to the span.

      Classification values are part of the hierarchical network that helps determine a logical and efficient route, and have the following definitions:

      1. Roads that allow for high volume, maximum speed traffic movement between and through major metropolitan areas.

      2. Roads that are used to channel traffic to functional class 1 roads for travel between and through cities in the shortest amount of time.

      3. Roads that intersect functional class 2 roads and provide a high volume of traffic movement at a lower level of mobility than functional class 2 roads.

      4. Roads that provide for a high volume of traffic movement at moderate speeds between neighborhoods.

      5. Roads with volume and traffic movement below the level of any other functional class.

      Returns:
      A numerical value indicating the functional classification of the road segment corresponding to the span.

      Classification values are part of the hierarchical network that helps determine a logical and efficient route, and have the following definitions:

      1. Roads that allow for high volume, maximum speed traffic movement between and through major metropolitan areas.

      2. Roads that are used to channel traffic to functional class 1 roads for travel between and through cities in the shortest amount of time.

      3. Roads that intersect functional class 2 roads and provide a high volume of traffic movement at a lower level of mobility than functional class 2 roads.

      4. Roads that provide for a high volume of traffic movement at moderate speeds between neighborhoods.

      5. Roads with volume and traffic movement below the level of any other functional class.

    • geometryOffset

      public final Integer geometryOffset()

      Offset in the leg geometry corresponding to the start of this span.

      Returns:
      Offset in the leg geometry corresponding to the start of this span.

    • hasIncidents

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

    • incidents

      public final List<Integer> incidents()

      Incidents corresponding to the span. These index into the Incidents in the parent Leg.

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

      Returns:
      Incidents corresponding to the span. These index into the Incidents in the parent Leg.

    • hasNames

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

    • names

      public final List<LocalizedString> names()

      Provides an array of names of the pedestrian span in available languages.

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

      Returns:
      Provides an array of names of the pedestrian span in available languages.

    • pedestrianAccess

      public final List<RouteSpanPedestrianAccessAttribute> pedestrianAccess()

      Access attributes for a pedestrian corresponding to the span.

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

      Returns:
      Access attributes for a pedestrian corresponding to the span.

    • hasPedestrianAccess

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

    • pedestrianAccessAsStrings

      public final List<String> pedestrianAccessAsStrings()

      Access attributes for a pedestrian corresponding to the span.

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

      Returns:
      Access attributes for a pedestrian corresponding to the span.

    • region

      public final String region()

      2-3 letter Region code corresponding to the Span. This is either a province or a state.

      Returns:
      2-3 letter Region code corresponding to the Span. This is either a province or a state.

    • roadAttributes

      public final List<RouteSpanRoadAttribute> roadAttributes()

      Attributes for the road segment corresponding to the span.

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

      Returns:
      Attributes for the road segment corresponding to the span.

    • hasRoadAttributes

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

    • roadAttributesAsStrings

      public final List<String> roadAttributesAsStrings()

      Attributes for the road segment corresponding to the span.

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

      Returns:
      Attributes for the road segment corresponding to the span.

    • hasRouteNumbers

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

    • routeNumbers

      public final List<RouteNumber> routeNumbers()

      Designated route name or number corresponding to the span.

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

      Returns:
      Designated route name or number corresponding to the span.

    • speedLimit

      public final RouteSpanSpeedLimitDetails speedLimit()

      Speed limit details corresponding to the span.

      Unit: kilometers per hour

      Returns:
      Speed limit details corresponding to the span.

      Unit: kilometers per hour

    • typicalDuration

      public final Long typicalDuration()

      Duration of the computed span under typical traffic congestion.

      Unit: seconds

      Returns:
      Duration of the computed span under typical traffic congestion.

      Unit: seconds

    • toBuilder

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

    • builder

      public static RoutePedestrianSpan.Builder builder()

    • serializableBuilderClass

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