Interface StartArchiveExportRequest.Builder

All Superinterfaces:

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

Enclosing class:

StartArchiveExportRequest

@Mutable
@NotThreadSafe
public static interface StartArchiveExportRequest.Builder
extends MailManagerRequest.Builder, SdkPojo, CopyableBuilder<StartArchiveExportRequest.Builder,StartArchiveExportRequest>

Method Summary

Modifier and Type	Method	Description
StartArchiveExportRequest.Builder	archiveId(String archiveId)	The identifier of the archive to export emails from.
default StartArchiveExportRequest.Builder	exportDestinationConfiguration(Consumer<ExportDestinationConfiguration.Builder> exportDestinationConfiguration)	Details on where to deliver the exported email data.
StartArchiveExportRequest.Builder	exportDestinationConfiguration(ExportDestinationConfiguration exportDestinationConfiguration)	Details on where to deliver the exported email data.
default StartArchiveExportRequest.Builder	filters(Consumer<ArchiveFilters.Builder> filters)	Criteria to filter which emails are included in the export.
StartArchiveExportRequest.Builder	filters(ArchiveFilters filters)	Criteria to filter which emails are included in the export.
StartArchiveExportRequest.Builder	fromTimestamp(Instant fromTimestamp)	The start of the timestamp range to include emails from.
StartArchiveExportRequest.Builder	includeMetadata(Boolean includeMetadata)	Whether to include message metadata as JSON files in the export.
StartArchiveExportRequest.Builder	maxResults(Integer maxResults)	The maximum number of email items to include in the export.
StartArchiveExportRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartArchiveExportRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
StartArchiveExportRequest.Builder	toTimestamp(Instant toTimestamp)	The end of the timestamp range to include 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, sdkFieldNameToField, sdkFields

Method Details

archiveId

StartArchiveExportRequest.Builder archiveId(String archiveId)

The identifier of the archive to export emails from.

Parameters:

archiveId - The identifier of the archive to export emails from.

Returns:

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

exportDestinationConfiguration

StartArchiveExportRequest.Builder exportDestinationConfiguration(ExportDestinationConfiguration exportDestinationConfiguration)

Details on where to deliver the exported email data.

Parameters:

exportDestinationConfiguration - Details on where to deliver the exported email data.

Returns:

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

exportDestinationConfiguration

default StartArchiveExportRequest.Builder exportDestinationConfiguration(Consumer<ExportDestinationConfiguration.Builder> exportDestinationConfiguration)

Details on where to deliver the exported email data.

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

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

Parameters:

exportDestinationConfiguration - a consumer that will call methods on ExportDestinationConfiguration.Builder

Returns:

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

See Also:

• exportDestinationConfiguration(ExportDestinationConfiguration)

filters

StartArchiveExportRequest.Builder filters(ArchiveFilters filters)

Criteria to filter which emails are included in the export.

Parameters:

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

Returns:

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

filters

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

Criteria to filter which emails are included in the export.

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

StartArchiveExportRequest.Builder fromTimestamp(Instant fromTimestamp)

The start of the timestamp range to include emails from.

Parameters:

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

Returns:

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

includeMetadata

StartArchiveExportRequest.Builder includeMetadata(Boolean includeMetadata)

Whether to include message metadata as JSON files in the export.

Parameters:

includeMetadata - Whether to include message metadata as JSON files in the export.

Returns:

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

maxResults

StartArchiveExportRequest.Builder maxResults(Integer maxResults)

The maximum number of email items to include in the export.

Parameters:

maxResults - The maximum number of email items to include in the export.

Returns:

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

toTimestamp

StartArchiveExportRequest.Builder toTimestamp(Instant toTimestamp)

The end of the timestamp range to include emails from.

Parameters:

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

Returns:

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

overrideConfiguration

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

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