Class NetworkInsightsAnalysis
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<NetworkInsightsAnalysis.Builder,
NetworkInsightsAnalysis>
Describes a network insights analysis.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe member accounts that contain resources that the path can traverse.final List
<AlternatePathHint> Potential intermediate components.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<Explanation> The explanations.The Amazon Resource Names (ARN) of the resources that the path must traverse.final List
<PathComponent> The components in the path from source to destination.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AdditionalAccounts property.final boolean
For responses, this returns true if the service returned a value for the AlternatePathHints property.final boolean
For responses, this returns true if the service returned a value for the Explanations property.final boolean
For responses, this returns true if the service returned a value for the FilterInArns property.final boolean
For responses, this returns true if the service returned a value for the ForwardPathComponents property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ReturnPathComponents property.final boolean
For responses, this returns true if the service returned a value for the SuggestedAccounts property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The Amazon Resource Name (ARN) of the network insights analysis.final String
The ID of the network insights analysis.final String
The ID of the path.final Boolean
Indicates whether the destination is reachable from the source.final List
<PathComponent> The components in the path from destination to source.static Class
<? extends NetworkInsightsAnalysis.Builder> final Instant
The time the analysis started.final AnalysisStatus
status()
The status of the network insights analysis.final String
The status of the network insights analysis.final String
The status message, if the status isfailed
.Potential intermediate accounts.tags()
The tags.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The warning message.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
networkInsightsAnalysisId
The ID of the network insights analysis.
- Returns:
- The ID of the network insights analysis.
-
networkInsightsAnalysisArn
The Amazon Resource Name (ARN) of the network insights analysis.
- Returns:
- The Amazon Resource Name (ARN) of the network insights analysis.
-
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 theisEmpty()
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
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 theisEmpty()
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
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
The time the analysis started.
- Returns:
- The time the analysis started.
-
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 returnAnalysisStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the network insights analysis.
- See Also:
-
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 returnAnalysisStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the network insights analysis.
- See Also:
-
statusMessage
The status message, if the status is
failed
.- Returns:
- The status message, if the status is
failed
.
-
warningMessage
The warning message.
- Returns:
- The warning message.
-
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<NetworkInsightsAnalysis.Builder,
NetworkInsightsAnalysis> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-