Class Report

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

Information about the results from running a series of test cases during the run of a build project. The test cases are specified in the buildspec for the build project using one or more paths to the test case files. You can specify any type of tests you want, such as unit tests, integration tests, and functional tests.

See Also:

  • Method Details

    • arn

      public final String arn()

      The ARN of the report run.

      Returns:
      The ARN of the report run.

    • type

      public final ReportType type()

      The type of the report that was run.

      CODE_COVERAGE

      A code coverage report.

      TEST

      A test report.

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

      Returns:
      The type of the report that was run.

      CODE_COVERAGE

      A code coverage report.

      TEST

      A test report.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the report that was run.

      CODE_COVERAGE

      A code coverage report.

      TEST

      A test report.

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

      Returns:
      The type of the report that was run.

      CODE_COVERAGE

      A code coverage report.

      TEST

      A test report.

      See Also:

    • name

      public final String name()

      The name of the report that was run.

      Returns:
      The name of the report that was run.

    • reportGroupArn

      public final String reportGroupArn()

      The ARN of the report group associated with this report.

      Returns:
      The ARN of the report group associated with this report.

    • executionId

      public final String executionId()

      The ARN of the build run that generated this report.

      Returns:
      The ARN of the build run that generated this report.

    • status

      public final ReportStatusType status()

      The status of this report.

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

      Returns:
      The status of this report.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of this report.

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

      Returns:
      The status of this report.
      See Also:

    • created

      public final Instant created()

      The date and time this report run occurred.

      Returns:
      The date and time this report run occurred.

    • expired

      public final Instant expired()

      The date and time a report expires. A report expires 30 days after it is created. An expired report is not available to view in CodeBuild.

      Returns:
      The date and time a report expires. A report expires 30 days after it is created. An expired report is not available to view in CodeBuild.

    • exportConfig

      public final ReportExportConfig exportConfig()

      Information about where the raw data used to generate this report was exported.

      Returns:
      Information about where the raw data used to generate this report was exported.

    • truncated

      public final Boolean truncated()

      A boolean that specifies if this report run is truncated. The list of test cases is truncated after the maximum number of test cases is reached.

      Returns:
      A boolean that specifies if this report run is truncated. The list of test cases is truncated after the maximum number of test cases is reached.

    • testSummary

      public final TestReportSummary testSummary()

      A TestReportSummary object that contains information about this test report.

      Returns:
      A TestReportSummary object that contains information about this test report.

    • codeCoverageSummary

      public final CodeCoverageReportSummary codeCoverageSummary()

      A CodeCoverageReportSummary object that contains a code coverage summary for this report.

      Returns:
      A CodeCoverageReportSummary object that contains a code coverage summary for this report.

    • toBuilder

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

    • builder

      public static Report.Builder builder()

    • serializableBuilderClass

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