GetScalingPlanResourceForecastDataRequest (AWS SDK for Java

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)`
`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)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`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()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

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

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

- Method Detail
  - scalingPlanName
```
public String scalingPlanName()
```
    The name of the scaling plan.
    
    Returns:
    
    The name of the scaling plan.
  - scalingPlanVersion
```
public Long scalingPlanVersion()
```
    The version number of the scaling plan.
    
    Returns:
    
    The version number of the scaling plan.
  - serviceNamespace
```
public ServiceNamespace serviceNamespace()
```
    The namespace of the AWS service.
    
    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.
    
    See Also:
    
    ServiceNamespace
  - serviceNamespaceAsString
```
public String serviceNamespaceAsString()
```
    The namespace of the AWS service.
    
    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.
    
    See Also:
    
    ServiceNamespace
  - resourceId
```
public 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.
    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.
  - scalableDimension
```
public ScalableDimension scalableDimension()
```
    The scalable dimension for the resource.
    
    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.
    
    See Also:
    
    ScalableDimension
  - scalableDimensionAsString
```
public String scalableDimensionAsString()
```
    The scalable dimension for the resource.
    
    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.
    
    See Also:
    
    ScalableDimension
  - forecastDataType
```
public 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 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 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 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()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetScalingPlanResourceForecastDataRequest.Builder,GetScalingPlanResourceForecastDataRequest>
    
    Specified by:
    
    toBuilder in class AutoScalingPlansRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static GetScalingPlanResourceForecastDataRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetScalingPlanResourceForecastDataRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

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

toString

getValueForField

sdkFields