com.amazonaws.services.forecast.model.ExplainabilityConfig 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;
/**
*
* The ExplainabilityConfig data type defines the number of time series and time points included in
* CreateExplainability.
*
*
* If you provide a predictor ARN for ResourceArn, you must set both TimePointGranularity and
* TimeSeriesGranularity to “ALL”. When creating Predictor Explainability, Amazon Forecast considers all
* time series and time points.
*
*
* If you provide a forecast ARN for ResourceArn, you can set TimePointGranularity and
* TimeSeriesGranularity to either “ALL” or “Specific”.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ExplainabilityConfig implements Serializable, Cloneable, StructuredPojo {
/**
*
* To create an Explainability for all time series in your datasets, use ALL. To create an
* Explainability for specific time series in your datasets, use SPECIFIC.
*
*
* Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the
* DataDestination data type.
*
*/
private String timeSeriesGranularity;
/**
*
* To create an Explainability for all time points in your forecast horizon, use ALL. To create an
* Explainability for specific time points in your forecast horizon, use SPECIFIC.
*
*
* Specify time points with the StartDateTime and EndDateTime parameters within the
* CreateExplainability operation.
*
*/
private String timePointGranularity;
/**
*
* To create an Explainability for all time series in your datasets, use ALL. To create an
* Explainability for specific time series in your datasets, use SPECIFIC.
*
*
* Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the
* DataDestination data type.
*
*
* @param timeSeriesGranularity
* To create an Explainability for all time series in your datasets, use ALL. To create an
* Explainability for specific time series in your datasets, use SPECIFIC.
*
* Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within
* the DataDestination data type.
* @see TimeSeriesGranularity
*/
public void setTimeSeriesGranularity(String timeSeriesGranularity) {
this.timeSeriesGranularity = timeSeriesGranularity;
}
/**
*
* To create an Explainability for all time series in your datasets, use ALL. To create an
* Explainability for specific time series in your datasets, use SPECIFIC.
*
*
* Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the
* DataDestination data type.
*
*
* @return To create an Explainability for all time series in your datasets, use ALL. To create an
* Explainability for specific time series in your datasets, use SPECIFIC.
*
* Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within
* the DataDestination data type.
* @see TimeSeriesGranularity
*/
public String getTimeSeriesGranularity() {
return this.timeSeriesGranularity;
}
/**
*
* To create an Explainability for all time series in your datasets, use ALL. To create an
* Explainability for specific time series in your datasets, use SPECIFIC.
*
*
* Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the
* DataDestination data type.
*
*
* @param timeSeriesGranularity
* To create an Explainability for all time series in your datasets, use ALL. To create an
* Explainability for specific time series in your datasets, use SPECIFIC.
*
* Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within
* the DataDestination data type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TimeSeriesGranularity
*/
public ExplainabilityConfig withTimeSeriesGranularity(String timeSeriesGranularity) {
setTimeSeriesGranularity(timeSeriesGranularity);
return this;
}
/**
*
* To create an Explainability for all time series in your datasets, use ALL. To create an
* Explainability for specific time series in your datasets, use SPECIFIC.
*
*
* Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the
* DataDestination data type.
*
*
* @param timeSeriesGranularity
* To create an Explainability for all time series in your datasets, use ALL. To create an
* Explainability for specific time series in your datasets, use SPECIFIC.
*
* Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within
* the DataDestination data type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TimeSeriesGranularity
*/
public ExplainabilityConfig withTimeSeriesGranularity(TimeSeriesGranularity timeSeriesGranularity) {
this.timeSeriesGranularity = timeSeriesGranularity.toString();
return this;
}
/**
*
* To create an Explainability for all time points in your forecast horizon, use ALL. To create an
* Explainability for specific time points in your forecast horizon, use SPECIFIC.
*
*
* Specify time points with the StartDateTime and EndDateTime parameters within the
* CreateExplainability operation.
*
*
* @param timePointGranularity
* To create an Explainability for all time points in your forecast horizon, use ALL. To create
* an Explainability for specific time points in your forecast horizon, use SPECIFIC.
*
* Specify time points with the StartDateTime and EndDateTime parameters within the
* CreateExplainability operation.
* @see TimePointGranularity
*/
public void setTimePointGranularity(String timePointGranularity) {
this.timePointGranularity = timePointGranularity;
}
/**
*
* To create an Explainability for all time points in your forecast horizon, use ALL. To create an
* Explainability for specific time points in your forecast horizon, use SPECIFIC.
*
*
* Specify time points with the StartDateTime and EndDateTime parameters within the
* CreateExplainability operation.
*
*
* @return To create an Explainability for all time points in your forecast horizon, use ALL. To create
* an Explainability for specific time points in your forecast horizon, use SPECIFIC.
*
* Specify time points with the StartDateTime and EndDateTime parameters within
* the CreateExplainability operation.
* @see TimePointGranularity
*/
public String getTimePointGranularity() {
return this.timePointGranularity;
}
/**
*
* To create an Explainability for all time points in your forecast horizon, use ALL. To create an
* Explainability for specific time points in your forecast horizon, use SPECIFIC.
*
*
* Specify time points with the StartDateTime and EndDateTime parameters within the
* CreateExplainability operation.
*
*
* @param timePointGranularity
* To create an Explainability for all time points in your forecast horizon, use ALL. To create
* an Explainability for specific time points in your forecast horizon, use SPECIFIC.
*
* Specify time points with the StartDateTime and EndDateTime parameters within the
* CreateExplainability operation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TimePointGranularity
*/
public ExplainabilityConfig withTimePointGranularity(String timePointGranularity) {
setTimePointGranularity(timePointGranularity);
return this;
}
/**
*
* To create an Explainability for all time points in your forecast horizon, use ALL. To create an
* Explainability for specific time points in your forecast horizon, use SPECIFIC.
*
*
* Specify time points with the StartDateTime and EndDateTime parameters within the
* CreateExplainability operation.
*
*
* @param timePointGranularity
* To create an Explainability for all time points in your forecast horizon, use ALL. To create
* an Explainability for specific time points in your forecast horizon, use SPECIFIC.
*
* Specify time points with the StartDateTime and EndDateTime parameters within the
* CreateExplainability operation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TimePointGranularity
*/
public ExplainabilityConfig withTimePointGranularity(TimePointGranularity timePointGranularity) {
this.timePointGranularity = timePointGranularity.toString();
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 (getTimeSeriesGranularity() != null)
sb.append("TimeSeriesGranularity: ").append(getTimeSeriesGranularity()).append(",");
if (getTimePointGranularity() != null)
sb.append("TimePointGranularity: ").append(getTimePointGranularity());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ExplainabilityConfig == false)
return false;
ExplainabilityConfig other = (ExplainabilityConfig) obj;
if (other.getTimeSeriesGranularity() == null ^ this.getTimeSeriesGranularity() == null)
return false;
if (other.getTimeSeriesGranularity() != null && other.getTimeSeriesGranularity().equals(this.getTimeSeriesGranularity()) == false)
return false;
if (other.getTimePointGranularity() == null ^ this.getTimePointGranularity() == null)
return false;
if (other.getTimePointGranularity() != null && other.getTimePointGranularity().equals(this.getTimePointGranularity()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTimeSeriesGranularity() == null) ? 0 : getTimeSeriesGranularity().hashCode());
hashCode = prime * hashCode + ((getTimePointGranularity() == null) ? 0 : getTimePointGranularity().hashCode());
return hashCode;
}
@Override
public ExplainabilityConfig clone() {
try {
return (ExplainabilityConfig) 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.ExplainabilityConfigMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}