Class ColumnStatisticsTaskSettings

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

The settings for a column statistics task.

See Also:

  • Method Details

    • databaseName

      public final String databaseName()

      The name of the database where the table resides.

      Returns:
      The name of the database where the table resides.

    • tableName

      public final String tableName()

      The name of the table for which to generate column statistics.

      Returns:
      The name of the table for which to generate column statistics.

    • schedule

      public final Schedule schedule()

      A schedule for running the column statistics, specified in CRON syntax.

      Returns:
      A schedule for running the column statistics, specified in CRON syntax.

    • hasColumnNameList

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

    • columnNameList

      public final List<String> columnNameList()

      A list of column names for which to run statistics.

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

      Returns:
      A list of column names for which to run statistics.

    • catalogID

      public final String catalogID()

      The ID of the Data Catalog in which the database resides.

      Returns:
      The ID of the Data Catalog in which the database resides.

    • role

      public final String role()

      The role used for running the column statistics.

      Returns:
      The role used for running the column statistics.

    • sampleSize

      public final Double sampleSize()

      The percentage of data to sample.

      Returns:
      The percentage of data to sample.

    • securityConfiguration

      public final String securityConfiguration()

      Name of the security configuration that is used to encrypt CloudWatch logs.

      Returns:
      Name of the security configuration that is used to encrypt CloudWatch logs.

    • scheduleType

      public final ScheduleType scheduleType()

      The type of schedule for a column statistics task. Possible values may be CRON or AUTO.

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

      Returns:
      The type of schedule for a column statistics task. Possible values may be CRON or AUTO.
      See Also:

    • scheduleTypeAsString

      public final String scheduleTypeAsString()

      The type of schedule for a column statistics task. Possible values may be CRON or AUTO.

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

      Returns:
      The type of schedule for a column statistics task. Possible values may be CRON or AUTO.
      See Also:

    • settingSource

      public final SettingSource settingSource()

      The source of setting the column statistics task. Possible values may be CATALOG or TABLE.

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

      Returns:
      The source of setting the column statistics task. Possible values may be CATALOG or TABLE.
      See Also:

    • settingSourceAsString

      public final String settingSourceAsString()

      The source of setting the column statistics task. Possible values may be CATALOG or TABLE.

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

      Returns:
      The source of setting the column statistics task. Possible values may be CATALOG or TABLE.
      See Also:

    • lastExecutionAttempt

      public final ExecutionAttempt lastExecutionAttempt()

      The last ExecutionAttempt for the column statistics task run.

      Returns:
      The last ExecutionAttempt for the column statistics task run.

    • toBuilder

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

    • builder

      public static ColumnStatisticsTaskSettings.Builder builder()

    • serializableBuilderClass

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