Package software.amazon.awssdk.services.sagemaker.model

Class TimeSeriesConfig

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.TimeSeriesConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TimeSeriesConfig.Builder,TimeSeriesConfig>
@Generated("software.amazon.awssdk:codegen") public final class TimeSeriesConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TimeSeriesConfig.Builder,TimeSeriesConfig>

The collection of components that defines the time-series.

See Also:

  • Method Details

    • targetAttributeName

      public final String targetAttributeName()

      The name of the column representing the target variable that you want to predict for each item in your dataset. The data type of the target variable must be numerical.

      Returns:
      The name of the column representing the target variable that you want to predict for each item in your dataset. The data type of the target variable must be numerical.

    • timestampAttributeName

      public final String timestampAttributeName()

      The name of the column indicating a point in time at which the target value of a given item is recorded.

      Returns:
      The name of the column indicating a point in time at which the target value of a given item is recorded.

    • itemIdentifierAttributeName

      public final String itemIdentifierAttributeName()

      The name of the column that represents the set of item identifiers for which you want to predict the target value.

      Returns:
      The name of the column that represents the set of item identifiers for which you want to predict the target value.

    • hasGroupingAttributeNames

      public final boolean hasGroupingAttributeNames()
      For responses, this returns true if the service returned a value for the GroupingAttributeNames 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.

    • groupingAttributeNames

      public final List<String> groupingAttributeNames()

      A set of columns names that can be grouped with the item identifier column to create a composite key for which a target value is predicted.

      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 hasGroupingAttributeNames() method.

      Returns:
      A set of columns names that can be grouped with the item identifier column to create a composite key for which a target value is predicted.

    • toBuilder

      public TimeSeriesConfig.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<TimeSeriesConfig.Builder,TimeSeriesConfig>
      Returns:
      a builder for type T

    • builder

      public static TimeSeriesConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TimeSeriesConfig.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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