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:

  • Method Details

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

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

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

    • 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)
      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.