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

Class GetArchiveSearchResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.mailmanager.model.MailManagerResponse

software.amazon.awssdk.services.mailmanager.model.GetArchiveSearchResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetArchiveSearchResponse.Builder,GetArchiveSearchResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetArchiveSearchResponse
extends MailManagerResponse
implements ToCopyableBuilder<GetArchiveSearchResponse.Builder,GetArchiveSearchResponse>

The response containing details of the specified archive search job.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetArchiveSearchResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	archiveId()	The identifier of the archive the email search was performed in.
static GetArchiveSearchResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ArchiveFilters	filters()	The criteria used to filter emails included in the search.
Instant	fromTimestamp()	The start timestamp of the range the searched emails cover.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of search results to return.
List<SdkField<?>>	sdkFields()
static Class<? extends GetArchiveSearchResponse.Builder>	serializableBuilderClass()
SearchStatus	status()	The current status of the search job.
GetArchiveSearchResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	toTimestamp()	The end timestamp of the range the searched emails cover.

Methods inherited from class software.amazon.awssdk.services.mailmanager.model.MailManagerResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

archiveId

public final String archiveId()

The identifier of the archive the email search was performed in.

Returns:

The identifier of the archive the email search was performed in.

filters

public final ArchiveFilters filters()

The criteria used to filter emails included in the search.

Returns:

The criteria used to filter emails included in the search.

fromTimestamp

public final Instant fromTimestamp()

The start timestamp of the range the searched emails cover.

Returns:

The start timestamp of the range the searched emails cover.

maxResults

public final Integer maxResults()

The maximum number of search results to return.

Returns:

The maximum number of search results to return.

status

public final SearchStatus status()

The current status of the search job.

Returns:

The current status of the search job.

toTimestamp

public final Instant toTimestamp()

The end timestamp of the range the searched emails cover.

Returns:

The end timestamp of the range the searched emails cover.

toBuilder

public GetArchiveSearchResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetArchiveSearchResponse.Builder,GetArchiveSearchResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetArchiveSearchResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetArchiveSearchResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo