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>

  • Method Details

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

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

    • 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 is UnauthorizedOperation.

      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 is UnauthorizedOperation.

    • 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()
      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<DescribeNetworkInsightsAnalysesRequest.Builder,DescribeNetworkInsightsAnalysesRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • builder

      public static DescribeNetworkInsightsAnalysesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeNetworkInsightsAnalysesRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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