Class DataQualityEvaluationRunAdditionalRunOptions

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

Additional run options you can specify for an evaluation run.

See Also:

  • Method Details

    • cloudWatchMetricsEnabled

      public final Boolean cloudWatchMetricsEnabled()

      Whether or not to enable CloudWatch metrics.

      Returns:
      Whether or not to enable CloudWatch metrics.

    • resultsS3Prefix

      public final String resultsS3Prefix()

      Prefix for Amazon S3 to store results.

      Returns:
      Prefix for Amazon S3 to store results.

    • compositeRuleEvaluationMethod

      public final DQCompositeRuleEvaluationMethod compositeRuleEvaluationMethod()

      Set the evaluation method for composite rules in the ruleset to ROW/COLUMN

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

      Returns:
      Set the evaluation method for composite rules in the ruleset to ROW/COLUMN
      See Also:

    • compositeRuleEvaluationMethodAsString

      public final String compositeRuleEvaluationMethodAsString()

      Set the evaluation method for composite rules in the ruleset to ROW/COLUMN

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

      Returns:
      Set the evaluation method for composite rules in the ruleset to ROW/COLUMN
      See Also:

    • customLogGroupPrefix

      public final String customLogGroupPrefix()

      A custom prefix for the CloudWatch log group names. When specified, evaluation run logs are written to <CustomLogGroupPrefix>/error and <CustomLogGroupPrefix>/output instead of the default /aws-glue/data-quality/error and /aws-glue/data-quality/output log groups.

      Returns:
      A custom prefix for the CloudWatch log group names. When specified, evaluation run logs are written to <CustomLogGroupPrefix>/error and <CustomLogGroupPrefix>/output instead of the default /aws-glue/data-quality/error and /aws-glue/data-quality/output log groups.

    • rowLevelResults

      public final RowLevelResultsOptions rowLevelResults()

      The configuration for writing row-level evaluation results to a Glue Data Catalog table.

      Returns:
      The configuration for writing row-level evaluation results to a Glue Data Catalog table.

    • profilingResults

      public final ProfilingResultsOptions profilingResults()

      The configuration for writing profiling results to a Glue Data Catalog table.

      Returns:
      The configuration for writing profiling results to a Glue Data Catalog table.

    • observationScope

      public final ObservationConfiguration observationScope()

      The scope of the observation for the evaluation run. Specifies whether anomaly detection is enabled or disabled.

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

      Returns:
      The scope of the observation for the evaluation run. Specifies whether anomaly detection is enabled or disabled.
      See Also:

    • observationScopeAsString

      public final String observationScopeAsString()

      The scope of the observation for the evaluation run. Specifies whether anomaly detection is enabled or disabled.

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

      Returns:
      The scope of the observation for the evaluation run. Specifies whether anomaly detection is enabled or disabled.
      See Also:

    • observationMode

      public final ObservationMode observationMode()

      The observation mode for the evaluation run. Specifies how anomaly detection bounds are calculated.

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

      Returns:
      The observation mode for the evaluation run. Specifies how anomaly detection bounds are calculated.
      See Also:

    • observationModeAsString

      public final String observationModeAsString()

      The observation mode for the evaluation run. Specifies how anomaly detection bounds are calculated.

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

      Returns:
      The observation mode for the evaluation run. Specifies how anomaly detection bounds are calculated.
      See Also:

    • dataQualityRuleResults

      public final DataQualityRuleResultsOptions dataQualityRuleResults()

      The configuration for writing rule results to a Glue Data Catalog table.

      Returns:
      The configuration for writing rule results to a Glue Data Catalog table.

    • observationResults

      public final ObservationResultsOptions observationResults()

      The configuration for writing observation results to a Glue Data Catalog table.

      Returns:
      The configuration for writing observation results to a Glue Data Catalog table.

    • toBuilder

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

    • builder

      public static DataQualityEvaluationRunAdditionalRunOptions.Builder builder()

    • serializableBuilderClass

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