Interface StartArchiveSearchRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartArchiveSearchRequest.Builder,StartArchiveSearchRequest>, MailManagerRequest.Builder, SdkBuilder<StartArchiveSearchRequest.Builder,StartArchiveSearchRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartArchiveSearchRequest

public static interface StartArchiveSearchRequest.Builder
extends MailManagerRequest.Builder, SdkPojo, CopyableBuilder<StartArchiveSearchRequest.Builder,StartArchiveSearchRequest>

Method Summary

Modifier and Type	Method	Description
StartArchiveSearchRequest.Builder	archiveId(String archiveId)	The identifier of the archive to search emails in.
default StartArchiveSearchRequest.Builder	filters(Consumer<ArchiveFilters.Builder> filters)	Criteria to filter which emails are included in the search results.
StartArchiveSearchRequest.Builder	filters(ArchiveFilters filters)	Criteria to filter which emails are included in the search results.
StartArchiveSearchRequest.Builder	fromTimestamp(Instant fromTimestamp)	The start timestamp of the range to search emails from.
StartArchiveSearchRequest.Builder	maxResults(Integer maxResults)	The maximum number of search results to return.
StartArchiveSearchRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartArchiveSearchRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
StartArchiveSearchRequest.Builder	toTimestamp(Instant toTimestamp)	The end timestamp of the range to search emails from.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

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

build

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Details

archiveId

StartArchiveSearchRequest.Builder archiveId(String archiveId)

The identifier of the archive to search emails in.

Parameters:

archiveId - The identifier of the archive to search emails in.

Returns:

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

filters

StartArchiveSearchRequest.Builder filters(ArchiveFilters filters)

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

Parameters:

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

Returns:

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

filters

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

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

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

StartArchiveSearchRequest.Builder fromTimestamp(Instant fromTimestamp)

The start timestamp of the range to search emails from.

Parameters:

fromTimestamp - The start timestamp of the range to search emails from.

Returns:

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

maxResults

StartArchiveSearchRequest.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.

toTimestamp

StartArchiveSearchRequest.Builder toTimestamp(Instant toTimestamp)

The end timestamp of the range to search emails from.

Parameters:

toTimestamp - The end timestamp of the range to search emails from.

Returns:

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

overrideConfiguration

StartArchiveSearchRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

StartArchiveSearchRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.