com.amazonaws.services.forecast.model.WhatIfForecastSummary 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 what-if forecast properties used in the ListWhatIfForecasts operation. To get the
* complete set of properties, call the DescribeWhatIfForecast operation, and provide the
* WhatIfForecastArn that is listed in the summary.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class WhatIfForecastSummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon Resource Name (ARN) of the what-if forecast.
*
*/
private String whatIfForecastArn;
/**
*
* The name of the what-if forecast.
*
*/
private String whatIfForecastName;
/**
*
* The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.
*
*/
private String whatIfAnalysisArn;
/**
*
* The status of the what-if forecast. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
*
*
*
* The Status of the what-if analysis must be ACTIVE before you can access the analysis.
*
*
*/
private String status;
/**
*
* If an error occurred, an informational message about the error.
*
*/
private String message;
/**
*
* When the what-if forecast 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 Amazon Resource Name (ARN) of the what-if forecast.
*
*
* @param whatIfForecastArn
* The Amazon Resource Name (ARN) of the what-if forecast.
*/
public void setWhatIfForecastArn(String whatIfForecastArn) {
this.whatIfForecastArn = whatIfForecastArn;
}
/**
*
* The Amazon Resource Name (ARN) of the what-if forecast.
*
*
* @return The Amazon Resource Name (ARN) of the what-if forecast.
*/
public String getWhatIfForecastArn() {
return this.whatIfForecastArn;
}
/**
*
* The Amazon Resource Name (ARN) of the what-if forecast.
*
*
* @param whatIfForecastArn
* The Amazon Resource Name (ARN) of the what-if forecast.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WhatIfForecastSummary withWhatIfForecastArn(String whatIfForecastArn) {
setWhatIfForecastArn(whatIfForecastArn);
return this;
}
/**
*
* The name of the what-if forecast.
*
*
* @param whatIfForecastName
* The name of the what-if forecast.
*/
public void setWhatIfForecastName(String whatIfForecastName) {
this.whatIfForecastName = whatIfForecastName;
}
/**
*
* The name of the what-if forecast.
*
*
* @return The name of the what-if forecast.
*/
public String getWhatIfForecastName() {
return this.whatIfForecastName;
}
/**
*
* The name of the what-if forecast.
*
*
* @param whatIfForecastName
* The name of the what-if forecast.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WhatIfForecastSummary withWhatIfForecastName(String whatIfForecastName) {
setWhatIfForecastName(whatIfForecastName);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.
*
*
* @param whatIfAnalysisArn
* The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.
*/
public void setWhatIfAnalysisArn(String whatIfAnalysisArn) {
this.whatIfAnalysisArn = whatIfAnalysisArn;
}
/**
*
* The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.
*
*
* @return The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.
*/
public String getWhatIfAnalysisArn() {
return this.whatIfAnalysisArn;
}
/**
*
* The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.
*
*
* @param whatIfAnalysisArn
* The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WhatIfForecastSummary withWhatIfAnalysisArn(String whatIfAnalysisArn) {
setWhatIfAnalysisArn(whatIfAnalysisArn);
return this;
}
/**
*
* The status of the what-if forecast. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
*
*
*
* The Status of the what-if analysis must be ACTIVE before you can access the analysis.
*
*
*
* @param status
* The status of the what-if forecast. States include:
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
*
*
*
* The Status of the what-if analysis must be ACTIVE before you can access the
* analysis.
*
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the what-if forecast. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
*
*
*
* The Status of the what-if analysis must be ACTIVE before you can access the analysis.
*
*
*
* @return The status of the what-if forecast. States include:
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
*
*
*
* The Status of the what-if analysis must be ACTIVE before you can access the
* analysis.
*
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the what-if forecast. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
*
*
*
* The Status of the what-if analysis must be ACTIVE before you can access the analysis.
*
*
*
* @param status
* The status of the what-if forecast. States include:
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
*
*
*
* The Status of the what-if analysis must be ACTIVE before you can access the
* analysis.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WhatIfForecastSummary 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 WhatIfForecastSummary withMessage(String message) {
setMessage(message);
return this;
}
/**
*
* When the what-if forecast was created.
*
*
* @param creationTime
* When the what-if forecast was created.
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* When the what-if forecast was created.
*
*
* @return When the what-if forecast was created.
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* When the what-if forecast was created.
*
*
* @param creationTime
* When the what-if forecast was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WhatIfForecastSummary 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 WhatIfForecastSummary 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 (getWhatIfForecastArn() != null)
sb.append("WhatIfForecastArn: ").append(getWhatIfForecastArn()).append(",");
if (getWhatIfForecastName() != null)
sb.append("WhatIfForecastName: ").append(getWhatIfForecastName()).append(",");
if (getWhatIfAnalysisArn() != null)
sb.append("WhatIfAnalysisArn: ").append(getWhatIfAnalysisArn()).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 WhatIfForecastSummary == false)
return false;
WhatIfForecastSummary other = (WhatIfForecastSummary) obj;
if (other.getWhatIfForecastArn() == null ^ this.getWhatIfForecastArn() == null)
return false;
if (other.getWhatIfForecastArn() != null && other.getWhatIfForecastArn().equals(this.getWhatIfForecastArn()) == false)
return false;
if (other.getWhatIfForecastName() == null ^ this.getWhatIfForecastName() == null)
return false;
if (other.getWhatIfForecastName() != null && other.getWhatIfForecastName().equals(this.getWhatIfForecastName()) == false)
return false;
if (other.getWhatIfAnalysisArn() == null ^ this.getWhatIfAnalysisArn() == null)
return false;
if (other.getWhatIfAnalysisArn() != null && other.getWhatIfAnalysisArn().equals(this.getWhatIfAnalysisArn()) == 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 + ((getWhatIfForecastArn() == null) ? 0 : getWhatIfForecastArn().hashCode());
hashCode = prime * hashCode + ((getWhatIfForecastName() == null) ? 0 : getWhatIfForecastName().hashCode());
hashCode = prime * hashCode + ((getWhatIfAnalysisArn() == null) ? 0 : getWhatIfAnalysisArn().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 WhatIfForecastSummary clone() {
try {
return (WhatIfForecastSummary) 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.WhatIfForecastSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}