Interface GetArchiveSearchResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetArchiveSearchResponse.Builder,GetArchiveSearchResponse>, MailManagerResponse.Builder, SdkBuilder<GetArchiveSearchResponse.Builder,GetArchiveSearchResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetArchiveSearchResponse

@Mutable
@NotThreadSafe
public static interface GetArchiveSearchResponse.Builder
extends MailManagerResponse.Builder, SdkPojo, CopyableBuilder<GetArchiveSearchResponse.Builder,GetArchiveSearchResponse>

Method Summary

Modifier and Type	Method	Description
GetArchiveSearchResponse.Builder	archiveId(String archiveId)	The identifier of the archive the email search was performed in.
default GetArchiveSearchResponse.Builder	filters(Consumer<ArchiveFilters.Builder> filters)	The criteria used to filter emails included in the search.
GetArchiveSearchResponse.Builder	filters(ArchiveFilters filters)	The criteria used to filter emails included in the search.
GetArchiveSearchResponse.Builder	fromTimestamp(Instant fromTimestamp)	The start timestamp of the range the searched emails cover.
GetArchiveSearchResponse.Builder	maxResults(Integer maxResults)	The maximum number of search results to return.
default GetArchiveSearchResponse.Builder	status(Consumer<SearchStatus.Builder> status)	The current status of the search job.
GetArchiveSearchResponse.Builder	status(SearchStatus status)	The current status of the search job.
GetArchiveSearchResponse.Builder	toTimestamp(Instant toTimestamp)	The end timestamp of the range the searched emails cover.

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

copy

Methods inherited from interface software.amazon.awssdk.services.mailmanager.model.MailManagerResponse.Builder

build, responseMetadata, responseMetadata

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

archiveId

GetArchiveSearchResponse.Builder archiveId(String archiveId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

GetArchiveSearchResponse.Builder filters(ArchiveFilters filters)

The criteria used to filter emails included in the search.

Parameters:

filters - The criteria used to filter emails included in the search.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

default GetArchiveSearchResponse.Builder filters(Consumer<ArchiveFilters.Builder> filters)

The criteria used to filter emails included in the search.

This is a convenience method that creates an instance of the ArchiveFilters.Builder avoiding the need to create one manually via ArchiveFilters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(ArchiveFilters).

Parameters:

filters - a consumer that will call methods on ArchiveFilters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• filters(ArchiveFilters)

fromTimestamp

GetArchiveSearchResponse.Builder fromTimestamp(Instant fromTimestamp)

The start timestamp of the range the searched emails cover.

Parameters:

fromTimestamp - The start timestamp of the range the searched emails cover.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxResults

GetArchiveSearchResponse.Builder maxResults(Integer maxResults)

The maximum number of search results to return.

Parameters:

maxResults - The maximum number of search results to return.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

GetArchiveSearchResponse.Builder status(SearchStatus status)

The current status of the search job.

Parameters:

status - The current status of the search job.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

default GetArchiveSearchResponse.Builder status(Consumer<SearchStatus.Builder> status)

The current status of the search job.

This is a convenience method that creates an instance of the SearchStatus.Builder avoiding the need to create one manually via SearchStatus.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to status(SearchStatus).

Parameters:

status - a consumer that will call methods on SearchStatus.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• status(SearchStatus)

toTimestamp

GetArchiveSearchResponse.Builder toTimestamp(Instant toTimestamp)

The end timestamp of the range the searched emails cover.

Parameters:

toTimestamp - The end timestamp of the range the searched emails cover.

Returns:

Returns a reference to this object so that method calls can be chained together.