com.amazonaws.services.customerprofiles.model.IdentityResolutionJob Maven / Gradle / Ivy
Show all versions of aws-java-sdk-customerprofiles Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.customerprofiles.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Information about the Identity Resolution Job.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class IdentityResolutionJob implements Serializable, Cloneable, StructuredPojo {
/**
*
* The unique name of the domain.
*
*/
private String domainName;
/**
*
* The unique identifier of the Identity Resolution Job.
*
*/
private String jobId;
/**
*
* 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.
*
*
*
*/
private String status;
/**
*
* The timestamp of when the job was started or will be started.
*
*/
private java.util.Date jobStartTime;
/**
*
* The timestamp of when the job was completed.
*
*/
private java.util.Date jobEndTime;
/**
*
* Statistics about an Identity Resolution Job.
*
*/
private JobStats jobStats;
/**
*
* The S3 location where the Identity Resolution Job writes result files.
*
*/
private ExportingLocation exportingLocation;
/**
*
* The error messages that are generated when the Identity Resolution Job runs.
*
*/
private String message;
/**
*
* The unique name of the domain.
*
*
* @param domainName
* The unique name of the domain.
*/
public void setDomainName(String domainName) {
this.domainName = domainName;
}
/**
*
* The unique name of the domain.
*
*
* @return The unique name of the domain.
*/
public String getDomainName() {
return this.domainName;
}
/**
*
* The unique name of the domain.
*
*
* @param domainName
* The unique name of the domain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IdentityResolutionJob withDomainName(String domainName) {
setDomainName(domainName);
return this;
}
/**
*
* The unique identifier of the Identity Resolution Job.
*
*
* @param jobId
* The unique identifier of the Identity Resolution Job.
*/
public void setJobId(String jobId) {
this.jobId = jobId;
}
/**
*
* The unique identifier of the Identity Resolution Job.
*
*
* @return The unique identifier of the Identity Resolution Job.
*/
public String getJobId() {
return this.jobId;
}
/**
*
* The unique identifier of the Identity Resolution Job.
*
*
* @param jobId
* The unique identifier of the Identity Resolution Job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IdentityResolutionJob withJobId(String jobId) {
setJobId(jobId);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @see IdentityResolutionJobStatus
*/
public void setStatus(String status) {
this.status = 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.
*
*
*
*
* @return 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 IdentityResolutionJobStatus
*/
public String getStatus() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see IdentityResolutionJobStatus
*/
public IdentityResolutionJob withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see IdentityResolutionJobStatus
*/
public IdentityResolutionJob withStatus(IdentityResolutionJobStatus status) {
this.status = status.toString();
return this;
}
/**
*
* The timestamp of when the job was started or will be started.
*
*
* @param jobStartTime
* The timestamp of when the job was started or will be started.
*/
public void setJobStartTime(java.util.Date jobStartTime) {
this.jobStartTime = jobStartTime;
}
/**
*
* The timestamp of when the job was started or will be started.
*
*
* @return The timestamp of when the job was started or will be started.
*/
public java.util.Date getJobStartTime() {
return this.jobStartTime;
}
/**
*
* The timestamp of when the job was started or will be started.
*
*
* @param jobStartTime
* The timestamp of when the job was started or will be started.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IdentityResolutionJob withJobStartTime(java.util.Date jobStartTime) {
setJobStartTime(jobStartTime);
return this;
}
/**
*
* The timestamp of when the job was completed.
*
*
* @param jobEndTime
* The timestamp of when the job was completed.
*/
public void setJobEndTime(java.util.Date jobEndTime) {
this.jobEndTime = jobEndTime;
}
/**
*
* The timestamp of when the job was completed.
*
*
* @return The timestamp of when the job was completed.
*/
public java.util.Date getJobEndTime() {
return this.jobEndTime;
}
/**
*
* The timestamp of when the job was completed.
*
*
* @param jobEndTime
* The timestamp of when the job was completed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IdentityResolutionJob withJobEndTime(java.util.Date jobEndTime) {
setJobEndTime(jobEndTime);
return this;
}
/**
*
* Statistics about an Identity Resolution Job.
*
*
* @param jobStats
* Statistics about an Identity Resolution Job.
*/
public void setJobStats(JobStats jobStats) {
this.jobStats = jobStats;
}
/**
*
* Statistics about an Identity Resolution Job.
*
*
* @return Statistics about an Identity Resolution Job.
*/
public JobStats getJobStats() {
return this.jobStats;
}
/**
*
* Statistics about an Identity Resolution Job.
*
*
* @param jobStats
* Statistics about an Identity Resolution Job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IdentityResolutionJob withJobStats(JobStats jobStats) {
setJobStats(jobStats);
return this;
}
/**
*
* The S3 location where the Identity Resolution Job writes result files.
*
*
* @param exportingLocation
* The S3 location where the Identity Resolution Job writes result files.
*/
public void setExportingLocation(ExportingLocation exportingLocation) {
this.exportingLocation = exportingLocation;
}
/**
*
* The S3 location where the Identity Resolution Job writes result files.
*
*
* @return The S3 location where the Identity Resolution Job writes result files.
*/
public ExportingLocation getExportingLocation() {
return this.exportingLocation;
}
/**
*
* The S3 location where the Identity Resolution Job writes result files.
*
*
* @param exportingLocation
* The S3 location where the Identity Resolution Job writes result files.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IdentityResolutionJob withExportingLocation(ExportingLocation exportingLocation) {
setExportingLocation(exportingLocation);
return this;
}
/**
*
* The error messages that are generated when the Identity Resolution Job runs.
*
*
* @param message
* The error messages that are generated when the Identity Resolution Job runs.
*/
public void setMessage(String message) {
this.message = message;
}
/**
*
* The error messages that are generated when the Identity Resolution Job runs.
*
*
* @return The error messages that are generated when the Identity Resolution Job runs.
*/
public String getMessage() {
return this.message;
}
/**
*
* The error messages that are generated when the Identity Resolution Job runs.
*
*
* @param message
* The error messages that are generated when the Identity Resolution Job runs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IdentityResolutionJob withMessage(String message) {
setMessage(message);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDomainName() != null)
sb.append("DomainName: ").append(getDomainName()).append(",");
if (getJobId() != null)
sb.append("JobId: ").append(getJobId()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getJobStartTime() != null)
sb.append("JobStartTime: ").append(getJobStartTime()).append(",");
if (getJobEndTime() != null)
sb.append("JobEndTime: ").append(getJobEndTime()).append(",");
if (getJobStats() != null)
sb.append("JobStats: ").append(getJobStats()).append(",");
if (getExportingLocation() != null)
sb.append("ExportingLocation: ").append(getExportingLocation()).append(",");
if (getMessage() != null)
sb.append("Message: ").append(getMessage());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof IdentityResolutionJob == false)
return false;
IdentityResolutionJob other = (IdentityResolutionJob) obj;
if (other.getDomainName() == null ^ this.getDomainName() == null)
return false;
if (other.getDomainName() != null && other.getDomainName().equals(this.getDomainName()) == false)
return false;
if (other.getJobId() == null ^ this.getJobId() == null)
return false;
if (other.getJobId() != null && other.getJobId().equals(this.getJobId()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getJobStartTime() == null ^ this.getJobStartTime() == null)
return false;
if (other.getJobStartTime() != null && other.getJobStartTime().equals(this.getJobStartTime()) == false)
return false;
if (other.getJobEndTime() == null ^ this.getJobEndTime() == null)
return false;
if (other.getJobEndTime() != null && other.getJobEndTime().equals(this.getJobEndTime()) == false)
return false;
if (other.getJobStats() == null ^ this.getJobStats() == null)
return false;
if (other.getJobStats() != null && other.getJobStats().equals(this.getJobStats()) == false)
return false;
if (other.getExportingLocation() == null ^ this.getExportingLocation() == null)
return false;
if (other.getExportingLocation() != null && other.getExportingLocation().equals(this.getExportingLocation()) == false)
return false;
if (other.getMessage() == null ^ this.getMessage() == null)
return false;
if (other.getMessage() != null && other.getMessage().equals(this.getMessage()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDomainName() == null) ? 0 : getDomainName().hashCode());
hashCode = prime * hashCode + ((getJobId() == null) ? 0 : getJobId().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getJobStartTime() == null) ? 0 : getJobStartTime().hashCode());
hashCode = prime * hashCode + ((getJobEndTime() == null) ? 0 : getJobEndTime().hashCode());
hashCode = prime * hashCode + ((getJobStats() == null) ? 0 : getJobStats().hashCode());
hashCode = prime * hashCode + ((getExportingLocation() == null) ? 0 : getExportingLocation().hashCode());
hashCode = prime * hashCode + ((getMessage() == null) ? 0 : getMessage().hashCode());
return hashCode;
}
@Override
public IdentityResolutionJob clone() {
try {
return (IdentityResolutionJob) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.customerprofiles.model.transform.IdentityResolutionJobMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}