Class NetworkInsightsAnalysis

java.lang.Object
software.amazon.awssdk.services.ec2.model.NetworkInsightsAnalysis
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<NetworkInsightsAnalysis.Builder,NetworkInsightsAnalysis>

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

Describes a network insights analysis.

See Also:
  • Method Details

    • networkInsightsAnalysisId

      public final String networkInsightsAnalysisId()

      The ID of the network insights analysis.

      Returns:
      The ID of the network insights analysis.
    • networkInsightsAnalysisArn

      public final String networkInsightsAnalysisArn()

      The Amazon Resource Name (ARN) of the network insights analysis.

      Returns:
      The Amazon Resource Name (ARN) of the network insights analysis.
    • networkInsightsPathId

      public final String networkInsightsPathId()

      The ID of the path.

      Returns:
      The ID of the path.
    • hasAdditionalAccounts

      public final boolean hasAdditionalAccounts()
      For responses, this returns true if the service returned a value for the AdditionalAccounts 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.
    • additionalAccounts

      public final List<String> additionalAccounts()

      The member accounts that contain resources that the path can traverse.

      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 hasAdditionalAccounts() method.

      Returns:
      The member accounts that contain resources that the path can traverse.
    • hasFilterInArns

      public final boolean hasFilterInArns()
      For responses, this returns true if the service returned a value for the FilterInArns 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.
    • filterInArns

      public final List<String> filterInArns()

      The Amazon Resource Names (ARN) of the resources that the path must traverse.

      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 hasFilterInArns() method.

      Returns:
      The Amazon Resource Names (ARN) of the resources that the path must traverse.
    • startDate

      public final Instant startDate()

      The time the analysis started.

      Returns:
      The time the analysis started.
    • status

      public final AnalysisStatus status()

      The status of the network insights analysis.

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

      Returns:
      The status of the network insights analysis.
      See Also:
    • statusAsString

      public final String statusAsString()

      The status of the network insights analysis.

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

      Returns:
      The status of the network insights analysis.
      See Also:
    • statusMessage

      public final String statusMessage()

      The status message, if the status is failed.

      Returns:
      The status message, if the status is failed.
    • warningMessage

      public final String warningMessage()

      The warning message.

      Returns:
      The warning message.
    • networkPathFound

      public final Boolean networkPathFound()

      Indicates whether the destination is reachable from the source.

      Returns:
      Indicates whether the destination is reachable from the source.
    • hasForwardPathComponents

      public final boolean hasForwardPathComponents()
      For responses, this returns true if the service returned a value for the ForwardPathComponents 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.
    • forwardPathComponents

      public final List<PathComponent> forwardPathComponents()

      The components in the path from source to destination.

      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 hasForwardPathComponents() method.

      Returns:
      The components in the path from source to destination.
    • hasReturnPathComponents

      public final boolean hasReturnPathComponents()
      For responses, this returns true if the service returned a value for the ReturnPathComponents 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.
    • returnPathComponents

      public final List<PathComponent> returnPathComponents()

      The components in the path from destination to source.

      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 hasReturnPathComponents() method.

      Returns:
      The components in the path from destination to source.
    • hasExplanations

      public final boolean hasExplanations()
      For responses, this returns true if the service returned a value for the Explanations 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.
    • explanations

      public final List<Explanation> explanations()

      The explanations. For more information, see Reachability Analyzer explanation codes.

      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 hasExplanations() method.

      Returns:
      The explanations. For more information, see Reachability Analyzer explanation codes.
    • hasAlternatePathHints

      public final boolean hasAlternatePathHints()
      For responses, this returns true if the service returned a value for the AlternatePathHints 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.
    • alternatePathHints

      public final List<AlternatePathHint> alternatePathHints()

      Potential intermediate components.

      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 hasAlternatePathHints() method.

      Returns:
      Potential intermediate components.
    • hasSuggestedAccounts

      public final boolean hasSuggestedAccounts()
      For responses, this returns true if the service returned a value for the SuggestedAccounts 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.
    • suggestedAccounts

      public final List<String> suggestedAccounts()

      Potential intermediate accounts.

      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 hasSuggestedAccounts() method.

      Returns:
      Potential intermediate accounts.
    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.
    • tags

      public final List<Tag> tags()

      The tags.

      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 hasTags() method.

      Returns:
      The tags.
    • toBuilder

      public NetworkInsightsAnalysis.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<NetworkInsightsAnalysis.Builder,NetworkInsightsAnalysis>
      Returns:
      a builder for type T
    • builder

      public static NetworkInsightsAnalysis.Builder builder()
    • serializableBuilderClass

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