com.amazonaws.services.autoscalingplans.model.GetScalingPlanResourceForecastDataRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-autoscalingplans 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.autoscalingplans.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetScalingPlanResourceForecastDataRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the scaling plan.
*
*/
private String scalingPlanName;
/**
*
* The version number of the scaling plan. Currently, the only valid value is 1.
*
*/
private Long scalingPlanVersion;
/**
*
* The namespace of the AWS service. The only valid value is autoscaling.
*
*/
private String serviceNamespace;
/**
*
* The ID of the resource. This string consists of a prefix (autoScalingGroup) followed by the name of
* a specified Auto Scaling group (my-asg). Example: autoScalingGroup/my-asg.
*
*/
private String resourceId;
/**
*
* The scalable dimension for the resource. The only valid value is
* autoscaling:autoScalingGroup:DesiredCapacity.
*
*/
private String scalableDimension;
/**
*
* The type of forecast data to get.
*
*
* -
*
* LoadForecast: The load metric forecast.
*
*
* -
*
* CapacityForecast: The capacity forecast.
*
*
* -
*
* ScheduledActionMinCapacity: The minimum capacity for each scheduled scaling action. This data is
* calculated as the larger of two values: the capacity forecast or the minimum capacity in the scaling instruction.
*
*
* -
*
* ScheduledActionMaxCapacity: The maximum capacity for each scheduled scaling action. The calculation
* used is determined by the predictive scaling maximum capacity behavior setting in the scaling instruction.
*
*
*
*/
private String forecastDataType;
/**
*
* The inclusive start time of the time range for the forecast data to get. The date and time can be at most 56 days
* before the current date and time.
*
*/
private java.util.Date startTime;
/**
*
* The exclusive end time of the time range for the forecast data to get. The maximum time duration between the
* start and end time is seven days.
*
*
* Although this parameter can accept a date and time that is more than two days in the future, the availability of
* forecast data has limits. AWS Auto Scaling only issues forecasts for periods of two days in advance.
*
*/
private java.util.Date endTime;
/**
*
* The name of the scaling plan.
*
*
* @param scalingPlanName
* The name of the scaling plan.
*/
public void setScalingPlanName(String scalingPlanName) {
this.scalingPlanName = scalingPlanName;
}
/**
*
* The name of the scaling plan.
*
*
* @return The name of the scaling plan.
*/
public String getScalingPlanName() {
return this.scalingPlanName;
}
/**
*
* The name of the scaling plan.
*
*
* @param scalingPlanName
* The name of the scaling plan.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetScalingPlanResourceForecastDataRequest withScalingPlanName(String scalingPlanName) {
setScalingPlanName(scalingPlanName);
return this;
}
/**
*
* The version number of the scaling plan. Currently, the only valid value is 1.
*
*
* @param scalingPlanVersion
* The version number of the scaling plan. Currently, the only valid value is 1.
*/
public void setScalingPlanVersion(Long scalingPlanVersion) {
this.scalingPlanVersion = scalingPlanVersion;
}
/**
*
* The version number of the scaling plan. Currently, the only valid value is 1.
*
*
* @return The version number of the scaling plan. Currently, the only valid value is 1.
*/
public Long getScalingPlanVersion() {
return this.scalingPlanVersion;
}
/**
*
* The version number of the scaling plan. Currently, the only valid value is 1.
*
*
* @param scalingPlanVersion
* The version number of the scaling plan. Currently, the only valid value is 1.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetScalingPlanResourceForecastDataRequest withScalingPlanVersion(Long scalingPlanVersion) {
setScalingPlanVersion(scalingPlanVersion);
return this;
}
/**
*
* The namespace of the AWS service. The only valid value is autoscaling.
*
*
* @param serviceNamespace
* The namespace of the AWS service. The only valid value is autoscaling.
* @see ServiceNamespace
*/
public void setServiceNamespace(String serviceNamespace) {
this.serviceNamespace = serviceNamespace;
}
/**
*
* The namespace of the AWS service. The only valid value is autoscaling.
*
*
* @return The namespace of the AWS service. The only valid value is autoscaling.
* @see ServiceNamespace
*/
public String getServiceNamespace() {
return this.serviceNamespace;
}
/**
*
* The namespace of the AWS service. The only valid value is autoscaling.
*
*
* @param serviceNamespace
* The namespace of the AWS service. The only valid value is autoscaling.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ServiceNamespace
*/
public GetScalingPlanResourceForecastDataRequest withServiceNamespace(String serviceNamespace) {
setServiceNamespace(serviceNamespace);
return this;
}
/**
*
* The namespace of the AWS service. The only valid value is autoscaling.
*
*
* @param serviceNamespace
* The namespace of the AWS service. The only valid value is autoscaling.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ServiceNamespace
*/
public GetScalingPlanResourceForecastDataRequest withServiceNamespace(ServiceNamespace serviceNamespace) {
this.serviceNamespace = serviceNamespace.toString();
return this;
}
/**
*
* The ID of the resource. This string consists of a prefix (autoScalingGroup) followed by the name of
* a specified Auto Scaling group (my-asg). Example: autoScalingGroup/my-asg.
*
*
* @param resourceId
* The ID of the resource. This string consists of a prefix (autoScalingGroup) followed by the
* name of a specified Auto Scaling group (my-asg). Example:
* autoScalingGroup/my-asg.
*/
public void setResourceId(String resourceId) {
this.resourceId = resourceId;
}
/**
*
* The ID of the resource. This string consists of a prefix (autoScalingGroup) followed by the name of
* a specified Auto Scaling group (my-asg). Example: autoScalingGroup/my-asg.
*
*
* @return The ID of the resource. This string consists of a prefix (autoScalingGroup) followed by the
* name of a specified Auto Scaling group (my-asg). Example:
* autoScalingGroup/my-asg.
*/
public String getResourceId() {
return this.resourceId;
}
/**
*
* The ID of the resource. This string consists of a prefix (autoScalingGroup) followed by the name of
* a specified Auto Scaling group (my-asg). Example: autoScalingGroup/my-asg.
*
*
* @param resourceId
* The ID of the resource. This string consists of a prefix (autoScalingGroup) followed by the
* name of a specified Auto Scaling group (my-asg). Example:
* autoScalingGroup/my-asg.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetScalingPlanResourceForecastDataRequest withResourceId(String resourceId) {
setResourceId(resourceId);
return this;
}
/**
*
* The scalable dimension for the resource. The only valid value is
* autoscaling:autoScalingGroup:DesiredCapacity.
*
*
* @param scalableDimension
* The scalable dimension for the resource. The only valid value is
* autoscaling:autoScalingGroup:DesiredCapacity.
* @see ScalableDimension
*/
public void setScalableDimension(String scalableDimension) {
this.scalableDimension = scalableDimension;
}
/**
*
* The scalable dimension for the resource. The only valid value is
* autoscaling:autoScalingGroup:DesiredCapacity.
*
*
* @return The scalable dimension for the resource. The only valid value is
* autoscaling:autoScalingGroup:DesiredCapacity.
* @see ScalableDimension
*/
public String getScalableDimension() {
return this.scalableDimension;
}
/**
*
* The scalable dimension for the resource. The only valid value is
* autoscaling:autoScalingGroup:DesiredCapacity.
*
*
* @param scalableDimension
* The scalable dimension for the resource. The only valid value is
* autoscaling:autoScalingGroup:DesiredCapacity.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScalableDimension
*/
public GetScalingPlanResourceForecastDataRequest withScalableDimension(String scalableDimension) {
setScalableDimension(scalableDimension);
return this;
}
/**
*
* The scalable dimension for the resource. The only valid value is
* autoscaling:autoScalingGroup:DesiredCapacity.
*
*
* @param scalableDimension
* The scalable dimension for the resource. The only valid value is
* autoscaling:autoScalingGroup:DesiredCapacity.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScalableDimension
*/
public GetScalingPlanResourceForecastDataRequest withScalableDimension(ScalableDimension scalableDimension) {
this.scalableDimension = scalableDimension.toString();
return this;
}
/**
*
* The type of forecast data to get.
*
*
* -
*
* LoadForecast: The load metric forecast.
*
*
* -
*
* CapacityForecast: The capacity forecast.
*
*
* -
*
* ScheduledActionMinCapacity: The minimum capacity for each scheduled scaling action. This data is
* calculated as the larger of two values: the capacity forecast or the minimum capacity in the scaling instruction.
*
*
* -
*
* ScheduledActionMaxCapacity: The maximum capacity for each scheduled scaling action. The calculation
* used is determined by the predictive scaling maximum capacity behavior setting in the scaling instruction.
*
*
*
*
* @param forecastDataType
* The type of forecast data to get.
*
* -
*
* LoadForecast: The load metric forecast.
*
*
* -
*
* CapacityForecast: The capacity forecast.
*
*
* -
*
* ScheduledActionMinCapacity: The minimum capacity for each scheduled scaling action. This data
* is calculated as the larger of two values: the capacity forecast or the minimum capacity in the scaling
* instruction.
*
*
* -
*
* ScheduledActionMaxCapacity: The maximum capacity for each scheduled scaling action. The
* calculation used is determined by the predictive scaling maximum capacity behavior setting in the scaling
* instruction.
*
*
* @see ForecastDataType
*/
public void setForecastDataType(String forecastDataType) {
this.forecastDataType = forecastDataType;
}
/**
*
* The type of forecast data to get.
*
*
* -
*
* LoadForecast: The load metric forecast.
*
*
* -
*
* CapacityForecast: The capacity forecast.
*
*
* -
*
* ScheduledActionMinCapacity: The minimum capacity for each scheduled scaling action. This data is
* calculated as the larger of two values: the capacity forecast or the minimum capacity in the scaling instruction.
*
*
* -
*
* ScheduledActionMaxCapacity: The maximum capacity for each scheduled scaling action. The calculation
* used is determined by the predictive scaling maximum capacity behavior setting in the scaling instruction.
*
*
*
*
* @return The type of forecast data to get.
*
* -
*
* LoadForecast: The load metric forecast.
*
*
* -
*
* CapacityForecast: The capacity forecast.
*
*
* -
*
* ScheduledActionMinCapacity: The minimum capacity for each scheduled scaling action. This
* data is calculated as the larger of two values: the capacity forecast or the minimum capacity in the
* scaling instruction.
*
*
* -
*
* ScheduledActionMaxCapacity: The maximum capacity for each scheduled scaling action. The
* calculation used is determined by the predictive scaling maximum capacity behavior setting in the scaling
* instruction.
*
*
* @see ForecastDataType
*/
public String getForecastDataType() {
return this.forecastDataType;
}
/**
*
* The type of forecast data to get.
*
*
* -
*
* LoadForecast: The load metric forecast.
*
*
* -
*
* CapacityForecast: The capacity forecast.
*
*
* -
*
* ScheduledActionMinCapacity: The minimum capacity for each scheduled scaling action. This data is
* calculated as the larger of two values: the capacity forecast or the minimum capacity in the scaling instruction.
*
*
* -
*
* ScheduledActionMaxCapacity: The maximum capacity for each scheduled scaling action. The calculation
* used is determined by the predictive scaling maximum capacity behavior setting in the scaling instruction.
*
*
*
*
* @param forecastDataType
* The type of forecast data to get.
*
* -
*
* LoadForecast: The load metric forecast.
*
*
* -
*
* CapacityForecast: The capacity forecast.
*
*
* -
*
* ScheduledActionMinCapacity: The minimum capacity for each scheduled scaling action. This data
* is calculated as the larger of two values: the capacity forecast or the minimum capacity in the scaling
* instruction.
*
*
* -
*
* ScheduledActionMaxCapacity: The maximum capacity for each scheduled scaling action. The
* calculation used is determined by the predictive scaling maximum capacity behavior setting in the scaling
* instruction.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ForecastDataType
*/
public GetScalingPlanResourceForecastDataRequest withForecastDataType(String forecastDataType) {
setForecastDataType(forecastDataType);
return this;
}
/**
*
* The type of forecast data to get.
*
*
* -
*
* LoadForecast: The load metric forecast.
*
*
* -
*
* CapacityForecast: The capacity forecast.
*
*
* -
*
* ScheduledActionMinCapacity: The minimum capacity for each scheduled scaling action. This data is
* calculated as the larger of two values: the capacity forecast or the minimum capacity in the scaling instruction.
*
*
* -
*
* ScheduledActionMaxCapacity: The maximum capacity for each scheduled scaling action. The calculation
* used is determined by the predictive scaling maximum capacity behavior setting in the scaling instruction.
*
*
*
*
* @param forecastDataType
* The type of forecast data to get.
*
* -
*
* LoadForecast: The load metric forecast.
*
*
* -
*
* CapacityForecast: The capacity forecast.
*
*
* -
*
* ScheduledActionMinCapacity: The minimum capacity for each scheduled scaling action. This data
* is calculated as the larger of two values: the capacity forecast or the minimum capacity in the scaling
* instruction.
*
*
* -
*
* ScheduledActionMaxCapacity: The maximum capacity for each scheduled scaling action. The
* calculation used is determined by the predictive scaling maximum capacity behavior setting in the scaling
* instruction.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ForecastDataType
*/
public GetScalingPlanResourceForecastDataRequest withForecastDataType(ForecastDataType forecastDataType) {
this.forecastDataType = forecastDataType.toString();
return this;
}
/**
*
* The inclusive start time of the time range for the forecast data to get. The date and time can be at most 56 days
* before the current date and time.
*
*
* @param startTime
* The inclusive start time of the time range for the forecast data to get. The date and time can be at most
* 56 days before the current date and time.
*/
public void setStartTime(java.util.Date startTime) {
this.startTime = startTime;
}
/**
*
* The inclusive start time of the time range for the forecast data to get. The date and time can be at most 56 days
* before the current date and time.
*
*
* @return The inclusive start time of the time range for the forecast data to get. The date and time can be at most
* 56 days before the current date and time.
*/
public java.util.Date getStartTime() {
return this.startTime;
}
/**
*
* The inclusive start time of the time range for the forecast data to get. The date and time can be at most 56 days
* before the current date and time.
*
*
* @param startTime
* The inclusive start time of the time range for the forecast data to get. The date and time can be at most
* 56 days before the current date and time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetScalingPlanResourceForecastDataRequest withStartTime(java.util.Date startTime) {
setStartTime(startTime);
return this;
}
/**
*
* The exclusive end time of the time range for the forecast data to get. The maximum time duration between the
* start and end time is seven days.
*
*
* Although this parameter can accept a date and time that is more than two days in the future, the availability of
* forecast data has limits. AWS Auto Scaling only issues forecasts for periods of two days in advance.
*
*
* @param endTime
* The exclusive end time of the time range for the forecast data to get. The maximum time duration between
* the start and end time is seven days.
*
* Although this parameter can accept a date and time that is more than two days in the future, the
* availability of forecast data has limits. AWS Auto Scaling only issues forecasts for periods of two days
* in advance.
*/
public void setEndTime(java.util.Date endTime) {
this.endTime = endTime;
}
/**
*
* The exclusive end time of the time range for the forecast data to get. The maximum time duration between the
* start and end time is seven days.
*
*
* Although this parameter can accept a date and time that is more than two days in the future, the availability of
* forecast data has limits. AWS Auto Scaling only issues forecasts for periods of two days in advance.
*
*
* @return The exclusive end time of the time range for the forecast data to get. The maximum time duration between
* the start and end time is seven days.
*
* Although this parameter can accept a date and time that is more than two days in the future, the
* availability of forecast data has limits. AWS Auto Scaling only issues forecasts for periods of two days
* in advance.
*/
public java.util.Date getEndTime() {
return this.endTime;
}
/**
*
* The exclusive end time of the time range for the forecast data to get. The maximum time duration between the
* start and end time is seven days.
*
*
* Although this parameter can accept a date and time that is more than two days in the future, the availability of
* forecast data has limits. AWS Auto Scaling only issues forecasts for periods of two days in advance.
*
*
* @param endTime
* The exclusive end time of the time range for the forecast data to get. The maximum time duration between
* the start and end time is seven days.
*
* Although this parameter can accept a date and time that is more than two days in the future, the
* availability of forecast data has limits. AWS Auto Scaling only issues forecasts for periods of two days
* in advance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetScalingPlanResourceForecastDataRequest withEndTime(java.util.Date endTime) {
setEndTime(endTime);
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 (getScalingPlanName() != null)
sb.append("ScalingPlanName: ").append(getScalingPlanName()).append(",");
if (getScalingPlanVersion() != null)
sb.append("ScalingPlanVersion: ").append(getScalingPlanVersion()).append(",");
if (getServiceNamespace() != null)
sb.append("ServiceNamespace: ").append(getServiceNamespace()).append(",");
if (getResourceId() != null)
sb.append("ResourceId: ").append(getResourceId()).append(",");
if (getScalableDimension() != null)
sb.append("ScalableDimension: ").append(getScalableDimension()).append(",");
if (getForecastDataType() != null)
sb.append("ForecastDataType: ").append(getForecastDataType()).append(",");
if (getStartTime() != null)
sb.append("StartTime: ").append(getStartTime()).append(",");
if (getEndTime() != null)
sb.append("EndTime: ").append(getEndTime());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetScalingPlanResourceForecastDataRequest == false)
return false;
GetScalingPlanResourceForecastDataRequest other = (GetScalingPlanResourceForecastDataRequest) obj;
if (other.getScalingPlanName() == null ^ this.getScalingPlanName() == null)
return false;
if (other.getScalingPlanName() != null && other.getScalingPlanName().equals(this.getScalingPlanName()) == false)
return false;
if (other.getScalingPlanVersion() == null ^ this.getScalingPlanVersion() == null)
return false;
if (other.getScalingPlanVersion() != null && other.getScalingPlanVersion().equals(this.getScalingPlanVersion()) == false)
return false;
if (other.getServiceNamespace() == null ^ this.getServiceNamespace() == null)
return false;
if (other.getServiceNamespace() != null && other.getServiceNamespace().equals(this.getServiceNamespace()) == false)
return false;
if (other.getResourceId() == null ^ this.getResourceId() == null)
return false;
if (other.getResourceId() != null && other.getResourceId().equals(this.getResourceId()) == false)
return false;
if (other.getScalableDimension() == null ^ this.getScalableDimension() == null)
return false;
if (other.getScalableDimension() != null && other.getScalableDimension().equals(this.getScalableDimension()) == false)
return false;
if (other.getForecastDataType() == null ^ this.getForecastDataType() == null)
return false;
if (other.getForecastDataType() != null && other.getForecastDataType().equals(this.getForecastDataType()) == false)
return false;
if (other.getStartTime() == null ^ this.getStartTime() == null)
return false;
if (other.getStartTime() != null && other.getStartTime().equals(this.getStartTime()) == false)
return false;
if (other.getEndTime() == null ^ this.getEndTime() == null)
return false;
if (other.getEndTime() != null && other.getEndTime().equals(this.getEndTime()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getScalingPlanName() == null) ? 0 : getScalingPlanName().hashCode());
hashCode = prime * hashCode + ((getScalingPlanVersion() == null) ? 0 : getScalingPlanVersion().hashCode());
hashCode = prime * hashCode + ((getServiceNamespace() == null) ? 0 : getServiceNamespace().hashCode());
hashCode = prime * hashCode + ((getResourceId() == null) ? 0 : getResourceId().hashCode());
hashCode = prime * hashCode + ((getScalableDimension() == null) ? 0 : getScalableDimension().hashCode());
hashCode = prime * hashCode + ((getForecastDataType() == null) ? 0 : getForecastDataType().hashCode());
hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode());
hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode());
return hashCode;
}
@Override
public GetScalingPlanResourceForecastDataRequest clone() {
return (GetScalingPlanResourceForecastDataRequest) super.clone();
}
}