Class ReportGenerationResult

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

Result of a report generation attempt.

See Also:

  • Method Details

    • reportType

      public final ReportType reportType()

      The type of the generated report.

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

      Returns:
      The type of the generated report.
      See Also:

    • reportTypeAsString

      public final String reportTypeAsString()

      The type of the generated report.

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

      Returns:
      The type of the generated report.
      See Also:

    • status

      public final ReportGenerationStatus status()

      The status of the report generation.

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

      Returns:
      The status of the report generation.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the report generation.

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

      Returns:
      The status of the report generation.
      See Also:

    • serviceArn

      public final String serviceArn()

      The service this report was generated for.

      Returns:
      The service this report was generated for.

    • assessmentId

      public final String assessmentId()

      Present for FAILURE_MODE reports.

      Returns:
      Present for FAILURE_MODE reports.

    • testRunId

      public final String testRunId()
      Returns the value of the TestRunId property for this object.
      Returns:
      The value of the TestRunId property for this object.

    • testTemplateArn

      public final String testTemplateArn()
      Returns the value of the TestTemplateArn property for this object.
      Returns:
      The value of the TestTemplateArn property for this object.

    • createdAt

      public final Instant createdAt()

      The timestamp when the report was created.

      Returns:
      The timestamp when the report was created.

    • reportOutput

      public final ReportOutput reportOutput()

      Present when status is SUCCEEDED or FAILED.

      Returns:
      Present when status is SUCCEEDED or FAILED.

    • toBuilder

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

    • builder

      public static ReportGenerationResult.Builder builder()

    • serializableBuilderClass

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