Package software.amazon.awssdk.services.georoutes.model

Class RouteTrafficOptions

java.lang.Object

software.amazon.awssdk.services.georoutes.model.RouteTrafficOptions

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RouteTrafficOptions.Builder,RouteTrafficOptions>

@Generated("software.amazon.awssdk:codegen")
public final class RouteTrafficOptions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RouteTrafficOptions.Builder,RouteTrafficOptions>

Traffic options for the route.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RouteTrafficOptions.Builder

Method Summary

Modifier and Type	Method	Description
static RouteTrafficOptions.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Long	flowEventThresholdOverride()	Duration for which flow traffic is considered valid.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RouteTrafficOptions.Builder>	serializableBuilderClass()
RouteTrafficOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
TrafficUsage	usage()	Determines if traffic should be used or ignored while calculating the route.
String	usageAsString()	Determines if traffic should be used or ignored while calculating the route.

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

flowEventThresholdOverride

public final Long 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

public final TrafficUsage 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 return TrafficUsage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from usageAsString().

Returns:

Determines if traffic should be used or ignored while calculating the route.

Default Value: UseTrafficData

See Also:

TrafficUsage

usageAsString

public final String 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 return TrafficUsage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from usageAsString().

Returns:

Determines if traffic should be used or ignored while calculating the route.

Default Value: UseTrafficData

See Also:

TrafficUsage

toBuilder

public RouteTrafficOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RouteTrafficOptions.Builder,RouteTrafficOptions>

builder

public static RouteTrafficOptions.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo