com.amazonaws.services.sagemaker.model.InferenceRecommendationsJob Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-sagemaker Show documentation
Show all versions of aws-java-sdk-sagemaker Show documentation
The AWS Java SDK for Amazon SageMaker module holds the client classes that are used for communicating with Amazon SageMaker Service
The newest version!
/*
* 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.sagemaker.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* A structure that contains a list of recommendation jobs.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class InferenceRecommendationsJob implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the job.
*
*/
private String jobName;
/**
*
* The job description.
*
*/
private String jobDescription;
/**
*
* The recommendation job type.
*
*/
private String jobType;
/**
*
* The Amazon Resource Name (ARN) of the recommendation job.
*
*/
private String jobArn;
/**
*
* The status of the job.
*
*/
private String status;
/**
*
* A timestamp that shows when the job was created.
*
*/
private java.util.Date creationTime;
/**
*
* A timestamp that shows when the job completed.
*
*/
private java.util.Date completionTime;
/**
*
* The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
*
*/
private String roleArn;
/**
*
* A timestamp that shows when the job was last modified.
*
*/
private java.util.Date lastModifiedTime;
/**
*
* If the job fails, provides information why the job failed.
*
*/
private String failureReason;
/**
*
* The name of the created model.
*
*/
private String modelName;
/**
*
* The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a
* single gzip compressed tar archive (.tar.gz suffix).
*
*/
private String samplePayloadUrl;
/**
*
* The Amazon Resource Name (ARN) of a versioned model package.
*
*/
private String modelPackageVersionArn;
/**
*
* The name of the job.
*
*
* @param jobName
* The name of the job.
*/
public void setJobName(String jobName) {
this.jobName = jobName;
}
/**
*
* The name of the job.
*
*
* @return The name of the job.
*/
public String getJobName() {
return this.jobName;
}
/**
*
* The name of the job.
*
*
* @param jobName
* The name of the job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InferenceRecommendationsJob withJobName(String jobName) {
setJobName(jobName);
return this;
}
/**
*
* The job description.
*
*
* @param jobDescription
* The job description.
*/
public void setJobDescription(String jobDescription) {
this.jobDescription = jobDescription;
}
/**
*
* The job description.
*
*
* @return The job description.
*/
public String getJobDescription() {
return this.jobDescription;
}
/**
*
* The job description.
*
*
* @param jobDescription
* The job description.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InferenceRecommendationsJob withJobDescription(String jobDescription) {
setJobDescription(jobDescription);
return this;
}
/**
*
* The recommendation job type.
*
*
* @param jobType
* The recommendation job type.
* @see RecommendationJobType
*/
public void setJobType(String jobType) {
this.jobType = jobType;
}
/**
*
* The recommendation job type.
*
*
* @return The recommendation job type.
* @see RecommendationJobType
*/
public String getJobType() {
return this.jobType;
}
/**
*
* The recommendation job type.
*
*
* @param jobType
* The recommendation job type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RecommendationJobType
*/
public InferenceRecommendationsJob withJobType(String jobType) {
setJobType(jobType);
return this;
}
/**
*
* The recommendation job type.
*
*
* @param jobType
* The recommendation job type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RecommendationJobType
*/
public InferenceRecommendationsJob withJobType(RecommendationJobType jobType) {
this.jobType = jobType.toString();
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the recommendation job.
*
*
* @param jobArn
* The Amazon Resource Name (ARN) of the recommendation job.
*/
public void setJobArn(String jobArn) {
this.jobArn = jobArn;
}
/**
*
* The Amazon Resource Name (ARN) of the recommendation job.
*
*
* @return The Amazon Resource Name (ARN) of the recommendation job.
*/
public String getJobArn() {
return this.jobArn;
}
/**
*
* The Amazon Resource Name (ARN) of the recommendation job.
*
*
* @param jobArn
* The Amazon Resource Name (ARN) of the recommendation job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InferenceRecommendationsJob withJobArn(String jobArn) {
setJobArn(jobArn);
return this;
}
/**
*
* The status of the job.
*
*
* @param status
* The status of the job.
* @see RecommendationJobStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the job.
*
*
* @return The status of the job.
* @see RecommendationJobStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the job.
*
*
* @param status
* The status of the job.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RecommendationJobStatus
*/
public InferenceRecommendationsJob withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The status of the job.
*
*
* @param status
* The status of the job.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RecommendationJobStatus
*/
public InferenceRecommendationsJob withStatus(RecommendationJobStatus status) {
this.status = status.toString();
return this;
}
/**
*
* A timestamp that shows when the job was created.
*
*
* @param creationTime
* A timestamp that shows when the job was created.
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* A timestamp that shows when the job was created.
*
*
* @return A timestamp that shows when the job was created.
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* A timestamp that shows when the job was created.
*
*
* @param creationTime
* A timestamp that shows when the job was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InferenceRecommendationsJob withCreationTime(java.util.Date creationTime) {
setCreationTime(creationTime);
return this;
}
/**
*
* A timestamp that shows when the job completed.
*
*
* @param completionTime
* A timestamp that shows when the job completed.
*/
public void setCompletionTime(java.util.Date completionTime) {
this.completionTime = completionTime;
}
/**
*
* A timestamp that shows when the job completed.
*
*
* @return A timestamp that shows when the job completed.
*/
public java.util.Date getCompletionTime() {
return this.completionTime;
}
/**
*
* A timestamp that shows when the job completed.
*
*
* @param completionTime
* A timestamp that shows when the job completed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InferenceRecommendationsJob withCompletionTime(java.util.Date completionTime) {
setCompletionTime(completionTime);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your
* behalf.
*/
public void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
/**
*
* The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
*
*
* @return The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your
* behalf.
*/
public String getRoleArn() {
return this.roleArn;
}
/**
*
* The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your
* behalf.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InferenceRecommendationsJob withRoleArn(String roleArn) {
setRoleArn(roleArn);
return this;
}
/**
*
* A timestamp that shows when the job was last modified.
*
*
* @param lastModifiedTime
* A timestamp that shows when the job was last modified.
*/
public void setLastModifiedTime(java.util.Date lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
}
/**
*
* A timestamp that shows when the job was last modified.
*
*
* @return A timestamp that shows when the job was last modified.
*/
public java.util.Date getLastModifiedTime() {
return this.lastModifiedTime;
}
/**
*
* A timestamp that shows when the job was last modified.
*
*
* @param lastModifiedTime
* A timestamp that shows when the job was last modified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InferenceRecommendationsJob withLastModifiedTime(java.util.Date lastModifiedTime) {
setLastModifiedTime(lastModifiedTime);
return this;
}
/**
*
* If the job fails, provides information why the job failed.
*
*
* @param failureReason
* If the job fails, provides information why the job failed.
*/
public void setFailureReason(String failureReason) {
this.failureReason = failureReason;
}
/**
*
* If the job fails, provides information why the job failed.
*
*
* @return If the job fails, provides information why the job failed.
*/
public String getFailureReason() {
return this.failureReason;
}
/**
*
* If the job fails, provides information why the job failed.
*
*
* @param failureReason
* If the job fails, provides information why the job failed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InferenceRecommendationsJob withFailureReason(String failureReason) {
setFailureReason(failureReason);
return this;
}
/**
*
* The name of the created model.
*
*
* @param modelName
* The name of the created model.
*/
public void setModelName(String modelName) {
this.modelName = modelName;
}
/**
*
* The name of the created model.
*
*
* @return The name of the created model.
*/
public String getModelName() {
return this.modelName;
}
/**
*
* The name of the created model.
*
*
* @param modelName
* The name of the created model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InferenceRecommendationsJob withModelName(String modelName) {
setModelName(modelName);
return this;
}
/**
*
* The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a
* single gzip compressed tar archive (.tar.gz suffix).
*
*
* @param samplePayloadUrl
* The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must
* point to a single gzip compressed tar archive (.tar.gz suffix).
*/
public void setSamplePayloadUrl(String samplePayloadUrl) {
this.samplePayloadUrl = samplePayloadUrl;
}
/**
*
* The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a
* single gzip compressed tar archive (.tar.gz suffix).
*
*
* @return The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must
* point to a single gzip compressed tar archive (.tar.gz suffix).
*/
public String getSamplePayloadUrl() {
return this.samplePayloadUrl;
}
/**
*
* The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a
* single gzip compressed tar archive (.tar.gz suffix).
*
*
* @param samplePayloadUrl
* The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must
* point to a single gzip compressed tar archive (.tar.gz suffix).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InferenceRecommendationsJob withSamplePayloadUrl(String samplePayloadUrl) {
setSamplePayloadUrl(samplePayloadUrl);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of a versioned model package.
*
*
* @param modelPackageVersionArn
* The Amazon Resource Name (ARN) of a versioned model package.
*/
public void setModelPackageVersionArn(String modelPackageVersionArn) {
this.modelPackageVersionArn = modelPackageVersionArn;
}
/**
*
* The Amazon Resource Name (ARN) of a versioned model package.
*
*
* @return The Amazon Resource Name (ARN) of a versioned model package.
*/
public String getModelPackageVersionArn() {
return this.modelPackageVersionArn;
}
/**
*
* The Amazon Resource Name (ARN) of a versioned model package.
*
*
* @param modelPackageVersionArn
* The Amazon Resource Name (ARN) of a versioned model package.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InferenceRecommendationsJob withModelPackageVersionArn(String modelPackageVersionArn) {
setModelPackageVersionArn(modelPackageVersionArn);
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 (getJobDescription() != null)
sb.append("JobDescription: ").append(getJobDescription()).append(",");
if (getJobType() != null)
sb.append("JobType: ").append(getJobType()).append(",");
if (getJobArn() != null)
sb.append("JobArn: ").append(getJobArn()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getCreationTime() != null)
sb.append("CreationTime: ").append(getCreationTime()).append(",");
if (getCompletionTime() != null)
sb.append("CompletionTime: ").append(getCompletionTime()).append(",");
if (getRoleArn() != null)
sb.append("RoleArn: ").append(getRoleArn()).append(",");
if (getLastModifiedTime() != null)
sb.append("LastModifiedTime: ").append(getLastModifiedTime()).append(",");
if (getFailureReason() != null)
sb.append("FailureReason: ").append(getFailureReason()).append(",");
if (getModelName() != null)
sb.append("ModelName: ").append(getModelName()).append(",");
if (getSamplePayloadUrl() != null)
sb.append("SamplePayloadUrl: ").append(getSamplePayloadUrl()).append(",");
if (getModelPackageVersionArn() != null)
sb.append("ModelPackageVersionArn: ").append(getModelPackageVersionArn());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof InferenceRecommendationsJob == false)
return false;
InferenceRecommendationsJob other = (InferenceRecommendationsJob) obj;
if (other.getJobName() == null ^ this.getJobName() == null)
return false;
if (other.getJobName() != null && other.getJobName().equals(this.getJobName()) == false)
return false;
if (other.getJobDescription() == null ^ this.getJobDescription() == null)
return false;
if (other.getJobDescription() != null && other.getJobDescription().equals(this.getJobDescription()) == false)
return false;
if (other.getJobType() == null ^ this.getJobType() == null)
return false;
if (other.getJobType() != null && other.getJobType().equals(this.getJobType()) == false)
return false;
if (other.getJobArn() == null ^ this.getJobArn() == null)
return false;
if (other.getJobArn() != null && other.getJobArn().equals(this.getJobArn()) == 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.getCreationTime() == null ^ this.getCreationTime() == null)
return false;
if (other.getCreationTime() != null && other.getCreationTime().equals(this.getCreationTime()) == false)
return false;
if (other.getCompletionTime() == null ^ this.getCompletionTime() == null)
return false;
if (other.getCompletionTime() != null && other.getCompletionTime().equals(this.getCompletionTime()) == 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.getLastModifiedTime() == null ^ this.getLastModifiedTime() == null)
return false;
if (other.getLastModifiedTime() != null && other.getLastModifiedTime().equals(this.getLastModifiedTime()) == 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.getModelName() == null ^ this.getModelName() == null)
return false;
if (other.getModelName() != null && other.getModelName().equals(this.getModelName()) == false)
return false;
if (other.getSamplePayloadUrl() == null ^ this.getSamplePayloadUrl() == null)
return false;
if (other.getSamplePayloadUrl() != null && other.getSamplePayloadUrl().equals(this.getSamplePayloadUrl()) == false)
return false;
if (other.getModelPackageVersionArn() == null ^ this.getModelPackageVersionArn() == null)
return false;
if (other.getModelPackageVersionArn() != null && other.getModelPackageVersionArn().equals(this.getModelPackageVersionArn()) == 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 + ((getJobDescription() == null) ? 0 : getJobDescription().hashCode());
hashCode = prime * hashCode + ((getJobType() == null) ? 0 : getJobType().hashCode());
hashCode = prime * hashCode + ((getJobArn() == null) ? 0 : getJobArn().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode());
hashCode = prime * hashCode + ((getCompletionTime() == null) ? 0 : getCompletionTime().hashCode());
hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode());
hashCode = prime * hashCode + ((getLastModifiedTime() == null) ? 0 : getLastModifiedTime().hashCode());
hashCode = prime * hashCode + ((getFailureReason() == null) ? 0 : getFailureReason().hashCode());
hashCode = prime * hashCode + ((getModelName() == null) ? 0 : getModelName().hashCode());
hashCode = prime * hashCode + ((getSamplePayloadUrl() == null) ? 0 : getSamplePayloadUrl().hashCode());
hashCode = prime * hashCode + ((getModelPackageVersionArn() == null) ? 0 : getModelPackageVersionArn().hashCode());
return hashCode;
}
@Override
public InferenceRecommendationsJob clone() {
try {
return (InferenceRecommendationsJob) 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.sagemaker.model.transform.InferenceRecommendationsJobMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy