com.amazonaws.services.autoscalingplans.model

Class GetScalingPlanResourceForecastDataRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.autoscalingplans.model.GetScalingPlanResourceForecastDataRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetScalingPlanResourceForecastDataRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetScalingPlanResourceForecastDataRequest()

Method Summary

Modifier and Type	Method and Description
GetScalingPlanResourceForecastDataRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Date	getEndTime() The exclusive end time of the time range for the forecast data to get.
String	getForecastDataType() The type of forecast data to get.
String	getResourceId() The ID of the resource.
String	getScalableDimension() The scalable dimension for the resource.
String	getScalingPlanName() The name of the scaling plan.
Long	getScalingPlanVersion() The version number of the scaling plan.
String	getServiceNamespace() The namespace of the AWS service.
Date	getStartTime() The inclusive start time of the time range for the forecast data to get.
int	hashCode()
void	setEndTime(Date endTime) The exclusive end time of the time range for the forecast data to get.
void	setForecastDataType(String forecastDataType) The type of forecast data to get.
void	setResourceId(String resourceId) The ID of the resource.
void	setScalableDimension(String scalableDimension) The scalable dimension for the resource.
void	setScalingPlanName(String scalingPlanName) The name of the scaling plan.
void	setScalingPlanVersion(Long scalingPlanVersion) The version number of the scaling plan.
void	setServiceNamespace(String serviceNamespace) The namespace of the AWS service.
void	setStartTime(Date startTime) The inclusive start time of the time range for the forecast data to get.
String	toString() Returns a string representation of this object.
GetScalingPlanResourceForecastDataRequest	withEndTime(Date endTime) The exclusive end time of the time range for the forecast data to get.
GetScalingPlanResourceForecastDataRequest	withForecastDataType(ForecastDataType forecastDataType) The type of forecast data to get.
GetScalingPlanResourceForecastDataRequest	withForecastDataType(String forecastDataType) The type of forecast data to get.
GetScalingPlanResourceForecastDataRequest	withResourceId(String resourceId) The ID of the resource.
GetScalingPlanResourceForecastDataRequest	withScalableDimension(ScalableDimension scalableDimension) The scalable dimension for the resource.
GetScalingPlanResourceForecastDataRequest	withScalableDimension(String scalableDimension) The scalable dimension for the resource.
GetScalingPlanResourceForecastDataRequest	withScalingPlanName(String scalingPlanName) The name of the scaling plan.
GetScalingPlanResourceForecastDataRequest	withScalingPlanVersion(Long scalingPlanVersion) The version number of the scaling plan.
GetScalingPlanResourceForecastDataRequest	withServiceNamespace(ServiceNamespace serviceNamespace) The namespace of the AWS service.
GetScalingPlanResourceForecastDataRequest	withServiceNamespace(String serviceNamespace) The namespace of the AWS service.
GetScalingPlanResourceForecastDataRequest	withStartTime(Date startTime) The inclusive start time of the time range for the forecast data to get.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetScalingPlanResourceForecastDataRequest

public GetScalingPlanResourceForecastDataRequest()

Method Detail

setScalingPlanName

public void setScalingPlanName(String scalingPlanName)

The name of the scaling plan.

Parameters:

scalingPlanName - The name of the scaling plan.

getScalingPlanName

public String getScalingPlanName()

The name of the scaling plan.

Returns:

The name of the scaling plan.

withScalingPlanName

public GetScalingPlanResourceForecastDataRequest withScalingPlanName(String scalingPlanName)

The name of the scaling plan.

Parameters:

scalingPlanName - The name of the scaling plan.

Returns:

Returns a reference to this object so that method calls can be chained together.

setScalingPlanVersion

public void setScalingPlanVersion(Long scalingPlanVersion)

The version number of the scaling plan.

Parameters:

scalingPlanVersion - The version number of the scaling plan.

getScalingPlanVersion

public Long getScalingPlanVersion()

The version number of the scaling plan.

