Class RouteTrafficOptions
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<RouteTrafficOptions.Builder,
RouteTrafficOptions>
Traffic options for the route.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic RouteTrafficOptions.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Long
Duration for which flow traffic is considered valid.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends RouteTrafficOptions.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final TrafficUsage
usage()
Determines if traffic should be used or ignored while calculating the route.final String
Determines if traffic should be used or ignored while calculating the route.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
flowEventThresholdOverride
Duration for which flow traffic is considered valid. For this period, the flow traffic is used over historical traffic data. Flow traffic refers to congestion, which changes very quickly. Duration in seconds for which flow traffic event would be considered valid. While flow traffic event is valid it will be used over the historical traffic data.
- Returns:
- Duration for which flow traffic is considered valid. For this period, the flow traffic is used over historical traffic data. Flow traffic refers to congestion, which changes very quickly. Duration in seconds for which flow traffic event would be considered valid. While flow traffic event is valid it will be used over the historical traffic data.
-
usage
Determines if traffic should be used or ignored while calculating the route.
Default Value:
UseTrafficData
If the service returns an enum value that is not available in the current SDK version,
usage
will returnTrafficUsage.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromusageAsString()
.- Returns:
- Determines if traffic should be used or ignored while calculating the route.
Default Value:
UseTrafficData
- See Also:
-
usageAsString
Determines if traffic should be used or ignored while calculating the route.
Default Value:
UseTrafficData
If the service returns an enum value that is not available in the current SDK version,
usage
will returnTrafficUsage.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromusageAsString()
.- Returns:
- Determines if traffic should be used or ignored while calculating the route.
Default Value:
UseTrafficData
- See Also:
-
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 interfaceToCopyableBuilder<RouteTrafficOptions.Builder,
RouteTrafficOptions> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-