Package software.amazon.awssdk.services.backupsearch.model

Interface StartSearchResultExportJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BackupSearchRequest.Builder, Buildable, CopyableBuilder<StartSearchResultExportJobRequest.Builder,StartSearchResultExportJobRequest>, SdkBuilder<StartSearchResultExportJobRequest.Builder,StartSearchResultExportJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartSearchResultExportJobRequest

public static interface StartSearchResultExportJobRequest.Builder
extends BackupSearchRequest.Builder, SdkPojo, CopyableBuilder<StartSearchResultExportJobRequest.Builder,StartSearchResultExportJobRequest>

Method Summary

Modifier and Type	Method	Description
StartSearchResultExportJobRequest.Builder	clientToken(String clientToken)	Include this parameter to allow multiple identical calls for idempotency.
default StartSearchResultExportJobRequest.Builder	exportSpecification(Consumer<ExportSpecification.Builder> exportSpecification)	This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.
StartSearchResultExportJobRequest.Builder	exportSpecification(ExportSpecification exportSpecification)	This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.
StartSearchResultExportJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StartSearchResultExportJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartSearchResultExportJobRequest.Builder	roleArn(String roleArn)	This parameter specifies the role ARN used to start the search results export jobs.
StartSearchResultExportJobRequest.Builder	searchJobIdentifier(String searchJobIdentifier)	The unique string that specifies the search job.
StartSearchResultExportJobRequest.Builder	tags(Map<String,String> tags)	Optional tags to include.

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.backupsearch.model.BackupSearchRequest.Builder

build

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

copy

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 Detail

searchJobIdentifier

StartSearchResultExportJobRequest.Builder searchJobIdentifier(String searchJobIdentifier)

The unique string that specifies the search job.

Parameters:

searchJobIdentifier - The unique string that specifies the search job.

Returns:

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

exportSpecification

StartSearchResultExportJobRequest.Builder exportSpecification(ExportSpecification exportSpecification)

This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.

Parameters:

exportSpecification - This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.

Returns:

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

exportSpecification

default StartSearchResultExportJobRequest.Builder exportSpecification(Consumer<ExportSpecification.Builder> exportSpecification)

This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.

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

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

Parameters:

exportSpecification - a consumer that will call methods on ExportSpecification.Builder

Returns:

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

See Also:

exportSpecification(ExportSpecification)

clientToken

StartSearchResultExportJobRequest.Builder clientToken(String clientToken)

Include this parameter to allow multiple identical calls for idempotency.

A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.

Parameters:

clientToken - Include this parameter to allow multiple identical calls for idempotency.

A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.

Returns:

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

tags

StartSearchResultExportJobRequest.Builder tags(Map<String,String> tags)

Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

Parameters:

tags - Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

Returns:

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

roleArn

StartSearchResultExportJobRequest.Builder roleArn(String roleArn)

This parameter specifies the role ARN used to start the search results export jobs.

Parameters:

roleArn - This parameter specifies the role ARN used to start the search results export jobs.

Returns:

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

overrideConfiguration

StartSearchResultExportJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder