Class ProfileConfiguration

java.lang.Object
software.amazon.awssdk.services.databrew.model.ProfileConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ProfileConfiguration.Builder,ProfileConfiguration>

@Generated("software.amazon.awssdk:codegen") public final class ProfileConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ProfileConfiguration.Builder,ProfileConfiguration>

Configuration for profile jobs. Configuration can be used to select columns, do evaluations, and override default parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all supported columns.

See Also:
  • Method Details

    • datasetStatisticsConfiguration

      public final StatisticsConfiguration datasetStatisticsConfiguration()

      Configuration for inter-column evaluations. Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations.

      Returns:
      Configuration for inter-column evaluations. Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations.
    • hasProfileColumns

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

      public final List<ColumnSelector> profileColumns()

      List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns.

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

      Returns:
      List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns.
    • hasColumnStatisticsConfigurations

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

      public final List<ColumnStatisticsConfiguration> columnStatisticsConfigurations()

      List of configurations for column evaluations. ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations.

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

      Returns:
      List of configurations for column evaluations. ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations.
    • entityDetectorConfiguration

      public final EntityDetectorConfiguration entityDetectorConfiguration()

      Configuration of entity detection for a profile job. When undefined, entity detection is disabled.

      Returns:
      Configuration of entity detection for a profile job. When undefined, entity detection is disabled.
    • toBuilder

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

      public static ProfileConfiguration.Builder builder()
    • serializableBuilderClass

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