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

Interface DataDeletionJob.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DataDeletionJob.Builder,DataDeletionJob>, SdkBuilder<DataDeletionJob.Builder,DataDeletionJob>, SdkPojo
Enclosing class:
DataDeletionJob
public static interface DataDeletionJob.Builder extends SdkPojo, CopyableBuilder<DataDeletionJob.Builder,DataDeletionJob>

  • Method Details

    • jobName

      DataDeletionJob.Builder jobName(String jobName)

      The name of the data deletion job.

      Parameters:
      jobName - The name of the data deletion job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataDeletionJobArn

      DataDeletionJob.Builder dataDeletionJobArn(String dataDeletionJobArn)

      The Amazon Resource Name (ARN) of the data deletion job.

      Parameters:
      dataDeletionJobArn - The Amazon Resource Name (ARN) of the data deletion job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasetGroupArn

      DataDeletionJob.Builder datasetGroupArn(String datasetGroupArn)

      The Amazon Resource Name (ARN) of the dataset group the job deletes records from.

      Parameters:
      datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group the job deletes records from.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSource

      DataDeletionJob.Builder dataSource(DataSource dataSource)
      Sets the value of the DataSource property for this object.
      Parameters:
      dataSource - The new value for the DataSource property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSource

      default DataDeletionJob.Builder dataSource(Consumer<DataSource.Builder> dataSource)
      Sets the value of the DataSource property for this object. This is a convenience method that creates an instance of the DataSource.Builder avoiding the need to create one manually via DataSource.builder().

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

      Parameters:
      dataSource - a consumer that will call methods on DataSource.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • roleArn

      DataDeletionJob.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of the IAM role that has permissions to read from the Amazon S3 data source.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the IAM role that has permissions to read from the Amazon S3 data source.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      DataDeletionJob.Builder status(String status)

      The status of the data deletion job.

      A data deletion job can have one of the following statuses:

      • PENDING > IN_PROGRESS > COMPLETED -or- FAILED

      Parameters:
      status - The status of the data deletion job.

      A data deletion job can have one of the following statuses:

      • PENDING > IN_PROGRESS > COMPLETED -or- FAILED

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

    • numDeleted

      DataDeletionJob.Builder numDeleted(Integer numDeleted)

      The number of records deleted by a COMPLETED job.

      Parameters:
      numDeleted - The number of records deleted by a COMPLETED job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationDateTime

      DataDeletionJob.Builder creationDateTime(Instant creationDateTime)

      The creation date and time (in Unix time) of the data deletion job.

      Parameters:
      creationDateTime - The creation date and time (in Unix time) of the data deletion job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdatedDateTime

      DataDeletionJob.Builder lastUpdatedDateTime(Instant lastUpdatedDateTime)

      The date and time (in Unix time) the data deletion job was last updated.

      Parameters:
      lastUpdatedDateTime - The date and time (in Unix time) the data deletion job was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureReason

      DataDeletionJob.Builder failureReason(String failureReason)

      If a data deletion job fails, provides the reason why.

      Parameters:
      failureReason - If a data deletion job fails, provides the reason why.
      Returns:
      Returns a reference to this object so that method calls can be chained together.