Class SyntheticDataColumnProperties

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

Properties that define how a specific data column should be handled during synthetic data generation, including its name, type, and role in predictive modeling.

See Also:

  • Method Details

    • columnName

      public final String columnName()

      The name of the data column as it appears in the dataset.

      Returns:
      The name of the data column as it appears in the dataset.

    • columnType

      public final SyntheticDataColumnType columnType()

      The data type of the column, which determines how the synthetic data generation algorithm processes and synthesizes values for this column.

      If the service returns an enum value that is not available in the current SDK version, columnType will return SyntheticDataColumnType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from columnTypeAsString().

      Returns:
      The data type of the column, which determines how the synthetic data generation algorithm processes and synthesizes values for this column.
      See Also:

    • columnTypeAsString

      public final String columnTypeAsString()

      The data type of the column, which determines how the synthetic data generation algorithm processes and synthesizes values for this column.

      If the service returns an enum value that is not available in the current SDK version, columnType will return SyntheticDataColumnType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from columnTypeAsString().

      Returns:
      The data type of the column, which determines how the synthetic data generation algorithm processes and synthesizes values for this column.
      See Also:

    • isPredictiveValue

      public final Boolean isPredictiveValue()

      Indicates if this column contains predictive values that should be treated as target variables in machine learning models. This affects how the synthetic data generation preserves statistical relationships.

      Returns:
      Indicates if this column contains predictive values that should be treated as target variables in machine learning models. This affects how the synthetic data generation preserves statistical relationships.

    • toBuilder

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

    • builder

      public static SyntheticDataColumnProperties.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.