Package software.amazon.awssdk.services.networkmanager.model

Class RouteAnalysis

java.lang.Object

software.amazon.awssdk.services.networkmanager.model.RouteAnalysis

All Implemented Interfaces:

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

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

Describes a route analysis.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RouteAnalysis.Builder

Method Summary

Modifier and Type	Method	Description
static RouteAnalysis.Builder	builder()
RouteAnalysisEndpointOptions	destination()	The destination.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
RouteAnalysisPath	forwardPath()	The forward path.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	globalNetworkId()	The ID of the global network.
int	hashCode()
Boolean	includeReturnPath()	Indicates whether to analyze the return path.
String	ownerAccountId()	The ID of the AWS account that created the route analysis.
RouteAnalysisPath	returnPath()	The return path.
String	routeAnalysisId()	The ID of the route analysis.
List<SdkField<?>>	sdkFields()
static Class<? extends RouteAnalysis.Builder>	serializableBuilderClass()
RouteAnalysisEndpointOptions	source()	The source.
Instant	startTimestamp()	The time that the analysis started.
RouteAnalysisStatus	status()	The status of the route analysis.
String	statusAsString()	The status of the route analysis.
RouteAnalysis.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Boolean	useMiddleboxes()	Indicates whether to include the location of middlebox appliances in the route analysis.

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

globalNetworkId

public final String globalNetworkId()

The ID of the global network.

Returns:

The ID of the global network.

ownerAccountId

public final String ownerAccountId()

The ID of the AWS account that created the route analysis.

Returns:

The ID of the AWS account that created the route analysis.

routeAnalysisId

public final String routeAnalysisId()

The ID of the route analysis.

Returns:

The ID of the route analysis.

startTimestamp

public final Instant startTimestamp()

The time that the analysis started.

Returns:

The time that the analysis started.

status

public final RouteAnalysisStatus status()

The status of the route analysis.

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

Returns:

The status of the route analysis.

See Also:

RouteAnalysisStatus

statusAsString

public final String statusAsString()

The status of the route analysis.

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

Returns:

The status of the route analysis.

See Also:

RouteAnalysisStatus

source

public final RouteAnalysisEndpointOptions source()

The source.

Returns:

The source.

destination

public final RouteAnalysisEndpointOptions destination()

The destination.

Returns:

The destination.

includeReturnPath

public final Boolean includeReturnPath()

Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.

Returns:

Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.

useMiddleboxes

public final Boolean useMiddleboxes()

Indicates whether to include the location of middlebox appliances in the route analysis.

Returns:

Indicates whether to include the location of middlebox appliances in the route analysis.

forwardPath

public final RouteAnalysisPath forwardPath()

The forward path.

Returns:

The forward path.

returnPath

public final RouteAnalysisPath returnPath()

The return path.

Returns:

The return path.

toBuilder

public RouteAnalysis.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RouteAnalysis.Builder,RouteAnalysis>

builder

public static RouteAnalysis.Builder builder()

serializableBuilderClass

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