Class Archive

    • Method Detail

      • archiveId

        public final String archiveId()

        The unique identifier of the archive.

        Returns:
        The unique identifier of the archive.
      • archiveName

        public final String archiveName()

        The unique name assigned to the archive.

        Returns:
        The unique name assigned to the archive.
      • archiveState

        public final ArchiveState archiveState()

        The current state of the archive:

        • ACTIVE – The archive is ready and available for use.

        • PENDING_DELETION – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.

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

        Returns:
        The current state of the archive:

        • ACTIVE – The archive is ready and available for use.

        • PENDING_DELETION – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.

        See Also:
        ArchiveState
      • archiveStateAsString

        public final String archiveStateAsString()

        The current state of the archive:

        • ACTIVE – The archive is ready and available for use.

        • PENDING_DELETION – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.

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

        Returns:
        The current state of the archive:

        • ACTIVE – The archive is ready and available for use.

        • PENDING_DELETION – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.

        See Also:
        ArchiveState
      • lastUpdatedTimestamp

        public final Instant lastUpdatedTimestamp()

        The timestamp of when the archive was last updated.

        Returns:
        The timestamp of when the archive was last updated.
      • serializableBuilderClass

        public static Class<? extends Archive.Builder> serializableBuilderClass()
      • 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)