Interface ImportJob.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ImportJob.Builder,ImportJob>, SdkBuilder<ImportJob.Builder,ImportJob>, SdkPojo
Enclosing class:
ImportJob
@Mutable @NotThreadSafe public static interface ImportJob.Builder extends SdkPojo, CopyableBuilder<ImportJob.Builder,ImportJob>

  • Method Details

    • addressListId

      ImportJob.Builder addressListId(String addressListId)

      The unique identifier of the address list the import job was created for.

      Parameters:
      addressListId - The unique identifier of the address list the import job was created for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • completedTimestamp

      ImportJob.Builder completedTimestamp(Instant completedTimestamp)

      The timestamp of when the import job was completed.

      Parameters:
      completedTimestamp - The timestamp of when the import job was completed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdTimestamp

      ImportJob.Builder createdTimestamp(Instant createdTimestamp)

      The timestamp of when the import job was created.

      Parameters:
      createdTimestamp - The timestamp of when the import job was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • error

      ImportJob.Builder error(String error)

      The reason for failure of an import job.

      Parameters:
      error - The reason for failure of an import job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failedItemsCount

      ImportJob.Builder failedItemsCount(Integer failedItemsCount)

      The number of addresses in the input that failed to get imported into address list.

      Parameters:
      failedItemsCount - The number of addresses in the input that failed to get imported into address list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • importDataFormat

      ImportJob.Builder importDataFormat(ImportDataFormat importDataFormat)

      The format of the input for the import job.

      Parameters:
      importDataFormat - The format of the input for the import job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • importDataFormat

      default ImportJob.Builder importDataFormat(Consumer<ImportDataFormat.Builder> importDataFormat)

      The format of the input for the import job.

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

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

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

    • importedItemsCount

      ImportJob.Builder importedItemsCount(Integer importedItemsCount)

      The number of addresses in the input that were successfully imported into the address list.

      Parameters:
      importedItemsCount - The number of addresses in the input that were successfully imported into the address list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobId

      ImportJob.Builder jobId(String jobId)

      The identifier of the import job.

      Parameters:
      jobId - The identifier of the import job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      ImportJob.Builder name(String name)

      A user-friendly name for the import job.

      Parameters:
      name - A user-friendly name for the import job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • preSignedUrl

      ImportJob.Builder preSignedUrl(String preSignedUrl)

      The pre-signed URL target for uploading the input file.

      Parameters:
      preSignedUrl - The pre-signed URL target for uploading the input file.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTimestamp

      ImportJob.Builder startTimestamp(Instant startTimestamp)

      The timestamp of when the import job was started.

      Parameters:
      startTimestamp - The timestamp of when the import job was started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      ImportJob.Builder status(String status)

      The status of the import job.

      Parameters:
      status - The status of the import job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      ImportJob.Builder status(ImportJobStatus status)

      The status of the import job.

      Parameters:
      status - The status of the import job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: