GetScalingPlanResourceForecastDataRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.autoscalingplans.model.AutoScalingPlansRequest
    - - software.amazon.awssdk.services.autoscalingplans.model.GetScalingPlanResourceForecastDataRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetScalingPlanResourceForecastDataRequest.Builder,GetScalingPlanResourceForecastDataRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetScalingPlanResourceForecastDataRequest
extends AutoScalingPlansRequest
implements ToCopyableBuilder<GetScalingPlanResourceForecastDataRequest.Builder,GetScalingPlanResourceForecastDataRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetScalingPlanResourceForecastDataRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetScalingPlanResourceForecastDataRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GetScalingPlanResourceForecastDataRequest.Builder`	`builder()`
`Instant`	`endTime()` The exclusive end time of the time range for the forecast data to get.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`ForecastDataType`	`forecastDataType()` The type of forecast data to get.
`String`	`forecastDataTypeAsString()` The type of forecast data to get.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`resourceId()` The ID of the resource.
`ScalableDimension`	`scalableDimension()` The scalable dimension for the resource.
`String`	`scalableDimensionAsString()` The scalable dimension for the resource.
`String`	`scalingPlanName()` The name of the scaling plan.
`Long`	`scalingPlanVersion()` The version number of the scaling plan.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetScalingPlanResourceForecastDataRequest.Builder>`	`serializableBuilderClass()`
`ServiceNamespace`	`serviceNamespace()` The namespace of the AWS service.
`String`	`serviceNamespaceAsString()` The namespace of the AWS service.
`Instant`	`startTime()` The inclusive start time of the time range for the forecast data to get.
`GetScalingPlanResourceForecastDataRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - scalingPlanName
```
public final String scalingPlanName()
```
    The name of the scaling plan.
    
    Returns:
    
    The name of the scaling plan.
  - scalingPlanVersion
```
public final Long scalingPlanVersion()
```
    The version number of the scaling plan. Currently, the only valid value is 1.
    
    Returns:
    
    The version number of the scaling plan. Currently, the only valid value is 1.
  - serviceNamespace
```
public final ServiceNamespace serviceNamespace()
```
    The namespace of the AWS service. The only valid value is autoscaling.
    
    If the service returns an enum value that is not available in the current SDK version, serviceNamespace will return ServiceNamespace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serviceNamespaceAsString().
    
    Returns:
    
    The namespace of the AWS service. The only valid value is autoscaling.
    
    See Also:
    
    ServiceNamespace
  - serviceNamespaceAsString
```
public final String serviceNamespaceAsString()
```
    The namespace of the AWS service. The only valid value is autoscaling.
    
    If the service returns an enum value that is not available in the current SDK version, serviceNamespace will return ServiceNamespace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serviceNamespaceAsString().
    
    Returns:
    
    The namespace of the AWS service. The only valid value is autoscaling.
    
    See Also:
    
    ServiceNamespace
  - resourceId
```
public final String 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.
    
    Returns:
    
    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.
  - scalableDimension
```
public final ScalableDimension scalableDimension()
```
    The scalable dimension for the resource. The only valid value is autoscaling:autoScalingGroup:DesiredCapacity.
    
    If the service returns an enum value that is not available in the current SDK version, scalableDimension will return ScalableDimension.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalableDimensionAsString().
    
    Returns:
    
    The scalable dimension for the resource. The only valid value is autoscaling:autoScalingGroup:DesiredCapacity.
    
    See Also:
    
    ScalableDimension
  - scalableDimensionAsString
```
public final String scalableDimensionAsString()
```
    The scalable dimension for the resource. The only valid value is autoscaling:autoScalingGroup:DesiredCapacity.
    
    If the service returns an enum value that is not available in the current SDK version, scalableDimension will return ScalableDimension.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalableDimensionAsString().
    
    Returns:
    
    The scalable dimension for the resource. The only valid value is autoscaling:autoScalingGroup:DesiredCapacity.
    
    See Also:
    
    ScalableDimension
  - forecastDataType
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, forecastDataType will return ForecastDataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from forecastDataTypeAsString().
    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
  - forecastDataTypeAsString
```
public final String forecastDataTypeAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, forecastDataType will return ForecastDataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from forecastDataTypeAsString().
    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
  - startTime
```
public final Instant 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:
    
    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.
  - endTime
```
public final Instant 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:
    
    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.
  - toBuilder
```
public GetScalingPlanResourceForecastDataRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetScalingPlanResourceForecastDataRequest.Builder,GetScalingPlanResourceForecastDataRequest>
    
    Specified by:
    
    toBuilder in class AutoScalingPlansRequest
  - builder
```
public static GetScalingPlanResourceForecastDataRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetScalingPlanResourceForecastDataRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetScalingPlanResourceForecastDataRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

scalingPlanName

scalingPlanVersion

serviceNamespace

serviceNamespaceAsString

resourceId

scalableDimension

scalableDimensionAsString

forecastDataType

forecastDataTypeAsString

startTime

endTime

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields