Class GetScalingPlanResourceForecastDataRequest

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("software.amazon.awssdk:codegen") public final class GetScalingPlanResourceForecastDataRequest extends AutoScalingPlansRequest implements ToCopyableBuilder<GetScalingPlanResourceForecastDataRequest.Builder,GetScalingPlanResourceForecastDataRequest>

  • Method Details

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

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

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

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

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

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

    • 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()
      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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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 final 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.