Class DescribeNetworkInsightsAnalysesRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.DescribeNetworkInsightsAnalysesRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeNetworkInsightsAnalysesRequest.Builder,DescribeNetworkInsightsAnalysesRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeNetworkInsightsAnalysesRequest extends Ec2Request implements ToCopyableBuilder<DescribeNetworkInsightsAnalysesRequest.Builder,DescribeNetworkInsightsAnalysesRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeNetworkInsightsAnalysesRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Instant
analysisEndTime()
The time when the network insights analyses ended.Instant
analysisStartTime()
The time when the network insights analyses started.static DescribeNetworkInsightsAnalysesRequest.Builder
builder()
Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
List<Filter>
filters()
The filters.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasFilters()
For responses, this returns true if the service returned a value for the Filters property.int
hashCode()
boolean
hasNetworkInsightsAnalysisIds()
For responses, this returns true if the service returned a value for the NetworkInsightsAnalysisIds property.Integer
maxResults()
The maximum number of results to return with a single call.List<String>
networkInsightsAnalysisIds()
The ID of the network insights analyses.String
networkInsightsPathId()
The ID of the path.String
nextToken()
The token for the next page of results.List<SdkField<?>>
sdkFields()
static Class<? extends DescribeNetworkInsightsAnalysesRequest.Builder>
serializableBuilderClass()
DescribeNetworkInsightsAnalysesRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
hasNetworkInsightsAnalysisIds
public final boolean hasNetworkInsightsAnalysisIds()
For responses, this returns true if the service returned a value for the NetworkInsightsAnalysisIds 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.
-
networkInsightsAnalysisIds
public final List<String> networkInsightsAnalysisIds()
The ID of the network insights analyses. You must specify either analysis IDs or a path ID.
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
hasNetworkInsightsAnalysisIds()
method.- Returns:
- The ID of the network insights analyses. You must specify either analysis IDs or a path ID.
-
networkInsightsPathId
public final String networkInsightsPathId()
The ID of the path. You must specify either a path ID or analysis IDs.
- Returns:
- The ID of the path. You must specify either a path ID or analysis IDs.
-
analysisStartTime
public final Instant analysisStartTime()
The time when the network insights analyses started.
- Returns:
- The time when the network insights analyses started.
-
analysisEndTime
public final Instant analysisEndTime()
The time when the network insights analyses ended.
- Returns:
- The time when the network insights analyses ended.
-
hasFilters
public final boolean hasFilters()
For responses, this returns true if the service returned a value for the Filters 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.
-
filters
public final List<Filter> filters()
The filters. The following are the possible values:
-
path-found - A Boolean value that indicates whether a feasible path is found.
-
status - The status of the analysis (running | succeeded | failed).
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
hasFilters()
method.- Returns:
- The filters. The following are the possible values:
-
path-found - A Boolean value that indicates whether a feasible path is found.
-
status - The status of the analysis (running | succeeded | failed).
-
-
-
maxResults
public final Integer maxResults()
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned
nextToken
value.- Returns:
- The maximum number of results to return with a single call. To retrieve the remaining results, make
another call with the returned
nextToken
value.
-
dryRun
public final Boolean dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Checks whether you have the required permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
nextToken
public final String nextToken()
The token for the next page of results.
- Returns:
- The token for the next page of results.
-
toBuilder
public DescribeNetworkInsightsAnalysesRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeNetworkInsightsAnalysesRequest.Builder,DescribeNetworkInsightsAnalysesRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static DescribeNetworkInsightsAnalysesRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeNetworkInsightsAnalysesRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-