Class IdentityResolutionJob

java.lang.Object
software.amazon.awssdk.services.customerprofiles.model.IdentityResolutionJob
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<IdentityResolutionJob.Builder,IdentityResolutionJob>
@Generated("software.amazon.awssdk:codegen") public final class IdentityResolutionJob extends Object implements SdkPojo, Serializable, ToCopyableBuilder<IdentityResolutionJob.Builder,IdentityResolutionJob>

Information about the Identity Resolution Job.

See Also:

  • Method Details

    • domainName

      public final String domainName()

      The unique name of the domain.

      Returns:
      The unique name of the domain.

    • jobId

      public final String jobId()

      The unique identifier of the Identity Resolution Job.

      Returns:
      The unique identifier of the Identity Resolution Job.

    • status

      public final IdentityResolutionJobStatus 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.

      If the service returns an enum value that is not available in the current SDK version, status will return IdentityResolutionJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      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.

      See Also:

    • statusAsString

      public final String statusAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, status will return IdentityResolutionJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      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.

      See Also:

    • jobStartTime

      public final Instant jobStartTime()

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

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

    • jobEndTime

      public final Instant jobEndTime()

      The timestamp of when the job was completed.

      Returns:
      The timestamp of when the job was completed.

    • jobStats

      public final JobStats jobStats()

      Statistics about an Identity Resolution Job.

      Returns:
      Statistics about an Identity Resolution Job.

    • exportingLocation

      public final ExportingLocation exportingLocation()

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

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

    • message

      public final String message()

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

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

    • toBuilder

      public IdentityResolutionJob.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<IdentityResolutionJob.Builder,IdentityResolutionJob>
      Returns:
      a builder for type T

    • builder

      public static IdentityResolutionJob.Builder builder()

    • serializableBuilderClass

      public static Class<? extends IdentityResolutionJob.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.