Interface CreateDatasetExportJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateDatasetExportJobRequest.Builder,CreateDatasetExportJobRequest>, PersonalizeRequest.Builder, SdkBuilder<CreateDatasetExportJobRequest.Builder,CreateDatasetExportJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateDatasetExportJobRequest

public static interface CreateDatasetExportJobRequest.Builder
extends PersonalizeRequest.Builder, SdkPojo, CopyableBuilder<CreateDatasetExportJobRequest.Builder,CreateDatasetExportJobRequest>

Method Summary

Modifier and Type	Method	Description
CreateDatasetExportJobRequest.Builder	datasetArn(String datasetArn)	The Amazon Resource Name (ARN) of the dataset that contains the data to export.
CreateDatasetExportJobRequest.Builder	ingestionMode(String ingestionMode)	The data to export, based on how you imported the data.
CreateDatasetExportJobRequest.Builder	ingestionMode(IngestionMode ingestionMode)	The data to export, based on how you imported the data.
CreateDatasetExportJobRequest.Builder	jobName(String jobName)	The name for the dataset export job.
default CreateDatasetExportJobRequest.Builder	jobOutput(Consumer<DatasetExportJobOutput.Builder> jobOutput)	The path to the Amazon S3 bucket where the job's output is stored.
CreateDatasetExportJobRequest.Builder	jobOutput(DatasetExportJobOutput jobOutput)	The path to the Amazon S3 bucket where the job's output is stored.
CreateDatasetExportJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateDatasetExportJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateDatasetExportJobRequest.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
CreateDatasetExportJobRequest.Builder	tags(Collection<Tag> tags)	A list of tags to apply to the dataset export job.
CreateDatasetExportJobRequest.Builder	tags(Consumer<Tag.Builder>... tags)	A list of tags to apply to the dataset export job.
CreateDatasetExportJobRequest.Builder	tags(Tag... tags)	A list of tags to apply to the dataset export job.

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.personalize.model.PersonalizeRequest.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

jobName

CreateDatasetExportJobRequest.Builder jobName(String jobName)

The name for the dataset export job.

Parameters:

jobName - The name for the dataset export job.

Returns:

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

datasetArn

CreateDatasetExportJobRequest.Builder datasetArn(String datasetArn)

The Amazon Resource Name (ARN) of the dataset that contains the data to export.

Parameters:

datasetArn - The Amazon Resource Name (ARN) of the dataset that contains the data to export.

Returns:

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

ingestionMode

CreateDatasetExportJobRequest.Builder ingestionMode(String ingestionMode)

The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

Parameters:

ingestionMode - The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

Returns:

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

See Also:

• IngestionMode
• IngestionMode

ingestionMode

CreateDatasetExportJobRequest.Builder ingestionMode(IngestionMode ingestionMode)

The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

Parameters:

ingestionMode - The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

Returns:

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

See Also:

• IngestionMode
• IngestionMode

roleArn

CreateDatasetExportJobRequest.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

Parameters:

roleArn - The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

Returns:

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

jobOutput

CreateDatasetExportJobRequest.Builder jobOutput(DatasetExportJobOutput jobOutput)

The path to the Amazon S3 bucket where the job's output is stored.

Parameters:

jobOutput - The path to the Amazon S3 bucket where the job's output is stored.

Returns:

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

jobOutput

default CreateDatasetExportJobRequest.Builder jobOutput(Consumer<DatasetExportJobOutput.Builder> jobOutput)

The path to the Amazon S3 bucket where the job's output is stored.

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

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

Parameters:

jobOutput - a consumer that will call methods on DatasetExportJobOutput.Builder

Returns:

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

See Also:

• jobOutput(DatasetExportJobOutput)

tags

CreateDatasetExportJobRequest.Builder tags(Collection<Tag> tags)

A list of tags to apply to the dataset export job.

Parameters:

tags - A list of tags to apply to the dataset export job.

Returns:

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

tags

CreateDatasetExportJobRequest.Builder tags(Tag... tags)

A list of tags to apply to the dataset export job.

Parameters:

tags - A list of tags to apply to the dataset export job.

Returns:

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

tags

CreateDatasetExportJobRequest.Builder tags(Consumer<Tag.Builder>... tags)

A list of tags to apply to the dataset export job.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

• tags(java.util.Collection<Tag>)

overrideConfiguration

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

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