software.amazon.awssdk.services.codebuild.model

Class ReportGroup

java.lang.Object

software.amazon.awssdk.services.codebuild.model.ReportGroup

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class ReportGroup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ReportGroup.Builder,ReportGroup>

A series of reports. Each report contains information about the results from running a series of test cases. You specify the test cases for a report group in the buildspec for a build project using one or more paths to the test case files.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ReportGroup.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The ARN of the ReportGroup.
static ReportGroup.Builder	builder()
Instant	created() The date and time this ReportGroup was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ReportExportConfig	exportConfig() Information about the destination where the raw data of this ReportGroup is exported.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
Instant	lastModified() The date and time this ReportGroup was last modified.
String	name() The name of the ReportGroup.
List<SdkField<?>>	sdkFields()
static Class<? extends ReportGroup.Builder>	serializableBuilderClass()
ReportGroupStatusType	status() The status of the report group.
String	statusAsString() The status of the report group.
List<Tag>	tags() A list of tag key and value pairs associated with this report group.
ReportGroup.Builder	toBuilder()
String	toString() Returns a string representation of this object.
ReportType	type() The type of the ReportGroup.
String	typeAsString() The type of the ReportGroup.

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

Returns:

The ARN of the ReportGroup.

name

public final String name()

The name of the ReportGroup.

Returns:

The name of the ReportGroup.

type

public final ReportType type()

The type of the ReportGroup. This can be one of the following values:

CODE_COVERAGE

The report group contains code coverage reports.

TEST

The report group contains test reports.

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 ReportGroup. This can be one of the following values:

CODE_COVERAGE

The report group contains code coverage reports.

TEST

The report group contains test reports.

See Also:

ReportType

typeAsString

public final String typeAsString()

The type of the ReportGroup. This can be one of the following values:

CODE_COVERAGE

The report group contains code coverage reports.

TEST

The report group contains test reports.

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 ReportGroup. This can be one of the following values:

CODE_COVERAGE

The report group contains code coverage reports.

TEST

The report group contains test reports.

See Also:

ReportType

exportConfig

public final ReportExportConfig exportConfig()

Information about the destination where the raw data of this ReportGroup is exported.

Returns:

Information about the destination where the raw data of this ReportGroup is exported.

created

public final Instant created()

The date and time this ReportGroup was created.

Returns:

The date and time this ReportGroup was created.

lastModified

public final Instant lastModified()

The date and time this ReportGroup was last modified.

Returns:

The date and time this ReportGroup was last modified.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final List<Tag> tags()

A list of tag key and value pairs associated with this report group.

These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.

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

Returns:

A list of tag key and value pairs associated with this report group.

These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.

status

public final ReportGroupStatusType status()

The status of the report group. This property is read-only.

This can be one of the following values:

ACTIVE

The report group is active.

DELETING

The report group is in the process of being deleted.

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

Returns:

The status of the report group. This property is read-only.

This can be one of the following values:

ACTIVE

The report group is active.

DELETING

The report group is in the process of being deleted.

See Also:

ReportGroupStatusType

statusAsString

public final String statusAsString()

The status of the report group. This property is read-only.

This can be one of the following values:

ACTIVE

The report group is active.

DELETING

The report group is in the process of being deleted.

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

Returns:

The status of the report group. This property is read-only.

This can be one of the following values:

ACTIVE

The report group is active.

DELETING

The report group is in the process of being deleted.

See Also:

ReportGroupStatusType

toBuilder

public ReportGroup.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ReportGroup.Builder,ReportGroup>

builder

public static ReportGroup.Builder builder()

serializableBuilderClass

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