Class CreateDataQualityEvaluationConfigRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.glue.model.GlueRequest
software.amazon.awssdk.services.glue.model.CreateDataQualityEvaluationConfigRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateDataQualityEvaluationConfigRequest.Builder,CreateDataQualityEvaluationConfigRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDataQualityEvaluationConfigRequest extends GlueRequest implements ToCopyableBuilder<CreateDataQualityEvaluationConfigRequest.Builder,CreateDataQualityEvaluationConfigRequest>

  • Method Details

    • name

      public final String name()

      A name for the data quality evaluation configuration. The name must be unique within your account.

      Returns:
      A name for the data quality evaluation configuration. The name must be unique within your account.

    • level

      public final DataQualityEvaluationConfigLevel level()

      The Glue Data Catalog hierarchical level that the configuration applies to. Valid values are CATALOG, DATABASE, and TABLE.

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

      Returns:
      The Glue Data Catalog hierarchical level that the configuration applies to. Valid values are CATALOG, DATABASE, and TABLE.
      See Also:

    • levelAsString

      public final String levelAsString()

      The Glue Data Catalog hierarchical level that the configuration applies to. Valid values are CATALOG, DATABASE, and TABLE.

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

      Returns:
      The Glue Data Catalog hierarchical level that the configuration applies to. Valid values are CATALOG, DATABASE, and TABLE.
      See Also:

    • dataSource

      public final DataQualityEvaluationConfigDataSource dataSource()

      The catalog, database, or table that the configuration applies to, as specified by Level.

      Returns:
      The catalog, database, or table that the configuration applies to, as specified by Level.

    • rulesetName

      public final String rulesetName()

      The name of a Data Quality Definition Language (DQDL) ruleset, containing analyzers, rules, or both, to evaluate tables with. You create the ruleset using the CreateDataQualityRuleset API. Specify either RulesetName or ManagedRulesetName, not both.

      Returns:
      The name of a Data Quality Definition Language (DQDL) ruleset, containing analyzers, rules, or both, to evaluate tables with. You create the ruleset using the CreateDataQualityRuleset API. Specify either RulesetName or ManagedRulesetName, not both.

    • managedRulesetName

      public final DataQualityEvaluationConfigManagedRuleset managedRulesetName()

      A built-in ruleset that profiles each table, used when RulesetName is not set. The default is SIMPLE. Choose from the following built-in rulesets:

      SIMPLE

      Row count and column count, completeness, minimum, and maximum for every column, mean, sum, and standard deviation for numeric columns, and column length for string columns.

      ADVANCED

      Every statistic in SIMPLE, plus distribution, uniqueness, and distinct values count.

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

      Returns:
      A built-in ruleset that profiles each table, used when RulesetName is not set. The default is SIMPLE. Choose from the following built-in rulesets:

      SIMPLE

      Row count and column count, completeness, minimum, and maximum for every column, mean, sum, and standard deviation for numeric columns, and column length for string columns.

      ADVANCED

      Every statistic in SIMPLE, plus distribution, uniqueness, and distinct values count.

      See Also:

    • managedRulesetNameAsString

      public final String managedRulesetNameAsString()

      A built-in ruleset that profiles each table, used when RulesetName is not set. The default is SIMPLE. Choose from the following built-in rulesets:

      SIMPLE

      Row count and column count, completeness, minimum, and maximum for every column, mean, sum, and standard deviation for numeric columns, and column length for string columns.

      ADVANCED

      Every statistic in SIMPLE, plus distribution, uniqueness, and distinct values count.

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

      Returns:
      A built-in ruleset that profiles each table, used when RulesetName is not set. The default is SIMPLE. Choose from the following built-in rulesets:

      SIMPLE

      Row count and column count, completeness, minimum, and maximum for every column, mean, sum, and standard deviation for numeric columns, and column length for string columns.

      ADVANCED

      Every statistic in SIMPLE, plus distribution, uniqueness, and distinct values count.

      See Also:

    • triggers

      public final List<DataQualityEvaluationConfigTrigger> triggers()

      When the configuration evaluates tables. You can choose one or more triggers, and each table is evaluated at most once an hour. The default is ONCE. Choose from the following triggers:

      ONCE

      Evaluates each table one time, including when tables are added to a database or catalog.

      SCHEDULE

      Evaluates each table on the cron or rate expression in ScheduleExpression, between the optional StartAt and EndAt times.

      METADATA_CHANGE

      Evaluates a table whenever its Glue Data Catalog metadata changes, such as a schema change or an Apache Iceberg commit.

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

      Returns:
      When the configuration evaluates tables. You can choose one or more triggers, and each table is evaluated at most once an hour. The default is ONCE. Choose from the following triggers:

      ONCE

      Evaluates each table one time, including when tables are added to a database or catalog.

      SCHEDULE

      Evaluates each table on the cron or rate expression in ScheduleExpression, between the optional StartAt and EndAt times.

      METADATA_CHANGE

      Evaluates a table whenever its Glue Data Catalog metadata changes, such as a schema change or an Apache Iceberg commit.

    • hasTriggers

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

    • triggersAsStrings

      public final List<String> triggersAsStrings()

      When the configuration evaluates tables. You can choose one or more triggers, and each table is evaluated at most once an hour. The default is ONCE. Choose from the following triggers:

      ONCE

      Evaluates each table one time, including when tables are added to a database or catalog.

      SCHEDULE

      Evaluates each table on the cron or rate expression in ScheduleExpression, between the optional StartAt and EndAt times.

      METADATA_CHANGE

      Evaluates a table whenever its Glue Data Catalog metadata changes, such as a schema change or an Apache Iceberg commit.

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

      Returns:
      When the configuration evaluates tables. You can choose one or more triggers, and each table is evaluated at most once an hour. The default is ONCE. Choose from the following triggers:

      ONCE

      Evaluates each table one time, including when tables are added to a database or catalog.

      SCHEDULE

      Evaluates each table on the cron or rate expression in ScheduleExpression, between the optional StartAt and EndAt times.

      METADATA_CHANGE

      Evaluates a table whenever its Glue Data Catalog metadata changes, such as a schema change or an Apache Iceberg commit.

    • scheduleExpression

      public final String scheduleExpression()

      A cron or rate expression, in UTC, for the SCHEDULE trigger, for example cron(0 6 * * ? *). The schedule can run at most once an hour.

      Returns:
      A cron or rate expression, in UTC, for the SCHEDULE trigger, for example cron(0 6 * * ? *). The schedule can run at most once an hour.

    • startAt

      public final Instant startAt()

      The time from which the schedule runs, inclusive.

      Returns:
      The time from which the schedule runs, inclusive.

    • endAt

      public final Instant endAt()

      The time at which the schedule stops running, exclusive.

      Returns:
      The time at which the schedule stops running, exclusive.

    • role

      public final String role()

      The IAM role that evaluations assume. You can specify the role name or the role Amazon Resource Name (ARN).

      The role must allow the glue.amazonaws.com service principal to assume it, and needs permissions to read the catalog (glue:GetCatalog, glue:GetDatabase, glue:GetTable, glue:SearchTables, and glue:GetPartitions), read and create rulesets ( glue:GetDataQualityRuleset and glue:CreateDataQualityRuleset), start evaluations ( glue:StartDataQualityRulesetEvaluationRun, glue:PublishDataQuality, and iam:PassRole on the role itself), read the tables' data in Amazon S3, and write logs to Amazon CloudWatch Logs. If a catalog-level or database-level configuration applies to an Amazon S3 Tables catalog, the role also needs s3tables:ListTableBuckets and s3tables:ListTables. If you use Lake Formation, the role needs the DESCRIBE permission on the tables.

      Returns:
      The IAM role that evaluations assume. You can specify the role name or the role Amazon Resource Name (ARN).

      The role must allow the glue.amazonaws.com service principal to assume it, and needs permissions to read the catalog (glue:GetCatalog, glue:GetDatabase, glue:GetTable, glue:SearchTables, and glue:GetPartitions), read and create rulesets (glue:GetDataQualityRuleset and glue:CreateDataQualityRuleset), start evaluations ( glue:StartDataQualityRulesetEvaluationRun, glue:PublishDataQuality, and iam:PassRole on the role itself), read the tables' data in Amazon S3, and write logs to Amazon CloudWatch Logs. If a catalog-level or database-level configuration applies to an Amazon S3 Tables catalog, the role also needs s3tables:ListTableBuckets and s3tables:ListTables. If you use Lake Formation, the role needs the DESCRIBE permission on the tables.

    • numberOfWorkers

      public final Integer numberOfWorkers()

      The number of G.1X workers to be used in the run. The default is 5.

      Returns:
      The number of G.1X workers to be used in the run. The default is 5.

    • timeout

      public final Integer timeout()

      The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

      Returns:
      The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

    • additionalRunOptions

      public final DataQualityEvaluationConfigAdditionalRunOptions additionalRunOptions()

      Additional run options you can specify for an evaluation run.

      Returns:
      Additional run options you can specify for an evaluation run.

    • hasAdditionalDataSources

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

    • additionalDataSources

      public final Map<String,DataSource> additionalDataSources()

      A map of reference strings to additional data sources you can specify for an evaluation run.

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

      Returns:
      A map of reference strings to additional data sources you can specify for an evaluation run.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      A list of tags applied to the data quality evaluation configuration.

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

      Returns:
      A list of tags applied to the data quality evaluation configuration.

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that you provide to ensure the operation completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.

      Returns:
      A unique, case-sensitive identifier that you provide to ensure the operation completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.

    • toBuilder

      public CreateDataQualityEvaluationConfigRequest.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<CreateDataQualityEvaluationConfigRequest.Builder,CreateDataQualityEvaluationConfigRequest>
      Specified by:
      toBuilder in class GlueRequest
      Returns:
      a builder for type T

    • builder

      public static CreateDataQualityEvaluationConfigRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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