Package software.amazon.awssdk.services.mailmanager.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchStatus.Builder

Method Summary

Modifier and Type	Method	Description
static SearchStatus.Builder	builder()
Instant	completionTimestamp()	The timestamp of when the search completed (if finished).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	errorMessage()	An error message if the search failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends SearchStatus.Builder>	serializableBuilderClass()
SearchState	state()	The current state of the search job.
String	stateAsString()	The current state of the search job.
Instant	submissionTimestamp()	The timestamp of when the search was submitted.
SearchStatus.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

SearchState

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:

SearchState

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()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchStatus.Builder,SearchStatus>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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