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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceRoutePedestrianSpan.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description LongbestCaseDuration()Duration of the computed span without traffic congestion.static RoutePedestrianSpan.Builderbuilder()Stringcountry()3 letter Country code corresponding to the Span.Longdistance()Distance of the computed span.Longduration()Duration of the computed span.RouteSpanDynamicSpeedDetailsdynamicSpeed()Dynamic speed details corresponding to the span.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)IntegerfunctionalClassification()Functional classification of the road segment corresponding to the span.IntegergeometryOffset()Offset in the leg geometry corresponding to the start of this span.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasIncidents()For responses, this returns true if the service returned a value for the Incidents property.booleanhasNames()For responses, this returns true if the service returned a value for the Names property.booleanhasPedestrianAccess()For responses, this returns true if the service returned a value for the PedestrianAccess property.booleanhasRoadAttributes()For responses, this returns true if the service returned a value for the RoadAttributes property.booleanhasRouteNumbers()For responses, this returns true if the service returned a value for the RouteNumbers property.List<Integer>incidents()Incidents corresponding to the span.List<LocalizedString>names()Provides an array of names of the pedestrian span in available languages.List<RouteSpanPedestrianAccessAttribute>pedestrianAccess()Access attributes for a pedestrian corresponding to the span.List<String>pedestrianAccessAsStrings()Access attributes for a pedestrian corresponding to the span.Stringregion()2-3 letter Region code corresponding to the Span.List<RouteSpanRoadAttribute>roadAttributes()Attributes for the road segment corresponding to the span.List<String>roadAttributesAsStrings()Attributes for the road segment corresponding to the span.List<RouteNumber>routeNumbers()Designated route name or number corresponding to the span.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends RoutePedestrianSpan.Builder>serializableBuilderClass()RouteSpanSpeedLimitDetailsspeedLimit()Speed limit details corresponding to the span.RoutePedestrianSpan.BuildertoBuilder()StringtoString()Returns a string representation of this object.LongtypicalDuration()Duration of the computed span under typical traffic congestion.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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:
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.
-
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 theisEmpty()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 theisEmpty()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 theisEmpty()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 theisEmpty()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 theisEmpty()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:
KilometersPerHour- Returns:
- Speed limit details corresponding to the span.
Unit:
KilometersPerHour
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<RoutePedestrianSpan.Builder,RoutePedestrianSpan>
-
builder
public static RoutePedestrianSpan.Builder builder()
-
serializableBuilderClass
public static Class<? extends RoutePedestrianSpan.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-