software.amazon.awssdk.services.personalize.model

Interface DatasetExportJob.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DatasetExportJob.Builder,DatasetExportJob>, SdkBuilder<DatasetExportJob.Builder,DatasetExportJob>, SdkPojo

Enclosing class:

DatasetExportJob

public static interface DatasetExportJob.Builder
extends SdkPojo, CopyableBuilder<DatasetExportJob.Builder,DatasetExportJob>

Method Summary

Modifier and Type	Method and Description
DatasetExportJob.Builder	creationDateTime(Instant creationDateTime) The creation date and time (in Unix time) of the dataset export job.
DatasetExportJob.Builder	datasetArn(String datasetArn) The Amazon Resource Name (ARN) of the dataset to export.
DatasetExportJob.Builder	datasetExportJobArn(String datasetExportJobArn) The Amazon Resource Name (ARN) of the dataset export job.
DatasetExportJob.Builder	failureReason(String failureReason) If a dataset export job fails, provides the reason why.
DatasetExportJob.Builder	ingestionMode(IngestionMode ingestionMode) The data to export, based on how you imported the data.
DatasetExportJob.Builder	ingestionMode(String ingestionMode) The data to export, based on how you imported the data.
DatasetExportJob.Builder	jobName(String jobName) The name of the export job.
default DatasetExportJob.Builder	jobOutput(Consumer<DatasetExportJobOutput.Builder> jobOutput) The path to the Amazon S3 bucket where the job's output is stored.
DatasetExportJob.Builder	jobOutput(DatasetExportJobOutput jobOutput) The path to the Amazon S3 bucket where the job's output is stored.
DatasetExportJob.Builder	lastUpdatedDateTime(Instant lastUpdatedDateTime) The date and time (in Unix time) the status of the dataset export job was last updated.
DatasetExportJob.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.
DatasetExportJob.Builder	status(String status) The status of the dataset export job.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

jobName

DatasetExportJob.Builder jobName(String jobName)

The name of the export job.

Parameters:

jobName - The name of the export job.

Returns:

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

datasetExportJobArn

DatasetExportJob.Builder datasetExportJobArn(String datasetExportJobArn)

The Amazon Resource Name (ARN) of the dataset export job.

Parameters:

datasetExportJobArn - The Amazon Resource Name (ARN) of the dataset export job.

Returns:

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

datasetArn

DatasetExportJob.Builder datasetArn(String datasetArn)

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

Parameters:

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

Returns:

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

ingestionMode

DatasetExportJob.Builder ingestionMode(String ingestionMode)

The data to export, based on how you imported the data. You can choose to export BULK data that you imported using a dataset import job, 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 BULK data that you imported using a dataset import job, 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

DatasetExportJob.Builder ingestionMode(IngestionMode ingestionMode)

The data to export, based on how you imported the data. You can choose to export BULK data that you imported using a dataset import job, 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 BULK data that you imported using a dataset import job, 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

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

status

DatasetExportJob.Builder status(String status)

The status of the dataset export job.

A dataset export job can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

Parameters:

status - The status of the dataset export job.

A dataset export job can be in one of the following states:

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

Returns:

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

jobOutput

DatasetExportJob.Builder jobOutput(DatasetExportJobOutput jobOutput)

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

s3://bucket-name/folder-name/

Parameters:

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

s3://bucket-name/folder-name/

Returns:

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

jobOutput

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

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

s3://bucket-name/folder-name/

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)

creationDateTime

DatasetExportJob.Builder creationDateTime(Instant creationDateTime)

The creation date and time (in Unix time) of the dataset export job.

Parameters:

creationDateTime - The creation date and time (in Unix time) of the dataset export job.

Returns:

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

lastUpdatedDateTime

DatasetExportJob.Builder lastUpdatedDateTime(Instant lastUpdatedDateTime)

The date and time (in Unix time) the status of the dataset export job was last updated.

Parameters:

lastUpdatedDateTime - The date and time (in Unix time) the status of the dataset export job was last updated.

Returns:

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

failureReason

DatasetExportJob.Builder failureReason(String failureReason)

If a dataset export job fails, provides the reason why.

Parameters:

failureReason - If a dataset export job fails, provides the reason why.

Returns:

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