Class RouteAnalysisCompletion

java.lang.Object
software.amazon.awssdk.services.networkmanager.model.RouteAnalysisCompletion
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RouteAnalysisCompletion.Builder,RouteAnalysisCompletion>
@Generated("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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<RouteAnalysisCompletion.Builder,RouteAnalysisCompletion>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.