Interface GetUploadJobResponse.Builder

  • Method Details

    • jobId

      The unique identifier of the upload job.

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

      GetUploadJobResponse.Builder displayName(String displayName)

      The unique name of the upload job. Could be a file name to identify the upload job.

      Parameters:
      displayName - The unique name of the upload job. Could be a file name to identify the upload job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • status

      The status describing the status for the upload job. The following are Valid Values:

      • CREATED: The upload job has been created, but has not started processing yet.

      • IN_PROGRESS: The upload job is currently in progress, ingesting and processing the profile data.

      • PARTIALLY_SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.

      • SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.

      • FAILED: The upload job has failed to complete.

      • STOPPED: The upload job has been manually stopped or terminated before completion.

      Parameters:
      status - The status describing the status for the upload job. The following are Valid Values:

      • CREATED: The upload job has been created, but has not started processing yet.

      • IN_PROGRESS: The upload job is currently in progress, ingesting and processing the profile data.

      • PARTIALLY_SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.

      • SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.

      • FAILED: The upload job has failed to complete.

      • STOPPED: The upload job has been manually stopped or terminated before completion.

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

      The status describing the status for the upload job. The following are Valid Values:

      • CREATED: The upload job has been created, but has not started processing yet.

      • IN_PROGRESS: The upload job is currently in progress, ingesting and processing the profile data.

      • PARTIALLY_SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.

      • SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.

      • FAILED: The upload job has failed to complete.

      • STOPPED: The upload job has been manually stopped or terminated before completion.

      Parameters:
      status - The status describing the status for the upload job. The following are Valid Values:

      • CREATED: The upload job has been created, but has not started processing yet.

      • IN_PROGRESS: The upload job is currently in progress, ingesting and processing the profile data.

      • PARTIALLY_SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.

      • SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.

      • FAILED: The upload job has failed to complete.

      • STOPPED: The upload job has been manually stopped or terminated before completion.

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

      GetUploadJobResponse.Builder statusReason(String statusReason)

      The reason for the current status of the upload job. Possible reasons:

      • VALIDATION_FAILURE: The upload job has encountered an error or issue and was unable to complete the profile data ingestion.

      • INTERNAL_FAILURE: Failure caused from service side

      Parameters:
      statusReason - The reason for the current status of the upload job. Possible reasons:

      • VALIDATION_FAILURE: The upload job has encountered an error or issue and was unable to complete the profile data ingestion.

      • INTERNAL_FAILURE: Failure caused from service side

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

      GetUploadJobResponse.Builder statusReason(StatusReason statusReason)

      The reason for the current status of the upload job. Possible reasons:

      • VALIDATION_FAILURE: The upload job has encountered an error or issue and was unable to complete the profile data ingestion.

      • INTERNAL_FAILURE: Failure caused from service side

      Parameters:
      statusReason - The reason for the current status of the upload job. Possible reasons:

      • VALIDATION_FAILURE: The upload job has encountered an error or issue and was unable to complete the profile data ingestion.

      • INTERNAL_FAILURE: Failure caused from service side

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

      GetUploadJobResponse.Builder createdAt(Instant createdAt)

      The timestamp when the upload job was created.

      Parameters:
      createdAt - The timestamp when the upload job was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • completedAt

      GetUploadJobResponse.Builder completedAt(Instant completedAt)

      The timestamp when the upload job was completed.

      Parameters:
      completedAt - The timestamp when the upload job was completed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • fields

      The mapping between CSV Columns and Profile Object attributes for the upload job.

      Parameters:
      fields - The mapping between CSV Columns and Profile Object attributes for the upload job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • uniqueKey

      GetUploadJobResponse.Builder uniqueKey(String uniqueKey)

      The unique key columns used for de-duping the keys in the upload job.

      Parameters:
      uniqueKey - The unique key columns used for de-duping the keys in the upload job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • resultsSummary

      GetUploadJobResponse.Builder resultsSummary(ResultsSummary resultsSummary)

      The summary of results for the upload job, including the number of updated, created, and failed records.

      Parameters:
      resultsSummary - The summary of results for the upload job, including the number of updated, created, and failed records.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • resultsSummary

      default GetUploadJobResponse.Builder resultsSummary(Consumer<ResultsSummary.Builder> resultsSummary)

      The summary of results for the upload job, including the number of updated, created, and failed records.

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

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

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

      GetUploadJobResponse.Builder dataExpiry(Integer dataExpiry)

      The expiry duration for the profiles ingested with the upload job.

      Parameters:
      dataExpiry - The expiry duration for the profiles ingested with the upload job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.