Class RouteVehicleSpan

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

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

    • carAccess

      public final List<RouteSpanCarAccessAttribute> carAccess()

      Access attributes for a car 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 hasCarAccess() method.

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

    • hasCarAccess

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

    • carAccessAsStrings

      public final List<String> carAccessAsStrings()

      Access attributes for a car 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 hasCarAccess() method.

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

    • 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: KilometersPerHour

      Returns:
      Dynamic speed details corresponding to the span.

      Unit: KilometersPerHour

    • functionalClassification

      public final Integer functionalClassification()

      Functional classification of the road segment corresponding to the span.

      Returns:
      Functional classification of the road segment corresponding to the span.

    • gate

      public final RouteSpanGateAttribute gate()

      Attributes corresponding to a gate. The gate is present at the end of the returned span.

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

      Returns:
      Attributes corresponding to a gate. The gate is present at the end of the returned span.
      See Also:

    • gateAsString

      public final String gateAsString()

      Attributes corresponding to a gate. The gate is present at the end of the returned span.

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

      Returns:
      Attributes corresponding to a gate. The gate is present at the end of the returned span.
      See Also:

    • 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 vehicle 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 vehicle span in available languages.

    • hasNotices

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

    • notices

      public final List<Integer> notices()

      Notices are additional information returned that indicate issues that occurred during route calculation.

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

      Returns:
      Notices are additional information returned that indicate issues that occurred during route calculation.

    • railwayCrossing

      public final RouteSpanRailwayCrossingAttribute railwayCrossing()

      Attributes corresponding to a railway crossing. The gate is present at the end of the returned span.

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

      Returns:
      Attributes corresponding to a railway crossing. The gate is present at the end of the returned span.
      See Also:

    • railwayCrossingAsString

      public final String railwayCrossingAsString()

      Attributes corresponding to a railway crossing. The gate is present at the end of the returned span.

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

      Returns:
      Attributes corresponding to a railway crossing. The gate is present at the end of the returned span.
      See Also:

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

    • scooterAccess

      public final List<RouteSpanScooterAccessAttribute> scooterAccess()

      Access attributes for a scooter 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 hasScooterAccess() method.

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

    • hasScooterAccess

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

    • scooterAccessAsStrings

      public final List<String> scooterAccessAsStrings()

      Access attributes for a scooter 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 hasScooterAccess() method.

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

    • speedLimit

      public final RouteSpanSpeedLimitDetails speedLimit()

      Speed limit details corresponding to the span.

      Unit: KilometersPerHour

      Returns:
      Speed limit details corresponding to the span.

      Unit: KilometersPerHour

    • hasTollSystems

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

    • tollSystems

      public final List<Integer> tollSystems()

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

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

    • truckAccess

      public final List<RouteSpanTruckAccessAttribute> truckAccess()

      Access attributes for a truck 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 hasTruckAccess() method.

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

    • hasTruckAccess

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

    • truckAccessAsStrings

      public final List<String> truckAccessAsStrings()

      Access attributes for a truck 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 hasTruckAccess() method.

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

    • hasTruckRoadTypes

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

    • truckRoadTypes

      public final List<Integer> truckRoadTypes()

      Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

      There are currently no other supported values as of 26th April 2024.

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

      Returns:
      Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

      There are currently no other supported values as of 26th April 2024.

    • 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

    • hasZones

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

    • zones

      public final List<Integer> zones()

      Zones corresponding to 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 hasZones() method.

      Returns:
      Zones corresponding to this leg of the route.

    • toBuilder

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

    • builder

      public static RouteVehicleSpan.Builder builder()

    • serializableBuilderClass

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