Class GetAnalysisReportResultsResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.networkfirewall.model.NetworkFirewallResponse
software.amazon.awssdk.services.networkfirewall.model.GetAnalysisReportResultsResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetAnalysisReportResultsResponse.Builder,GetAnalysisReportResultsResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetAnalysisReportResultsResponse extends NetworkFirewallResponse implements ToCopyableBuilder<GetAnalysisReportResultsResponse.Builder,GetAnalysisReportResultsResponse>

  • Method Details

    • status

      public final String status()

      The status of the analysis report you specify. Statuses include RUNNING, COMPLETED, or FAILED.

      Returns:
      The status of the analysis report you specify. Statuses include RUNNING, COMPLETED, or FAILED.

    • startTime

      public final Instant startTime()

      The date and time within the last 30 days from which to start retrieving analysis data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ.

      Returns:
      The date and time within the last 30 days from which to start retrieving analysis data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ.

    • endTime

      public final Instant endTime()

      The date and time, up to the current date, from which to stop retrieving analysis data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

      Returns:
      The date and time, up to the current date, from which to stop retrieving analysis data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

    • reportTime

      public final Instant reportTime()

      The date and time the analysis report was ran.

      Returns:
      The date and time the analysis report was ran.

    • analysisType

      public final EnabledAnalysisType analysisType()

      The type of traffic that will be used to generate a report.

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

      Returns:
      The type of traffic that will be used to generate a report.
      See Also:

    • analysisTypeAsString

      public final String analysisTypeAsString()

      The type of traffic that will be used to generate a report.

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

      Returns:
      The type of traffic that will be used to generate a report.
      See Also:

    • nextToken

      public final String nextToken()

      When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

      Returns:
      When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

    • hasAnalysisReportResults

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

    • analysisReportResults

      public final List<AnalysisTypeReportResult> analysisReportResults()

      Retrieves the results of a traffic analysis report.

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

      Returns:
      Retrieves the results of a traffic analysis report.

    • toBuilder

      public GetAnalysisReportResultsResponse.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<GetAnalysisReportResultsResponse.Builder,GetAnalysisReportResultsResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetAnalysisReportResultsResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.