com.amazonaws.services.forecast.model.ExplainabilitySummary 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 Explainability properties used in the ListExplainabilities operation. To get a
* complete set of properties, call the DescribeExplainability operation, and provide the listed
* ExplainabilityArn.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ExplainabilitySummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon Resource Name (ARN) of the Explainability.
*
*/
private String explainabilityArn;
/**
*
* The name of the Explainability.
*
*/
private String explainabilityName;
/**
*
* The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.
*
*/
private String resourceArn;
/**
*
* The configuration settings that define the granularity of time series and time points for the Explainability.
*
*/
private ExplainabilityConfig explainabilityConfig;
/**
*
* The status of the Explainability. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
*
*/
private String status;
/**
*
* Information about any errors that may have occurred during the Explainability creation process.
*
*/
private String message;
/**
*
* When the Explainability 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 Explainability.
*
*
* @param explainabilityArn
* The Amazon Resource Name (ARN) of the Explainability.
*/
public void setExplainabilityArn(String explainabilityArn) {
this.explainabilityArn = explainabilityArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Explainability.
*
*
* @return The Amazon Resource Name (ARN) of the Explainability.
*/
public String getExplainabilityArn() {
return this.explainabilityArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Explainability.
*
*
* @param explainabilityArn
* The Amazon Resource Name (ARN) of the Explainability.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExplainabilitySummary withExplainabilityArn(String explainabilityArn) {
setExplainabilityArn(explainabilityArn);
return this;
}
/**
*
* The name of the Explainability.
*
*
* @param explainabilityName
* The name of the Explainability.
*/
public void setExplainabilityName(String explainabilityName) {
this.explainabilityName = explainabilityName;
}
/**
*
* The name of the Explainability.
*
*
* @return The name of the Explainability.
*/
public String getExplainabilityName() {
return this.explainabilityName;
}
/**
*
* The name of the Explainability.
*
*
* @param explainabilityName
* The name of the Explainability.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExplainabilitySummary withExplainabilityName(String explainabilityName) {
setExplainabilityName(explainabilityName);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.
*
*
* @param resourceArn
* The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.
*/
public void setResourceArn(String resourceArn) {
this.resourceArn = resourceArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.
*
*
* @return The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.
*/
public String getResourceArn() {
return this.resourceArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.
*
*
* @param resourceArn
* The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExplainabilitySummary withResourceArn(String resourceArn) {
setResourceArn(resourceArn);
return this;
}
/**
*
* The configuration settings that define the granularity of time series and time points for the Explainability.
*
*
* @param explainabilityConfig
* The configuration settings that define the granularity of time series and time points for the
* Explainability.
*/
public void setExplainabilityConfig(ExplainabilityConfig explainabilityConfig) {
this.explainabilityConfig = explainabilityConfig;
}
/**
*
* The configuration settings that define the granularity of time series and time points for the Explainability.
*
*
* @return The configuration settings that define the granularity of time series and time points for the
* Explainability.
*/
public ExplainabilityConfig getExplainabilityConfig() {
return this.explainabilityConfig;
}
/**
*
* The configuration settings that define the granularity of time series and time points for the Explainability.
*
*
* @param explainabilityConfig
* The configuration settings that define the granularity of time series and time points for the
* Explainability.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExplainabilitySummary withExplainabilityConfig(ExplainabilityConfig explainabilityConfig) {
setExplainabilityConfig(explainabilityConfig);
return this;
}
/**
*
* The status of the Explainability. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
*
*
* @param status
* The status of the Explainability. States include:
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the Explainability. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
*
*
* @return The status of the Explainability. States include:
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the Explainability. States include:
*
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
*
*
* @param status
* The status of the Explainability. States include:
*
* -
*
* ACTIVE
*
*
* -
*
* CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
*
*
* -
*
* CREATE_STOPPING, CREATE_STOPPED
*
*
* -
*
* DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExplainabilitySummary withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* Information about any errors that may have occurred during the Explainability creation process.
*
*
* @param message
* Information about any errors that may have occurred during the Explainability creation process.
*/
public void setMessage(String message) {
this.message = message;
}
/**
*
* Information about any errors that may have occurred during the Explainability creation process.
*
*
* @return Information about any errors that may have occurred during the Explainability creation process.
*/
public String getMessage() {
return this.message;
}
/**
*
* Information about any errors that may have occurred during the Explainability creation process.
*
*
* @param message
* Information about any errors that may have occurred during the Explainability creation process.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExplainabilitySummary withMessage(String message) {
setMessage(message);
return this;
}
/**
*
* When the Explainability was created.
*
*
* @param creationTime
* When the Explainability was created.
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* When the Explainability was created.
*
*
* @return When the Explainability was created.
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* When the Explainability was created.
*
*
* @param creationTime
* When the Explainability was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ExplainabilitySummary 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 ExplainabilitySummary 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 (getExplainabilityArn() != null)
sb.append("ExplainabilityArn: ").append(getExplainabilityArn()).append(",");
if (getExplainabilityName() != null)
sb.append("ExplainabilityName: ").append(getExplainabilityName()).append(",");
if (getResourceArn() != null)
sb.append("ResourceArn: ").append(getResourceArn()).append(",");
if (getExplainabilityConfig() != null)
sb.append("ExplainabilityConfig: ").append(getExplainabilityConfig()).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 ExplainabilitySummary == false)
return false;
ExplainabilitySummary other = (ExplainabilitySummary) obj;
if (other.getExplainabilityArn() == null ^ this.getExplainabilityArn() == null)
return false;
if (other.getExplainabilityArn() != null && other.getExplainabilityArn().equals(this.getExplainabilityArn()) == false)
return false;
if (other.getExplainabilityName() == null ^ this.getExplainabilityName() == null)
return false;
if (other.getExplainabilityName() != null && other.getExplainabilityName().equals(this.getExplainabilityName()) == false)
return false;
if (other.getResourceArn() == null ^ this.getResourceArn() == null)
return false;
if (other.getResourceArn() != null && other.getResourceArn().equals(this.getResourceArn()) == false)
return false;
if (other.getExplainabilityConfig() == null ^ this.getExplainabilityConfig() == null)
return false;
if (other.getExplainabilityConfig() != null && other.getExplainabilityConfig().equals(this.getExplainabilityConfig()) == 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 + ((getExplainabilityArn() == null) ? 0 : getExplainabilityArn().hashCode());
hashCode = prime * hashCode + ((getExplainabilityName() == null) ? 0 : getExplainabilityName().hashCode());
hashCode = prime * hashCode + ((getResourceArn() == null) ? 0 : getResourceArn().hashCode());
hashCode = prime * hashCode + ((getExplainabilityConfig() == null) ? 0 : getExplainabilityConfig().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 ExplainabilitySummary clone() {
try {
return (ExplainabilitySummary) 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.ExplainabilitySummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}