com.amazonaws.services.forecast.model.PredictorSummary Maven / Gradle / Ivy
Show all versions of aws-java-sdk-forecast 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.forecast.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Provides a summary of the predictor properties that are used in the ListPredictors operation. To get the
* complete set of properties, call the DescribePredictor operation, and provide the listed
* PredictorArn.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PredictorSummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* The ARN of the predictor.
*
*/
private String predictorArn;
/**
*
* The name of the predictor.
*
*/
private String predictorName;
/**
*
* The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
*
*/
private String datasetGroupArn;
/**
*
* Whether AutoPredictor was used to create the predictor.
*
*/
private Boolean isAutoPredictor;
/**
*
* A summary of the reference predictor used if the predictor was retrained or upgraded.
*
*/
private ReferencePredictorSummary referencePredictorSummary;
/**
*
* The status of the predictor. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
*
*
*
* The Status of the predictor must be ACTIVE before you can use the predictor to create a
* forecast.
*
*
*/
private String status;
/**
*
* If an error occurred, an informational message about the error.
*
*/
private String message;
/**
*
* When the model training task was created.
*
*/
private java.util.Date creationTime;
/**
*
* The last time the resource was modified. The timestamp depends on the status of the job:
*
*
* -
*
* CREATE_PENDING - The CreationTime.
*
*
* -
*
* CREATE_IN_PROGRESS - The current timestamp.
*
*
* -
*
* CREATE_STOPPING - The current timestamp.
*
*
* -
*
* CREATE_STOPPED - When the job stopped.
*
*
* -
*
* ACTIVE or CREATE_FAILED - When the job finished or failed.
*
*
*
*/
private java.util.Date lastModificationTime;
/**
*
* The ARN of the predictor.
*
*
* @param predictorArn
* The ARN of the predictor.
*/
public void setPredictorArn(String predictorArn) {
this.predictorArn = predictorArn;
}
/**
*
* The ARN of the predictor.
*
*
* @return The ARN of the predictor.
*/
public String getPredictorArn() {
return this.predictorArn;
}
/**
*
* The ARN of the predictor.
*
*
* @param predictorArn
* The ARN of the predictor.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PredictorSummary withPredictorArn(String predictorArn) {
setPredictorArn(predictorArn);
return this;
}
/**
*
* The name of the predictor.
*
*
* @param predictorName
* The name of the predictor.
*/
public void setPredictorName(String predictorName) {
this.predictorName = predictorName;
}
/**
*
* The name of the predictor.
*
*
* @return The name of the predictor.
*/
public String getPredictorName() {
return this.predictorName;
}
/**
*
* The name of the predictor.
*
*
* @param predictorName
* The name of the predictor.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PredictorSummary withPredictorName(String predictorName) {
setPredictorName(predictorName);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
*
*
* @param datasetGroupArn
* The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
*/
public void setDatasetGroupArn(String datasetGroupArn) {
this.datasetGroupArn = datasetGroupArn;
}
/**
*
* The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
*
*
* @return The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
*/
public String getDatasetGroupArn() {
return this.datasetGroupArn;
}
/**
*
* The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
*
*
* @param datasetGroupArn
* The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PredictorSummary withDatasetGroupArn(String datasetGroupArn) {
setDatasetGroupArn(datasetGroupArn);
return this;
}
/**
*
* Whether AutoPredictor was used to create the predictor.
*
*
* @param isAutoPredictor
* Whether AutoPredictor was used to create the predictor.
*/
public void setIsAutoPredictor(Boolean isAutoPredictor) {
this.isAutoPredictor = isAutoPredictor;
}
/**
*
* Whether AutoPredictor was used to create the predictor.
*
*
* @return Whether AutoPredictor was used to create the predictor.
*/
public Boolean getIsAutoPredictor() {
return this.isAutoPredictor;
}
/**
*
* Whether AutoPredictor was used to create the predictor.
*
*
* @param isAutoPredictor
* Whether AutoPredictor was used to create the predictor.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PredictorSummary withIsAutoPredictor(Boolean isAutoPredictor) {
setIsAutoPredictor(isAutoPredictor);
return this;
}
/**
*
* Whether AutoPredictor was used to create the predictor.
*
*
* @return Whether AutoPredictor was used to create the predictor.
*/
public Boolean isAutoPredictor() {
return this.isAutoPredictor;
}
/**
*
* A summary of the reference predictor used if the predictor was retrained or upgraded.
*
*
* @param referencePredictorSummary
* A summary of the reference predictor used if the predictor was retrained or upgraded.
*/
public void setReferencePredictorSummary(ReferencePredictorSummary referencePredictorSummary) {
this.referencePredictorSummary = referencePredictorSummary;
}
/**
*
* A summary of the reference predictor used if the predictor was retrained or upgraded.
*
*
* @return A summary of the reference predictor used if the predictor was retrained or upgraded.
*/
public ReferencePredictorSummary getReferencePredictorSummary() {
return this.referencePredictorSummary;
}
/**
*
* A summary of the reference predictor used if the predictor was retrained or upgraded.
*
*
* @param referencePredictorSummary
* A summary of the reference predictor used if the predictor was retrained or upgraded.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PredictorSummary withReferencePredictorSummary(ReferencePredictorSummary referencePredictorSummary) {
setReferencePredictorSummary(referencePredictorSummary);
return this;
}
/**
*
* The status of the predictor. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
*
*
*
* The Status of the predictor must be ACTIVE before you can use the predictor to create a
* forecast.
*
*
*
* @param status
* The status of the predictor. States include:
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
*
*
*
* The Status of the predictor must be ACTIVE before you can use the predictor to
* create a forecast.
*
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the predictor. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
*
*
*
* The Status of the predictor must be ACTIVE before you can use the predictor to create a
* forecast.
*
*
*
* @return The status of the predictor. States include:
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
*
*
*
* The Status of the predictor must be ACTIVE before you can use the predictor to
* create a forecast.
*
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the predictor. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
*
*
*
* The Status of the predictor must be ACTIVE before you can use the predictor to create a
* forecast.
*
*
*
* @param status
* The status of the predictor. States include:
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
*
*
*
* The Status of the predictor must be ACTIVE before you can use the predictor to
* create a forecast.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PredictorSummary withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* If an error occurred, an informational message about the error.
*
*
* @param message
* If an error occurred, an informational message about the error.
*/
public void setMessage(String message) {
this.message = message;
}
/**
*
* If an error occurred, an informational message about the error.
*
*
* @return If an error occurred, an informational message about the error.
*/
public String getMessage() {
return this.message;
}
/**
*
* If an error occurred, an informational message about the error.
*
*
* @param message
* If an error occurred, an informational message about the error.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PredictorSummary withMessage(String message) {
setMessage(message);
return this;
}
/**
*
* When the model training task was created.
*
*
* @param creationTime
* When the model training task was created.
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* When the model training task was created.
*
*
* @return When the model training task was created.
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* When the model training task was created.
*
*
* @param creationTime
* When the model training task was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PredictorSummary withCreationTime(java.util.Date creationTime) {
setCreationTime(creationTime);
return this;
}
/**
*
* The last time the resource was modified. The timestamp depends on the status of the job:
*
*
* -
*
* CREATE_PENDING - The CreationTime.
*
*
* -
*
* CREATE_IN_PROGRESS - The current timestamp.
*
*
* -
*
* CREATE_STOPPING - The current timestamp.
*
*
* -
*
* CREATE_STOPPED - When the job stopped.
*
*
* -
*
* ACTIVE or CREATE_FAILED - When the job finished or failed.
*
*
*
*
* @param lastModificationTime
* The last time the resource was modified. The timestamp depends on the status of the job:
*
* -
*
* CREATE_PENDING - The CreationTime.
*
*
* -
*
* CREATE_IN_PROGRESS - The current timestamp.
*
*
* -
*
* CREATE_STOPPING - The current timestamp.
*
*
* -
*
* CREATE_STOPPED - When the job stopped.
*
*
* -
*
* ACTIVE or CREATE_FAILED - When the job finished or failed.
*
*
*/
public void setLastModificationTime(java.util.Date lastModificationTime) {
this.lastModificationTime = lastModificationTime;
}
/**
*
* The last time the resource was modified. The timestamp depends on the status of the job:
*
*
* -
*
* CREATE_PENDING - The CreationTime.
*
*
* -
*
* CREATE_IN_PROGRESS - The current timestamp.
*
*
* -
*
* CREATE_STOPPING - The current timestamp.
*
*
* -
*
* CREATE_STOPPED - When the job stopped.
*
*
* -
*
* ACTIVE or CREATE_FAILED - When the job finished or failed.
*
*
*
*
* @return The last time the resource was modified. The timestamp depends on the status of the job:
*
* -
*
* CREATE_PENDING - The CreationTime.
*
*
* -
*
* CREATE_IN_PROGRESS - The current timestamp.
*
*
* -
*
* CREATE_STOPPING - The current timestamp.
*
*
* -
*
* CREATE_STOPPED - When the job stopped.
*
*
* -
*
* ACTIVE or CREATE_FAILED - When the job finished or failed.
*
*
*/
public java.util.Date getLastModificationTime() {
return this.lastModificationTime;
}
/**
*
* The last time the resource was modified. The timestamp depends on the status of the job:
*
*
* -
*
* CREATE_PENDING - The CreationTime.
*
*
* -
*
* CREATE_IN_PROGRESS - The current timestamp.
*
*
* -
*
* CREATE_STOPPING - The current timestamp.
*
*
* -
*
* CREATE_STOPPED - When the job stopped.
*
*
* -
*
* ACTIVE or CREATE_FAILED - When the job finished or failed.
*
*
*
*
* @param lastModificationTime
* The last time the resource was modified. The timestamp depends on the status of the job:
*
* -
*
* CREATE_PENDING - The CreationTime.
*
*
* -
*
* CREATE_IN_PROGRESS - The current timestamp.
*
*
* -
*
* CREATE_STOPPING - The current timestamp.
*
*
* -
*
* CREATE_STOPPED - When the job stopped.
*
*
* -
*
* ACTIVE or CREATE_FAILED - When the job finished or failed.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PredictorSummary withLastModificationTime(java.util.Date lastModificationTime) {
setLastModificationTime(lastModificationTime);
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 (getPredictorArn() != null)
sb.append("PredictorArn: ").append(getPredictorArn()).append(",");
if (getPredictorName() != null)
sb.append("PredictorName: ").append(getPredictorName()).append(",");
if (getDatasetGroupArn() != null)
sb.append("DatasetGroupArn: ").append(getDatasetGroupArn()).append(",");
if (getIsAutoPredictor() != null)
sb.append("IsAutoPredictor: ").append(getIsAutoPredictor()).append(",");
if (getReferencePredictorSummary() != null)
sb.append("ReferencePredictorSummary: ").append(getReferencePredictorSummary()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getMessage() != null)
sb.append("Message: ").append(getMessage()).append(",");
if (getCreationTime() != null)
sb.append("CreationTime: ").append(getCreationTime()).append(",");
if (getLastModificationTime() != null)
sb.append("LastModificationTime: ").append(getLastModificationTime());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PredictorSummary == false)
return false;
PredictorSummary other = (PredictorSummary) obj;
if (other.getPredictorArn() == null ^ this.getPredictorArn() == null)
return false;
if (other.getPredictorArn() != null && other.getPredictorArn().equals(this.getPredictorArn()) == false)
return false;
if (other.getPredictorName() == null ^ this.getPredictorName() == null)
return false;
if (other.getPredictorName() != null && other.getPredictorName().equals(this.getPredictorName()) == false)
return false;
if (other.getDatasetGroupArn() == null ^ this.getDatasetGroupArn() == null)
return false;
if (other.getDatasetGroupArn() != null && other.getDatasetGroupArn().equals(this.getDatasetGroupArn()) == false)
return false;
if (other.getIsAutoPredictor() == null ^ this.getIsAutoPredictor() == null)
return false;
if (other.getIsAutoPredictor() != null && other.getIsAutoPredictor().equals(this.getIsAutoPredictor()) == false)
return false;
if (other.getReferencePredictorSummary() == null ^ this.getReferencePredictorSummary() == null)
return false;
if (other.getReferencePredictorSummary() != null && other.getReferencePredictorSummary().equals(this.getReferencePredictorSummary()) == 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.getMessage() == null ^ this.getMessage() == null)
return false;
if (other.getMessage() != null && other.getMessage().equals(this.getMessage()) == 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.getLastModificationTime() == null ^ this.getLastModificationTime() == null)
return false;
if (other.getLastModificationTime() != null && other.getLastModificationTime().equals(this.getLastModificationTime()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPredictorArn() == null) ? 0 : getPredictorArn().hashCode());
hashCode = prime * hashCode + ((getPredictorName() == null) ? 0 : getPredictorName().hashCode());
hashCode = prime * hashCode + ((getDatasetGroupArn() == null) ? 0 : getDatasetGroupArn().hashCode());
hashCode = prime * hashCode + ((getIsAutoPredictor() == null) ? 0 : getIsAutoPredictor().hashCode());
hashCode = prime * hashCode + ((getReferencePredictorSummary() == null) ? 0 : getReferencePredictorSummary().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getMessage() == null) ? 0 : getMessage().hashCode());
hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode());
hashCode = prime * hashCode + ((getLastModificationTime() == null) ? 0 : getLastModificationTime().hashCode());
return hashCode;
}
@Override
public PredictorSummary clone() {
try {
return (PredictorSummary) 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.forecast.model.transform.PredictorSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}