Class ReportSummary

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

Summary for report resource.

See Also:

  • Method Details

    • id

      public final String id()

      Unique resource ID for the report resource.

      Returns:
      Unique resource ID for the report resource.

    • name

      public final String name()

      Name for the report resource.

      Returns:
      Name for the report resource.

    • state

      public final PublishedState state()

      Current state of the report resource.

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

      Returns:
      Current state of the report resource.
      See Also:

    • stateAsString

      public final String stateAsString()

      Current state of the report resource.

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

      Returns:
      Current state of the report resource.
      See Also:

    • arn

      public final String arn()

      ARN for the report resource.

      Returns:
      ARN for the report resource.

    • version

      public final Long version()

      Version for the report resource.

      Returns:
      Version for the report resource.

    • uploadState

      public final UploadState uploadState()

      The current state of the document upload.

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

      Returns:
      The current state of the document upload.
      See Also:

    • uploadStateAsString

      public final String uploadStateAsString()

      The current state of the document upload.

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

      Returns:
      The current state of the document upload.
      See Also:

    • description

      public final String description()

      Description for the report resource.

      Returns:
      Description for the report resource.

    • periodStart

      public final Instant periodStart()

      Timestamp indicating the report resource effective start.

      Returns:
      Timestamp indicating the report resource effective start.

    • periodEnd

      public final Instant periodEnd()

      Timestamp indicating the report resource effective end.

      Returns:
      Timestamp indicating the report resource effective end.

    • series

      public final String series()

      Series for the report resource.

      Returns:
      Series for the report resource.

    • category

      public final String category()

      Category for the report resource.

      Returns:
      Category for the report resource.

    • companyName

      public final String companyName()

      Associated company name for the report resource.

      Returns:
      Associated company name for the report resource.

    • productName

      public final String productName()

      Associated product name for the report resource.

      Returns:
      Associated product name for the report resource.

    • statusMessage

      public final String statusMessage()

      The message associated with the current upload state.

      Returns:
      The message associated with the current upload state.

    • acceptanceType

      public final AcceptanceType acceptanceType()

      Acceptance type for report.

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

      Returns:
      Acceptance type for report.
      See Also:

    • acceptanceTypeAsString

      public final String acceptanceTypeAsString()

      Acceptance type for report.

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

      Returns:
      Acceptance type for report.
      See Also:

    • toBuilder

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

    • builder

      public static ReportSummary.Builder builder()

    • serializableBuilderClass

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