Class ReportSummary

    • Method Detail

      • arn

        public final String arn()

        ARN for the report resource.

        Returns:
        ARN 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.
      • description

        public final String description()

        Description for the report resource.

        Returns:
        Description for the report resource.
      • 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.
      • periodEnd

        public final Instant periodEnd()

        Timestamp indicating the report resource effective end.

        Returns:
        Timestamp indicating the report resource effective end.
      • periodStart

        public final Instant periodStart()

        Timestamp indicating the report resource effective start.

        Returns:
        Timestamp indicating the report resource effective start.
      • productName

        public final String productName()

        Associated product name for the report resource.

        Returns:
        Associated product name for the report resource.
      • series

        public final String series()

        Series for the report resource.

        Returns:
        Series for the report resource.
      • 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:
        PublishedState
      • statusMessage

        public final String statusMessage()

        The message associated with the current upload state.

        Returns:
        The message associated with the current upload state.
      • 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:
        UploadState
      • 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:
        UploadState
      • version

        public final Long version()

        Version for the report resource.

        Returns:
        Version for the report resource.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)