Returns:

The version number of the scaling plan.

withScalingPlanVersion

public GetScalingPlanResourceForecastDataRequest withScalingPlanVersion(Long scalingPlanVersion)

The version number of the scaling plan.

Parameters:

scalingPlanVersion - The version number of the scaling plan.

Returns:

Returns a reference to this object so that method calls can be chained together.

setServiceNamespace

public void setServiceNamespace(String serviceNamespace)

The namespace of the AWS service.

Parameters:

serviceNamespace - The namespace of the AWS service.

See Also:

ServiceNamespace

getServiceNamespace

public String getServiceNamespace()

The namespace of the AWS service.

Returns:

The namespace of the AWS service.

See Also:

ServiceNamespace

withServiceNamespace

public GetScalingPlanResourceForecastDataRequest withServiceNamespace(String serviceNamespace)

The namespace of the AWS service.

Parameters:

serviceNamespace - The namespace of the AWS service.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceNamespace

withServiceNamespace

public GetScalingPlanResourceForecastDataRequest withServiceNamespace(ServiceNamespace serviceNamespace)

The namespace of the AWS service.

Parameters:

serviceNamespace - The namespace of the AWS service.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceNamespace

setResourceId

public void setResourceId(String resourceId)

The ID of the resource. This string consists of the resource type and unique identifier.

• Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.

• ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

• Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

• DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

• DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

• Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

Parameters:

resourceId - The ID of the resource. This string consists of the resource type and unique identifier.

• Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.

• ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

• Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

• DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

• DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

• Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

getResourceId

public String getResourceId()

The ID of the resource. This string consists of the resource type and unique identifier.

• Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.

• ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

• Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

• DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

• DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

• Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

Returns:

The ID of the resource. This string consists of the resource type and unique identifier.

• Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.

• ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

• Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

• DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

• DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

• Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

withResourceId

public GetScalingPlanResourceForecastDataRequest withResourceId(String resourceId)

The ID of the resource. This string consists of the resource type and unique identifier.

• Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.

• ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

• Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

• DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

• DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

• Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

Parameters:

resourceId - The ID of the resource. This string consists of the resource type and unique identifier.

• Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.

• ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

• Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

• DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

• DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

• Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

setScalableDimension

public void setScalableDimension(String scalableDimension)

The scalable dimension for the resource.

Parameters:

scalableDimension - The scalable dimension for the resource.

See Also:

ScalableDimension

getScalableDimension

public String getScalableDimension()

The scalable dimension for the resource.

Returns:

The scalable dimension for the resource.

See Also:

ScalableDimension

withScalableDimension

public GetScalingPlanResourceForecastDataRequest withScalableDimension(String scalableDimension)

The scalable dimension for the resource.

Parameters:

scalableDimension - The scalable dimension for the resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScalableDimension

withScalableDimension

public GetScalingPlanResourceForecastDataRequest withScalableDimension(ScalableDimension scalableDimension)

The scalable dimension for the resource.

Parameters:

scalableDimension - The scalable dimension for the resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScalableDimension

setForecastDataType

public void setForecastDataType(String 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.

Parameters:

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 Also:

ForecastDataType

getForecastDataType

public String getForecastDataType()

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.

Returns:

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 Also:

ForecastDataType

withForecastDataType

public GetScalingPlanResourceForecastDataRequest withForecastDataType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ForecastDataType

withForecastDataType

public GetScalingPlanResourceForecastDataRequest withForecastDataType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ForecastDataType

setStartTime

public void setStartTime(Date 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.

Parameters:

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.

getStartTime

public Date getStartTime()

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.

Returns:

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.

withStartTime

public GetScalingPlanResourceForecastDataRequest withStartTime(Date 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEndTime

public void setEndTime(Date 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.

Parameters:

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.

getEndTime

public Date getEndTime()

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.

Returns:

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.

withEndTime

public GetScalingPlanResourceForecastDataRequest withEndTime(Date 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetScalingPlanResourceForecastDataRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()