Class AnalysisReport

java.lang.Object
software.amazon.awssdk.services.networkfirewall.model.AnalysisReport
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AnalysisReport.Builder,AnalysisReport>
@Generated("software.amazon.awssdk:codegen") public final class AnalysisReport extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AnalysisReport.Builder,AnalysisReport>

A report that captures key activity from the last 30 days of network traffic monitored by your firewall.

You can generate up to one report per traffic type, per 30 day period. For example, when you successfully create an HTTP traffic report, you cannot create another HTTP traffic report until 30 days pass. Alternatively, if you generate a report that combines metrics on both HTTP and HTTPS traffic, you cannot create another report for either traffic type until 30 days pass.

See Also:

  • Method Details

    • analysisReportId

      public final String analysisReportId()

      The unique ID of the query that ran when you requested an analysis report.

      Returns:
      The unique ID of the query that ran when you requested an analysis report.

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

    • reportTime

      public final Instant reportTime()

      The date and time the analysis report was ran.

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

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

    • toBuilder

      public AnalysisReport.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<AnalysisReport.Builder,AnalysisReport>
      Returns:
      a builder for type T

    • builder

      public static AnalysisReport.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AnalysisReport.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)
      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)

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