com.amazonaws.services.personalize.model.SolutionVersionSummary 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;
/**
*
* Provides a summary of the properties of a solution version. For a complete listing, call the DescribeSolutionVersion
* API.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SolutionVersionSummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon Resource Name (ARN) of the solution version.
*
*/
private String solutionVersionArn;
/**
*
* The status of the solution version.
*
*
* A solution version can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
*
*/
private String status;
/**
*
* The scope of training to be performed when creating the solution version. A FULL training considers
* all of the data in your dataset group. An UPDATE processes only the data that has changed since the
* latest training. Only solution versions created with the User-Personalization recipe can use UPDATE.
*
*/
private String trainingMode;
/**
*
* Whether the solution version was created automatically or manually.
*
*/
private String trainingType;
/**
*
* The date and time (in Unix time) that this version of a solution was created.
*
*/
private java.util.Date creationDateTime;
/**
*
* The date and time (in Unix time) that the solution version was last updated.
*
*/
private java.util.Date lastUpdatedDateTime;
/**
*
* If a solution version fails, the reason behind the failure.
*
*/
private String failureReason;
/**
*
* The Amazon Resource Name (ARN) of the solution version.
*
*
* @param solutionVersionArn
* The Amazon Resource Name (ARN) of the solution version.
*/
public void setSolutionVersionArn(String solutionVersionArn) {
this.solutionVersionArn = solutionVersionArn;
}
/**
*
* The Amazon Resource Name (ARN) of the solution version.
*
*
* @return The Amazon Resource Name (ARN) of the solution version.
*/
public String getSolutionVersionArn() {
return this.solutionVersionArn;
}
/**
*
* The Amazon Resource Name (ARN) of the solution version.
*
*
* @param solutionVersionArn
* The Amazon Resource Name (ARN) of the solution version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SolutionVersionSummary withSolutionVersionArn(String solutionVersionArn) {
setSolutionVersionArn(solutionVersionArn);
return this;
}
/**
*
* The status of the solution version.
*
*
* A solution version can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
*
*
* @param status
* The status of the solution version.
*
* A solution version can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the solution version.
*
*
* A solution version can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
*
*
* @return The status of the solution version.
*
* A solution version can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the solution version.
*
*
* A solution version can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
*
*
* @param status
* The status of the solution version.
*
* A solution version can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SolutionVersionSummary withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The scope of training to be performed when creating the solution version. A FULL training considers
* all of the data in your dataset group. An UPDATE processes only the data that has changed since the
* latest training. Only solution versions created with the User-Personalization recipe can use UPDATE.
*
*
* @param trainingMode
* The scope of training to be performed when creating the solution version. A FULL training
* considers all of the data in your dataset group. An UPDATE processes only the data that has
* changed since the latest training. Only solution versions created with the User-Personalization recipe can
* use UPDATE.
* @see TrainingMode
*/
public void setTrainingMode(String trainingMode) {
this.trainingMode = trainingMode;
}
/**
*
* The scope of training to be performed when creating the solution version. A FULL training considers
* all of the data in your dataset group. An UPDATE processes only the data that has changed since the
* latest training. Only solution versions created with the User-Personalization recipe can use UPDATE.
*
*
* @return The scope of training to be performed when creating the solution version. A FULL training
* considers all of the data in your dataset group. An UPDATE processes only the data that has
* changed since the latest training. Only solution versions created with the User-Personalization recipe
* can use UPDATE.
* @see TrainingMode
*/
public String getTrainingMode() {
return this.trainingMode;
}
/**
*
* The scope of training to be performed when creating the solution version. A FULL training considers
* all of the data in your dataset group. An UPDATE processes only the data that has changed since the
* latest training. Only solution versions created with the User-Personalization recipe can use UPDATE.
*
*
* @param trainingMode
* The scope of training to be performed when creating the solution version. A FULL training
* considers all of the data in your dataset group. An UPDATE processes only the data that has
* changed since the latest training. Only solution versions created with the User-Personalization recipe can
* use UPDATE.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TrainingMode
*/
public SolutionVersionSummary withTrainingMode(String trainingMode) {
setTrainingMode(trainingMode);
return this;
}
/**
*
* The scope of training to be performed when creating the solution version. A FULL training considers
* all of the data in your dataset group. An UPDATE processes only the data that has changed since the
* latest training. Only solution versions created with the User-Personalization recipe can use UPDATE.
*
*
* @param trainingMode
* The scope of training to be performed when creating the solution version. A FULL training
* considers all of the data in your dataset group. An UPDATE processes only the data that has
* changed since the latest training. Only solution versions created with the User-Personalization recipe can
* use UPDATE.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TrainingMode
*/
public SolutionVersionSummary withTrainingMode(TrainingMode trainingMode) {
this.trainingMode = trainingMode.toString();
return this;
}
/**
*
* Whether the solution version was created automatically or manually.
*
*
* @param trainingType
* Whether the solution version was created automatically or manually.
* @see TrainingType
*/
public void setTrainingType(String trainingType) {
this.trainingType = trainingType;
}
/**
*
* Whether the solution version was created automatically or manually.
*
*
* @return Whether the solution version was created automatically or manually.
* @see TrainingType
*/
public String getTrainingType() {
return this.trainingType;
}
/**
*
* Whether the solution version was created automatically or manually.
*
*
* @param trainingType
* Whether the solution version was created automatically or manually.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TrainingType
*/
public SolutionVersionSummary withTrainingType(String trainingType) {
setTrainingType(trainingType);
return this;
}
/**
*
* Whether the solution version was created automatically or manually.
*
*
* @param trainingType
* Whether the solution version was created automatically or manually.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TrainingType
*/
public SolutionVersionSummary withTrainingType(TrainingType trainingType) {
this.trainingType = trainingType.toString();
return this;
}
/**
*
* The date and time (in Unix time) that this version of a solution was created.
*
*
* @param creationDateTime
* The date and time (in Unix time) that this version of a solution was created.
*/
public void setCreationDateTime(java.util.Date creationDateTime) {
this.creationDateTime = creationDateTime;
}
/**
*
* The date and time (in Unix time) that this version of a solution was created.
*
*
* @return The date and time (in Unix time) that this version of a solution was created.
*/
public java.util.Date getCreationDateTime() {
return this.creationDateTime;
}
/**
*
* The date and time (in Unix time) that this version of a solution was created.
*
*
* @param creationDateTime
* The date and time (in Unix time) that this version of a solution was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SolutionVersionSummary withCreationDateTime(java.util.Date creationDateTime) {
setCreationDateTime(creationDateTime);
return this;
}
/**
*
* The date and time (in Unix time) that the solution version was last updated.
*
*
* @param lastUpdatedDateTime
* The date and time (in Unix time) that the solution version was last updated.
*/
public void setLastUpdatedDateTime(java.util.Date lastUpdatedDateTime) {
this.lastUpdatedDateTime = lastUpdatedDateTime;
}
/**
*
* The date and time (in Unix time) that the solution version was last updated.
*
*
* @return The date and time (in Unix time) that the solution version was last updated.
*/
public java.util.Date getLastUpdatedDateTime() {
return this.lastUpdatedDateTime;
}
/**
*
* The date and time (in Unix time) that the solution version was last updated.
*
*
* @param lastUpdatedDateTime
* The date and time (in Unix time) that the solution version was last updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SolutionVersionSummary withLastUpdatedDateTime(java.util.Date lastUpdatedDateTime) {
setLastUpdatedDateTime(lastUpdatedDateTime);
return this;
}
/**
*
* If a solution version fails, the reason behind the failure.
*
*
* @param failureReason
* If a solution version fails, the reason behind the failure.
*/
public void setFailureReason(String failureReason) {
this.failureReason = failureReason;
}
/**
*
* If a solution version fails, the reason behind the failure.
*
*
* @return If a solution version fails, the reason behind the failure.
*/
public String getFailureReason() {
return this.failureReason;
}
/**
*
* If a solution version fails, the reason behind the failure.
*
*
* @param failureReason
* If a solution version fails, the reason behind the failure.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SolutionVersionSummary withFailureReason(String failureReason) {
setFailureReason(failureReason);
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 (getSolutionVersionArn() != null)
sb.append("SolutionVersionArn: ").append(getSolutionVersionArn()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getTrainingMode() != null)
sb.append("TrainingMode: ").append(getTrainingMode()).append(",");
if (getTrainingType() != null)
sb.append("TrainingType: ").append(getTrainingType()).append(",");
if (getCreationDateTime() != null)
sb.append("CreationDateTime: ").append(getCreationDateTime()).append(",");
if (getLastUpdatedDateTime() != null)
sb.append("LastUpdatedDateTime: ").append(getLastUpdatedDateTime()).append(",");
if (getFailureReason() != null)
sb.append("FailureReason: ").append(getFailureReason());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SolutionVersionSummary == false)
return false;
SolutionVersionSummary other = (SolutionVersionSummary) obj;
if (other.getSolutionVersionArn() == null ^ this.getSolutionVersionArn() == null)
return false;
if (other.getSolutionVersionArn() != null && other.getSolutionVersionArn().equals(this.getSolutionVersionArn()) == 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.getTrainingMode() == null ^ this.getTrainingMode() == null)
return false;
if (other.getTrainingMode() != null && other.getTrainingMode().equals(this.getTrainingMode()) == false)
return false;
if (other.getTrainingType() == null ^ this.getTrainingType() == null)
return false;
if (other.getTrainingType() != null && other.getTrainingType().equals(this.getTrainingType()) == 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;
if (other.getFailureReason() == null ^ this.getFailureReason() == null)
return false;
if (other.getFailureReason() != null && other.getFailureReason().equals(this.getFailureReason()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSolutionVersionArn() == null) ? 0 : getSolutionVersionArn().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getTrainingMode() == null) ? 0 : getTrainingMode().hashCode());
hashCode = prime * hashCode + ((getTrainingType() == null) ? 0 : getTrainingType().hashCode());
hashCode = prime * hashCode + ((getCreationDateTime() == null) ? 0 : getCreationDateTime().hashCode());
hashCode = prime * hashCode + ((getLastUpdatedDateTime() == null) ? 0 : getLastUpdatedDateTime().hashCode());
hashCode = prime * hashCode + ((getFailureReason() == null) ? 0 : getFailureReason().hashCode());
return hashCode;
}
@Override
public SolutionVersionSummary clone() {
try {
return (SolutionVersionSummary) 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.SolutionVersionSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}