Class SearchStatus

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

The current status of an archive search job.

See Also:

  • Method Details

    • completionTimestamp

      public final Instant completionTimestamp()

      The timestamp of when the search completed (if finished).

      Returns:
      The timestamp of when the search completed (if finished).

    • errorMessage

      public final String errorMessage()

      An error message if the search failed.

      Returns:
      An error message if the search failed.

    • state

      public final SearchState state()

      The current state of the search job.

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

      Returns:
      The current state of the search job.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the search job.

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

      Returns:
      The current state of the search job.
      See Also:

    • submissionTimestamp

      public final Instant submissionTimestamp()

      The timestamp of when the search was submitted.

      Returns:
      The timestamp of when the search was submitted.

    • toBuilder

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

    • builder

      public static SearchStatus.Builder builder()

    • serializableBuilderClass

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