Package software.amazon.awssdk.services.customerprofiles.model

Class GetIdentityResolutionJobResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesResponse
software.amazon.awssdk.services.customerprofiles.model.GetIdentityResolutionJobResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetIdentityResolutionJobResponse.Builder,GetIdentityResolutionJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetIdentityResolutionJobResponse extends CustomerProfilesResponse implements ToCopyableBuilder<GetIdentityResolutionJobResponse.Builder,GetIdentityResolutionJobResponse>

  • 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:

    • 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.

    • jobStartTime

      public final Instant jobStartTime()

      The timestamp of when the Identity Resolution Job was started or will be started.

      Returns:
      The timestamp of when the Identity Resolution Job was started or will be started.

    • jobEndTime

      public final Instant jobEndTime()

      The timestamp of when the Identity Resolution Job was completed.

      Returns:
      The timestamp of when the Identity Resolution Job was completed.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The timestamp of when the Identity Resolution Job was most recently edited.

      Returns:
      The timestamp of when the Identity Resolution Job was most recently edited.

    • jobExpirationTime

      public final Instant jobExpirationTime()

      The timestamp of when the Identity Resolution Job will expire.

      Returns:
      The timestamp of when the Identity Resolution Job will expire.

    • autoMerging

      public final AutoMerging autoMerging()

      Configuration settings for how to perform the auto-merging of profiles.

      Returns:
      Configuration settings for how to perform the auto-merging of profiles.

    • 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.

    • jobStats

      public final JobStats jobStats()

      Statistics about the Identity Resolution Job.

      Returns:
      Statistics about the Identity Resolution Job.

    • toBuilder

      public GetIdentityResolutionJobResponse.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<GetIdentityResolutionJobResponse.Builder,GetIdentityResolutionJobResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetIdentityResolutionJobResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.