software.amazon.awssdk.services.codebuild.model

Class Report

java.lang.Object

software.amazon.awssdk.services.codebuild.model.Report

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Report.Builder,Report>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Report.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The ARN of the report run.
static Report.Builder	builder()
CodeCoverageReportSummary	codeCoverageSummary() A CodeCoverageReportSummary object that contains a code coverage summary for this report.
Instant	created() The date and time this report run occurred.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionId() The ARN of the build run that generated this report.
Instant	expired() The date and time a report expires.
ReportExportConfig	exportConfig() Information about where the raw data used to generate this report was exported.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() The name of the report that was run.
String	reportGroupArn() The ARN of the report group associated with this report.
List<SdkField<?>>	sdkFields()
static Class<? extends Report.Builder>	serializableBuilderClass()
ReportStatusType	status() The status of this report.
String	statusAsString() The status of this report.
TestReportSummary	testSummary() A TestReportSummary object that contains information about this test report.
Report.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Boolean	truncated() A boolean that specifies if this report run is truncated.
ReportType	type() The type of the report that was run.
String	typeAsString() The type of the report that was run.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

ReportType

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:

ReportType

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:

ReportStatusType

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:

ReportStatusType

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()

Specified by:

toBuilder in interface ToCopyableBuilder<Report.Builder,Report>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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