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

Class StartArchiveSearchRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.mailmanager.model.MailManagerRequest

software.amazon.awssdk.services.mailmanager.model.StartArchiveSearchRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartArchiveSearchRequest.Builder,StartArchiveSearchRequest>

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

The request to initiate a search across emails in an archive.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartArchiveSearchRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	archiveId()	The identifier of the archive to search emails in.
static StartArchiveSearchRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ArchiveFilters	filters()	Criteria to filter which emails are included in the search results.
Instant	fromTimestamp()	The start timestamp of the range to search emails from.
<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 StartArchiveSearchRequest.Builder>	serializableBuilderClass()
StartArchiveSearchRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	toTimestamp()	The end timestamp of the range to search emails from.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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 to search emails in.

Returns:

The identifier of the archive to search emails in.

filters

public final ArchiveFilters filters()

Criteria to filter which emails are included in the search results.

Returns:

Criteria to filter which emails are included in the search results.

fromTimestamp

public final Instant fromTimestamp()

The start timestamp of the range to search emails from.

Returns:

The start timestamp of the range to search emails from.

maxResults

public final Integer maxResults()

The maximum number of search results to return.

Returns:

The maximum number of search results to return.

toTimestamp

public final Instant toTimestamp()

The end timestamp of the range to search emails from.

Returns:

The end timestamp of the range to search emails from.

toBuilder

public StartArchiveSearchRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartArchiveSearchRequest.Builder,StartArchiveSearchRequest>

Specified by:

toBuilder in class MailManagerRequest

builder

public static StartArchiveSearchRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo