NetworkInsightsAnalysis (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.ec2.model.NetworkInsightsAnalysis

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

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

Describes a network insights analysis.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface NetworkInsightsAnalysis.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AlternatePathHint>`	`alternatePathHints()` Potential intermediate components.
`static NetworkInsightsAnalysis.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<Explanation>`	`explanations()` The explanations.
`List<String>`	`filterInArns()` The Amazon Resource Names (ARN) of the Amazon Web Services resources that the path must traverse.
`List<PathComponent>`	`forwardPathComponents()` The components in the path from source to destination.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAlternatePathHints()` For responses, this returns true if the service returned a value for the AlternatePathHints property.
`boolean`	`hasExplanations()` For responses, this returns true if the service returned a value for the Explanations property.
`boolean`	`hasFilterInArns()` For responses, this returns true if the service returned a value for the FilterInArns property.
`boolean`	`hasForwardPathComponents()` For responses, this returns true if the service returned a value for the ForwardPathComponents property.
`int`	`hashCode()`
`boolean`	`hasReturnPathComponents()` For responses, this returns true if the service returned a value for the ReturnPathComponents property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`networkInsightsAnalysisArn()` The Amazon Resource Name (ARN) of the network insights analysis.
`String`	`networkInsightsAnalysisId()` The ID of the network insights analysis.
`String`	`networkInsightsPathId()` The ID of the path.
`Boolean`	`networkPathFound()` Indicates whether the destination is reachable from the source.
`List<PathComponent>`	`returnPathComponents()` The components in the path from destination to source.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends NetworkInsightsAnalysis.Builder>`	`serializableBuilderClass()`
`Instant`	`startDate()` The time the analysis started.
`AnalysisStatus`	`status()` The status of the network insights analysis.
`String`	`statusAsString()` The status of the network insights analysis.
`String`	`statusMessage()` The status message, if the status is `failed`.
`List<Tag>`	`tags()` The tags.
`NetworkInsightsAnalysis.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`warningMessage()` The warning message.

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
  - 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.
  - 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 Amazon Web Services 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 Amazon Web Services 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:
    
    AnalysisStatus
  - 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:
    
    AnalysisStatus
  - 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.
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<NetworkInsightsAnalysis.Builder,NetworkInsightsAnalysis>
  - 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)
```
    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 NetworkInsightsAnalysis

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

networkInsightsAnalysisId

networkInsightsAnalysisArn

networkInsightsPathId

hasFilterInArns

filterInArns

startDate

status

statusAsString

statusMessage

warningMessage

networkPathFound

hasForwardPathComponents

forwardPathComponents

hasReturnPathComponents

returnPathComponents

hasExplanations

explanations

hasAlternatePathHints

alternatePathHints

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields