com.amazonaws.services.personalize.model.BatchSegmentJob Maven / Gradle / Ivy
Show all versions of aws-java-sdk-personalize 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.personalize.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Contains information on a batch segment job.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class BatchSegmentJob implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the batch segment job.
*
*/
private String jobName;
/**
*
* The Amazon Resource Name (ARN) of the batch segment job.
*
*/
private String batchSegmentJobArn;
/**
*
* The ARN of the filter used on the batch segment job.
*
*/
private String filterArn;
/**
*
* If the batch segment job failed, the reason for the failure.
*
*/
private String failureReason;
/**
*
* The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
*
*/
private String solutionVersionArn;
/**
*
* The number of predicted users generated by the batch segment job for each line of input data. The maximum number
* of users per segment is 5 million.
*
*/
private Integer numResults;
/**
*
* The Amazon S3 path that leads to the input data used to generate the batch segment job.
*
*/
private BatchSegmentJobInput jobInput;
/**
*
* The Amazon S3 bucket that contains the output data generated by the batch segment job.
*
*/
private BatchSegmentJobOutput jobOutput;
/**
*
* The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
*
*/
private String roleArn;
/**
*
* The status of the batch segment job. The status is one of the following values:
*
*
* -
*
* PENDING
*
*
* -
*
* IN PROGRESS
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE FAILED
*
*
*
*/
private String status;
/**
*
* The time at which the batch segment job was created.
*
*/
private java.util.Date creationDateTime;
/**
*
* The time at which the batch segment job last updated.
*
*/
private java.util.Date lastUpdatedDateTime;
/**
*
* The name of the batch segment job.
*
*
* @param jobName
* The name of the batch segment job.
*/
public void setJobName(String jobName) {
this.jobName = jobName;
}
/**
*
* The name of the batch segment job.
*
*
* @return The name of the batch segment job.
*/
public String getJobName() {
return this.jobName;
}
/**
*
* The name of the batch segment job.
*
*
* @param jobName
* The name of the batch segment job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchSegmentJob withJobName(String jobName) {
setJobName(jobName);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the batch segment job.
*
*
* @param batchSegmentJobArn
* The Amazon Resource Name (ARN) of the batch segment job.
*/
public void setBatchSegmentJobArn(String batchSegmentJobArn) {
this.batchSegmentJobArn = batchSegmentJobArn;
}
/**
*
* The Amazon Resource Name (ARN) of the batch segment job.
*
*
* @return The Amazon Resource Name (ARN) of the batch segment job.
*/
public String getBatchSegmentJobArn() {
return this.batchSegmentJobArn;
}
/**
*
* The Amazon Resource Name (ARN) of the batch segment job.
*
*
* @param batchSegmentJobArn
* The Amazon Resource Name (ARN) of the batch segment job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchSegmentJob withBatchSegmentJobArn(String batchSegmentJobArn) {
setBatchSegmentJobArn(batchSegmentJobArn);
return this;
}
/**
*
* The ARN of the filter used on the batch segment job.
*
*
* @param filterArn
* The ARN of the filter used on the batch segment job.
*/
public void setFilterArn(String filterArn) {
this.filterArn = filterArn;
}
/**
*
* The ARN of the filter used on the batch segment job.
*
*
* @return The ARN of the filter used on the batch segment job.
*/
public String getFilterArn() {
return this.filterArn;
}
/**
*
* The ARN of the filter used on the batch segment job.
*
*
* @param filterArn
* The ARN of the filter used on the batch segment job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchSegmentJob withFilterArn(String filterArn) {
setFilterArn(filterArn);
return this;
}
/**
*
* If the batch segment job failed, the reason for the failure.
*
*
* @param failureReason
* If the batch segment job failed, the reason for the failure.
*/
public void setFailureReason(String failureReason) {
this.failureReason = failureReason;
}
/**
*
* If the batch segment job failed, the reason for the failure.
*
*
* @return If the batch segment job failed, the reason for the failure.
*/
public String getFailureReason() {
return this.failureReason;
}
/**
*
* If the batch segment job failed, the reason for the failure.
*
*
* @param failureReason
* If the batch segment job failed, the reason for the failure.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchSegmentJob withFailureReason(String failureReason) {
setFailureReason(failureReason);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
*
*
* @param solutionVersionArn
* The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch
* segments.
*/
public void setSolutionVersionArn(String solutionVersionArn) {
this.solutionVersionArn = solutionVersionArn;
}
/**
*
* The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
*
*
* @return The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch
* segments.
*/
public String getSolutionVersionArn() {
return this.solutionVersionArn;
}
/**
*
* The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
*
*
* @param solutionVersionArn
* The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch
* segments.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchSegmentJob withSolutionVersionArn(String solutionVersionArn) {
setSolutionVersionArn(solutionVersionArn);
return this;
}
/**
*
* The number of predicted users generated by the batch segment job for each line of input data. The maximum number
* of users per segment is 5 million.
*
*
* @param numResults
* The number of predicted users generated by the batch segment job for each line of input data. The maximum
* number of users per segment is 5 million.
*/
public void setNumResults(Integer numResults) {
this.numResults = numResults;
}
/**
*
* The number of predicted users generated by the batch segment job for each line of input data. The maximum number
* of users per segment is 5 million.
*
*
* @return The number of predicted users generated by the batch segment job for each line of input data. The maximum
* number of users per segment is 5 million.
*/
public Integer getNumResults() {
return this.numResults;
}
/**
*
* The number of predicted users generated by the batch segment job for each line of input data. The maximum number
* of users per segment is 5 million.
*
*
* @param numResults
* The number of predicted users generated by the batch segment job for each line of input data. The maximum
* number of users per segment is 5 million.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchSegmentJob withNumResults(Integer numResults) {
setNumResults(numResults);
return this;
}
/**
*
* The Amazon S3 path that leads to the input data used to generate the batch segment job.
*
*
* @param jobInput
* The Amazon S3 path that leads to the input data used to generate the batch segment job.
*/
public void setJobInput(BatchSegmentJobInput jobInput) {
this.jobInput = jobInput;
}
/**
*
* The Amazon S3 path that leads to the input data used to generate the batch segment job.
*
*
* @return The Amazon S3 path that leads to the input data used to generate the batch segment job.
*/
public BatchSegmentJobInput getJobInput() {
return this.jobInput;
}
/**
*
* The Amazon S3 path that leads to the input data used to generate the batch segment job.
*
*
* @param jobInput
* The Amazon S3 path that leads to the input data used to generate the batch segment job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchSegmentJob withJobInput(BatchSegmentJobInput jobInput) {
setJobInput(jobInput);
return this;
}
/**
*
* The Amazon S3 bucket that contains the output data generated by the batch segment job.
*
*
* @param jobOutput
* The Amazon S3 bucket that contains the output data generated by the batch segment job.
*/
public void setJobOutput(BatchSegmentJobOutput jobOutput) {
this.jobOutput = jobOutput;
}
/**
*
* The Amazon S3 bucket that contains the output data generated by the batch segment job.
*
*
* @return The Amazon S3 bucket that contains the output data generated by the batch segment job.
*/
public BatchSegmentJobOutput getJobOutput() {
return this.jobOutput;
}
/**
*
* The Amazon S3 bucket that contains the output data generated by the batch segment job.
*
*
* @param jobOutput
* The Amazon S3 bucket that contains the output data generated by the batch segment job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchSegmentJob withJobOutput(BatchSegmentJobOutput jobOutput) {
setJobOutput(jobOutput);
return this;
}
/**
*
* The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
*
*
* @param roleArn
* The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
*/
public void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
/**
*
* The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
*
*
* @return The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
*/
public String getRoleArn() {
return this.roleArn;
}
/**
*
* The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
*
*
* @param roleArn
* The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchSegmentJob withRoleArn(String roleArn) {
setRoleArn(roleArn);
return this;
}
/**
*
* The status of the batch segment job. The status is one of the following values:
*
*
* -
*
* PENDING
*
*
* -
*
* IN PROGRESS
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE FAILED
*
*
*
*
* @param status
* The status of the batch segment job. The status is one of the following values:
*
* -
*
* PENDING
*
*
* -
*
* IN PROGRESS
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE FAILED
*
*
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the batch segment job. The status is one of the following values:
*
*
* -
*
* PENDING
*
*
* -
*
* IN PROGRESS
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE FAILED
*
*
*
*
* @return The status of the batch segment job. The status is one of the following values:
*
* -
*
* PENDING
*
*
* -
*
* IN PROGRESS
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE FAILED
*
*
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the batch segment job. The status is one of the following values:
*
*
* -
*
* PENDING
*
*
* -
*
* IN PROGRESS
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE FAILED
*
*
*
*
* @param status
* The status of the batch segment job. The status is one of the following values:
*
* -
*
* PENDING
*
*
* -
*
* IN PROGRESS
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE FAILED
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchSegmentJob withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The time at which the batch segment job was created.
*
*
* @param creationDateTime
* The time at which the batch segment job was created.
*/
public void setCreationDateTime(java.util.Date creationDateTime) {
this.creationDateTime = creationDateTime;
}
/**
*
* The time at which the batch segment job was created.
*
*
* @return The time at which the batch segment job was created.
*/
public java.util.Date getCreationDateTime() {
return this.creationDateTime;
}
/**
*
* The time at which the batch segment job was created.
*
*
* @param creationDateTime
* The time at which the batch segment job was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchSegmentJob withCreationDateTime(java.util.Date creationDateTime) {
setCreationDateTime(creationDateTime);
return this;
}
/**
*
* The time at which the batch segment job last updated.
*
*
* @param lastUpdatedDateTime
* The time at which the batch segment job last updated.
*/
public void setLastUpdatedDateTime(java.util.Date lastUpdatedDateTime) {
this.lastUpdatedDateTime = lastUpdatedDateTime;
}
/**
*
* The time at which the batch segment job last updated.
*
*
* @return The time at which the batch segment job last updated.
*/
public java.util.Date getLastUpdatedDateTime() {
return this.lastUpdatedDateTime;
}
/**
*
* The time at which the batch segment job last updated.
*
*
* @param lastUpdatedDateTime
* The time at which the batch segment job last updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchSegmentJob withLastUpdatedDateTime(java.util.Date lastUpdatedDateTime) {
setLastUpdatedDateTime(lastUpdatedDateTime);
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 (getJobName() != null)
sb.append("JobName: ").append(getJobName()).append(",");
if (getBatchSegmentJobArn() != null)
sb.append("BatchSegmentJobArn: ").append(getBatchSegmentJobArn()).append(",");
if (getFilterArn() != null)
sb.append("FilterArn: ").append(getFilterArn()).append(",");
if (getFailureReason() != null)
sb.append("FailureReason: ").append(getFailureReason()).append(",");
if (getSolutionVersionArn() != null)
sb.append("SolutionVersionArn: ").append(getSolutionVersionArn()).append(",");
if (getNumResults() != null)
sb.append("NumResults: ").append(getNumResults()).append(",");
if (getJobInput() != null)
sb.append("JobInput: ").append(getJobInput()).append(",");
if (getJobOutput() != null)
sb.append("JobOutput: ").append(getJobOutput()).append(",");
if (getRoleArn() != null)
sb.append("RoleArn: ").append(getRoleArn()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getCreationDateTime() != null)
sb.append("CreationDateTime: ").append(getCreationDateTime()).append(",");
if (getLastUpdatedDateTime() != null)
sb.append("LastUpdatedDateTime: ").append(getLastUpdatedDateTime());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof BatchSegmentJob == false)
return false;
BatchSegmentJob other = (BatchSegmentJob) obj;
if (other.getJobName() == null ^ this.getJobName() == null)
return false;
if (other.getJobName() != null && other.getJobName().equals(this.getJobName()) == false)
return false;
if (other.getBatchSegmentJobArn() == null ^ this.getBatchSegmentJobArn() == null)
return false;
if (other.getBatchSegmentJobArn() != null && other.getBatchSegmentJobArn().equals(this.getBatchSegmentJobArn()) == false)
return false;
if (other.getFilterArn() == null ^ this.getFilterArn() == null)
return false;
if (other.getFilterArn() != null && other.getFilterArn().equals(this.getFilterArn()) == false)
return false;
if (other.getFailureReason() == null ^ this.getFailureReason() == null)
return false;
if (other.getFailureReason() != null && other.getFailureReason().equals(this.getFailureReason()) == false)
return false;
if (other.getSolutionVersionArn() == null ^ this.getSolutionVersionArn() == null)
return false;
if (other.getSolutionVersionArn() != null && other.getSolutionVersionArn().equals(this.getSolutionVersionArn()) == false)
return false;
if (other.getNumResults() == null ^ this.getNumResults() == null)
return false;
if (other.getNumResults() != null && other.getNumResults().equals(this.getNumResults()) == false)
return false;
if (other.getJobInput() == null ^ this.getJobInput() == null)
return false;
if (other.getJobInput() != null && other.getJobInput().equals(this.getJobInput()) == false)
return false;
if (other.getJobOutput() == null ^ this.getJobOutput() == null)
return false;
if (other.getJobOutput() != null && other.getJobOutput().equals(this.getJobOutput()) == false)
return false;
if (other.getRoleArn() == null ^ this.getRoleArn() == null)
return false;
if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == 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.getCreationDateTime() == null ^ this.getCreationDateTime() == null)
return false;
if (other.getCreationDateTime() != null && other.getCreationDateTime().equals(this.getCreationDateTime()) == false)
return false;
if (other.getLastUpdatedDateTime() == null ^ this.getLastUpdatedDateTime() == null)
return false;
if (other.getLastUpdatedDateTime() != null && other.getLastUpdatedDateTime().equals(this.getLastUpdatedDateTime()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getJobName() == null) ? 0 : getJobName().hashCode());
hashCode = prime * hashCode + ((getBatchSegmentJobArn() == null) ? 0 : getBatchSegmentJobArn().hashCode());
hashCode = prime * hashCode + ((getFilterArn() == null) ? 0 : getFilterArn().hashCode());
hashCode = prime * hashCode + ((getFailureReason() == null) ? 0 : getFailureReason().hashCode());
hashCode = prime * hashCode + ((getSolutionVersionArn() == null) ? 0 : getSolutionVersionArn().hashCode());
hashCode = prime * hashCode + ((getNumResults() == null) ? 0 : getNumResults().hashCode());
hashCode = prime * hashCode + ((getJobInput() == null) ? 0 : getJobInput().hashCode());
hashCode = prime * hashCode + ((getJobOutput() == null) ? 0 : getJobOutput().hashCode());
hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getCreationDateTime() == null) ? 0 : getCreationDateTime().hashCode());
hashCode = prime * hashCode + ((getLastUpdatedDateTime() == null) ? 0 : getLastUpdatedDateTime().hashCode());
return hashCode;
}
@Override
public BatchSegmentJob clone() {
try {
return (BatchSegmentJob) 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.personalize.model.transform.BatchSegmentJobMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}