Interface IdentityResolutionJob.Builder

All Superinterfaces:
Buildable, CopyableBuilder<IdentityResolutionJob.Builder,IdentityResolutionJob>, SdkBuilder<IdentityResolutionJob.Builder,IdentityResolutionJob>, SdkPojo
Enclosing class:
IdentityResolutionJob

public static interface IdentityResolutionJob.Builder extends SdkPojo, CopyableBuilder<IdentityResolutionJob.Builder,IdentityResolutionJob>
  • Method Details

    • domainName

      IdentityResolutionJob.Builder domainName(String domainName)

      The unique name of the domain.

      Parameters:
      domainName - The unique name of the domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • jobId

      The unique identifier of the Identity Resolution Job.

      Parameters:
      jobId - The unique identifier of the Identity Resolution Job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • status

      The status of the Identity Resolution Job.

      • PENDING: The Identity Resolution Job is scheduled but has not started yet. If you turn off the Identity Resolution feature in your domain, jobs in the PENDING state are deleted.

      • PREPROCESSING: The Identity Resolution Job is loading your data.

      • FIND_MATCHING: The Identity Resolution Job is using the machine learning model to identify profiles that belong to the same matching group.

      • MERGING: The Identity Resolution Job is merging duplicate profiles.

      • COMPLETED: The Identity Resolution Job completed successfully.

      • PARTIAL_SUCCESS: There's a system error and not all of the data is merged. The Identity Resolution Job writes a message indicating the source of the problem.

      • FAILED: The Identity Resolution Job did not merge any data. It writes a message indicating the source of the problem.

      Parameters:
      status - The status of the Identity Resolution Job.

      • PENDING: The Identity Resolution Job is scheduled but has not started yet. If you turn off the Identity Resolution feature in your domain, jobs in the PENDING state are deleted.

      • PREPROCESSING: The Identity Resolution Job is loading your data.

      • FIND_MATCHING: The Identity Resolution Job is using the machine learning model to identify profiles that belong to the same matching group.

      • MERGING: The Identity Resolution Job is merging duplicate profiles.

      • COMPLETED: The Identity Resolution Job completed successfully.

      • PARTIAL_SUCCESS: There's a system error and not all of the data is merged. The Identity Resolution Job writes a message indicating the source of the problem.

      • FAILED: The Identity Resolution Job did not merge any data. It writes a message indicating the source of the problem.

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

      The status of the Identity Resolution Job.

      • PENDING: The Identity Resolution Job is scheduled but has not started yet. If you turn off the Identity Resolution feature in your domain, jobs in the PENDING state are deleted.

      • PREPROCESSING: The Identity Resolution Job is loading your data.

      • FIND_MATCHING: The Identity Resolution Job is using the machine learning model to identify profiles that belong to the same matching group.

      • MERGING: The Identity Resolution Job is merging duplicate profiles.

      • COMPLETED: The Identity Resolution Job completed successfully.

      • PARTIAL_SUCCESS: There's a system error and not all of the data is merged. The Identity Resolution Job writes a message indicating the source of the problem.

      • FAILED: The Identity Resolution Job did not merge any data. It writes a message indicating the source of the problem.

      Parameters:
      status - The status of the Identity Resolution Job.

      • PENDING: The Identity Resolution Job is scheduled but has not started yet. If you turn off the Identity Resolution feature in your domain, jobs in the PENDING state are deleted.

      • PREPROCESSING: The Identity Resolution Job is loading your data.

      • FIND_MATCHING: The Identity Resolution Job is using the machine learning model to identify profiles that belong to the same matching group.

      • MERGING: The Identity Resolution Job is merging duplicate profiles.

      • COMPLETED: The Identity Resolution Job completed successfully.

      • PARTIAL_SUCCESS: There's a system error and not all of the data is merged. The Identity Resolution Job writes a message indicating the source of the problem.

      • FAILED: The Identity Resolution Job did not merge any data. It writes a message indicating the source of the problem.

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

      IdentityResolutionJob.Builder jobStartTime(Instant jobStartTime)

      The timestamp of when the job was started or will be started.

      Parameters:
      jobStartTime - The timestamp of when the job was started or will be started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • jobEndTime

      IdentityResolutionJob.Builder jobEndTime(Instant jobEndTime)

      The timestamp of when the job was completed.

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

      Statistics about an Identity Resolution Job.

      Parameters:
      jobStats - Statistics about an Identity Resolution Job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • jobStats

      Statistics about an Identity Resolution Job.

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

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

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

      IdentityResolutionJob.Builder exportingLocation(ExportingLocation exportingLocation)

      The S3 location where the Identity Resolution Job writes result files.

      Parameters:
      exportingLocation - The S3 location where the Identity Resolution Job writes result files.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • exportingLocation

      default IdentityResolutionJob.Builder exportingLocation(Consumer<ExportingLocation.Builder> exportingLocation)

      The S3 location where the Identity Resolution Job writes result files.

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

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

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

      The error messages that are generated when the Identity Resolution Job runs.

      Parameters:
      message - The error messages that are generated when the Identity Resolution Job runs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.