Class ReportGroup

java.lang.Object
software.amazon.awssdk.services.codebuild.model.ReportGroup
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ReportGroup.Builder,ReportGroup>
@Generated("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:

  • Method Details

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

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

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

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

    • toBuilder

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

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