Package software.amazon.awssdk.services.forecast.model

Class CreateWhatIfForecastRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.forecast.model.ForecastRequest
software.amazon.awssdk.services.forecast.model.CreateWhatIfForecastRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateWhatIfForecastRequest.Builder,CreateWhatIfForecastRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateWhatIfForecastRequest extends ForecastRequest implements ToCopyableBuilder<CreateWhatIfForecastRequest.Builder,CreateWhatIfForecastRequest>

  • Method Details

    • whatIfForecastName

      public final String whatIfForecastName()

      The name of the what-if forecast. Names must be unique within each what-if analysis.

      Returns:
      The name of the what-if forecast. Names must be unique within each what-if analysis.

    • whatIfAnalysisArn

      public final String whatIfAnalysisArn()

      The Amazon Resource Name (ARN) of the what-if analysis.

      Returns:
      The Amazon Resource Name (ARN) of the what-if analysis.

    • hasTimeSeriesTransformations

      public final boolean hasTimeSeriesTransformations()
      For responses, this returns true if the service returned a value for the TimeSeriesTransformations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • timeSeriesTransformations

      public final List<TimeSeriesTransformation> timeSeriesTransformations()

      The transformations that are applied to the baseline time series. Each transformation contains an action and a set of conditions. An action is applied only when all conditions are met. If no conditions are provided, the action is applied to all items.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTimeSeriesTransformations() method.

      Returns:
      The transformations that are applied to the baseline time series. Each transformation contains an action and a set of conditions. An action is applied only when all conditions are met. If no conditions are provided, the action is applied to all items.

    • timeSeriesReplacementsDataSource

      public final TimeSeriesReplacementsDataSource timeSeriesReplacementsDataSource()

      The replacement time series dataset, which contains the rows that you want to change in the related time series dataset. A replacement time series does not need to contain all rows that are in the baseline related time series. Include only the rows (measure-dimension combinations) that you want to include in the what-if forecast.

      This dataset is merged with the original time series to create a transformed dataset that is used for the what-if analysis.

      This dataset should contain the items to modify (such as item_id or workforce_type), any relevant dimensions, the timestamp column, and at least one of the related time series columns. This file should not contain duplicate timestamps for the same time series.

      Timestamps and item_ids not included in this dataset are not included in the what-if analysis.

      Returns:
      The replacement time series dataset, which contains the rows that you want to change in the related time series dataset. A replacement time series does not need to contain all rows that are in the baseline related time series. Include only the rows (measure-dimension combinations) that you want to include in the what-if forecast.

      This dataset is merged with the original time series to create a transformed dataset that is used for the what-if analysis.

      This dataset should contain the items to modify (such as item_id or workforce_type), any relevant dimensions, the timestamp column, and at least one of the related time series columns. This file should not contain duplicate timestamps for the same time series.

      Timestamps and item_ids not included in this dataset are not included in the what-if analysis.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      A list of tags to apply to the what if forecast.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      A list of tags to apply to the what if forecast.

    • toBuilder

      public CreateWhatIfForecastRequest.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<CreateWhatIfForecastRequest.Builder,CreateWhatIfForecastRequest>
      Specified by:
      toBuilder in class ForecastRequest
      Returns:
      a builder for type T

    • builder

      public static CreateWhatIfForecastRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateWhatIfForecastRequest.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.