RouteAnalysisCompletion (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.networkmanager.model.RouteAnalysisCompletion

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<RouteAnalysisCompletion.Builder,RouteAnalysisCompletion>

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

Describes the status of an analysis at completion.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RouteAnalysisCompletion.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RouteAnalysisCompletion.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RouteAnalysisCompletion.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasReasonContext()` For responses, this returns true if the service returned a value for the ReasonContext property.
`RouteAnalysisCompletionReasonCode`	`reasonCode()` The reason code.
`String`	`reasonCodeAsString()` The reason code.
`Map<String,String>`	`reasonContext()` Additional information about the path.
`RouteAnalysisCompletionResultCode`	`resultCode()` The result of the analysis.
`String`	`resultCodeAsString()` The result of the analysis.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RouteAnalysisCompletion.Builder>`	`serializableBuilderClass()`
`RouteAnalysisCompletion.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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
  - resultCode
```
public final RouteAnalysisCompletionResultCode resultCode()
```
    The result of the analysis. If the status is NOT_CONNECTED, check the reason code.
    
    If the service returns an enum value that is not available in the current SDK version, resultCode will return RouteAnalysisCompletionResultCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resultCodeAsString().
    
    Returns:
    
    The result of the analysis. If the status is NOT_CONNECTED, check the reason code.
    
    See Also:
    
    RouteAnalysisCompletionResultCode
  - resultCodeAsString
```
public final String resultCodeAsString()
```
    The result of the analysis. If the status is NOT_CONNECTED, check the reason code.
    
    If the service returns an enum value that is not available in the current SDK version, resultCode will return RouteAnalysisCompletionResultCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resultCodeAsString().
    
    Returns:
    
    The result of the analysis. If the status is NOT_CONNECTED, check the reason code.
    
    See Also:
    
    RouteAnalysisCompletionResultCode
  - reasonCode
```
public final RouteAnalysisCompletionReasonCode reasonCode()
```
    The reason code. Available only if a connection is not found.
    - BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.
    - CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
    - INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.
    - MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
    - ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
    - TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
    - TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
    - TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
    - TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not associated.
    If the service returns an enum value that is not available in the current SDK version, reasonCode will return RouteAnalysisCompletionReasonCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reasonCodeAsString().
    Returns:
    The reason code. Available only if a connection is not found.
    
    BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.
    
    CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
    
    INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.
    
    MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
    
    ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
    
    TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
    
    TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
    
    TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
    
    TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not associated.
    See Also:
    
    RouteAnalysisCompletionReasonCode
  - reasonCodeAsString
```
public final String reasonCodeAsString()
```
    The reason code. Available only if a connection is not found.
    - BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.
    - CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
    - INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.
    - MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
    - ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
    - TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
    - TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
    - TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
    - TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not associated.
    If the service returns an enum value that is not available in the current SDK version, reasonCode will return RouteAnalysisCompletionReasonCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reasonCodeAsString().
    Returns:
    The reason code. Available only if a connection is not found.
    
    BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.
    
    CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
    
    INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.
    
    MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
    
    ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
    
    TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
    
    TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
    
    TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
    
    TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not associated.
    See Also:
    
    RouteAnalysisCompletionReasonCode
  - hasReasonContext
```
public final boolean hasReasonContext()
```
    For responses, this returns true if the service returned a value for the ReasonContext 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.
  - reasonContext
```
public final Map<String,String> reasonContext()
```
    Additional information about the path. Available only if a connection is not found.
    
    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 hasReasonContext() method.
    
    Returns:
    
    Additional information about the path. Available only if a connection is not found.
  - toBuilder
```
public RouteAnalysisCompletion.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RouteAnalysisCompletion.Builder,RouteAnalysisCompletion>
  - builder
```
public static RouteAnalysisCompletion.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RouteAnalysisCompletion.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

Class RouteAnalysisCompletion

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

resultCode

resultCodeAsString

reasonCode

reasonCodeAsString

hasReasonContext

reasonContext

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields