Interface DatasetExportJob.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DatasetExportJob.Builder,
,DatasetExportJob> SdkBuilder<DatasetExportJob.Builder,
,DatasetExportJob> SdkPojo
- Enclosing class:
DatasetExportJob
-
Method Summary
Modifier and TypeMethodDescriptioncreationDateTime
(Instant creationDateTime) The creation date and time (in Unix time) of the dataset export job.datasetArn
(String datasetArn) The Amazon Resource Name (ARN) of the dataset to export.datasetExportJobArn
(String datasetExportJobArn) The Amazon Resource Name (ARN) of the dataset export job.failureReason
(String failureReason) If a dataset export job fails, provides the reason why.ingestionMode
(String ingestionMode) The data to export, based on how you imported the data.ingestionMode
(IngestionMode ingestionMode) The data to export, based on how you imported the data.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.jobOutput
(DatasetExportJobOutput jobOutput) The path to the Amazon S3 bucket where the job's output is stored.lastUpdatedDateTime
(Instant lastUpdatedDateTime) The date and time (in Unix time) the status of the dataset export job was last updated.The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.The status of the dataset export job.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, sdkFields
-
Method Details
-
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
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
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
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), orALL
for both types. The default value isPUT
.- Parameters:
ingestionMode
- The data to export, based on how you imported the data. You can choose to exportBULK
data that you imported using a dataset import job,PUT
data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), orALL
for both types. The default value isPUT
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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), orALL
for both types. The default value isPUT
.- Parameters:
ingestionMode
- The data to export, based on how you imported the data. You can choose to exportBULK
data that you imported using a dataset import job,PUT
data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), orALL
for both types. The default value isPUT
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
The path to the Amazon S3 bucket where the job's output is stored. For example:
s3://bucket-name/folder-name/
DatasetExportJobOutput.Builder
avoiding the need to create one manually viaDatasetExportJobOutput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tojobOutput(DatasetExportJobOutput)
.- Parameters:
jobOutput
- a consumer that will call methods onDatasetExportJobOutput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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.
-