Package software.amazon.awssdk.services.personalize.model

Interface DatasetExportJob.Builder

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

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