Interface CreateDataQualityEvaluationConfigRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateDataQualityEvaluationConfigRequest.Builder,CreateDataQualityEvaluationConfigRequest>, GlueRequest.Builder, SdkBuilder<CreateDataQualityEvaluationConfigRequest.Builder,CreateDataQualityEvaluationConfigRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateDataQualityEvaluationConfigRequest
@Mutable @NotThreadSafe public static interface CreateDataQualityEvaluationConfigRequest.Builder extends GlueRequest.Builder, SdkPojo, CopyableBuilder<CreateDataQualityEvaluationConfigRequest.Builder,CreateDataQualityEvaluationConfigRequest>

  • Method Details

    • name

      CreateDataQualityEvaluationConfigRequest.Builder name(String name)

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

      Parameters:
      name - A name for the data quality evaluation configuration. The name must be unique within your account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • level

      CreateDataQualityEvaluationConfigRequest.Builder level(String level)

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

      Parameters:
      level - The Glue Data Catalog hierarchical level that the configuration applies to. Valid values are CATALOG, DATABASE, and TABLE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • level

      CreateDataQualityEvaluationConfigRequest.Builder level(DataQualityEvaluationConfigLevel level)

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

      Parameters:
      level - The Glue Data Catalog hierarchical level that the configuration applies to. Valid values are CATALOG, DATABASE, and TABLE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dataSource

      CreateDataQualityEvaluationConfigRequest.Builder dataSource(DataQualityEvaluationConfigDataSource dataSource)

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

      Parameters:
      dataSource - The catalog, database, or table that the configuration applies to, as specified by Level.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSource

      default CreateDataQualityEvaluationConfigRequest.Builder dataSource(Consumer<DataQualityEvaluationConfigDataSource.Builder> dataSource)

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

      This is a convenience method that creates an instance of the DataQualityEvaluationConfigDataSource.Builder avoiding the need to create one manually via DataQualityEvaluationConfigDataSource.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataSource(DataQualityEvaluationConfigDataSource).

      Parameters:
      dataSource - a consumer that will call methods on DataQualityEvaluationConfigDataSource.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • rulesetName

      CreateDataQualityEvaluationConfigRequest.Builder rulesetName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • managedRulesetName

      CreateDataQualityEvaluationConfigRequest.Builder managedRulesetName(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • managedRulesetName

      CreateDataQualityEvaluationConfigRequest.Builder managedRulesetName(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • triggersWithStrings

      CreateDataQualityEvaluationConfigRequest.Builder triggersWithStrings(Collection<String> 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • triggersWithStrings

      CreateDataQualityEvaluationConfigRequest.Builder triggersWithStrings(String... 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • triggers

      CreateDataQualityEvaluationConfigRequest.Builder triggers(Collection<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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • triggers

      CreateDataQualityEvaluationConfigRequest.Builder triggers(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleExpression

      CreateDataQualityEvaluationConfigRequest.Builder scheduleExpression(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • startAt

      CreateDataQualityEvaluationConfigRequest.Builder startAt(Instant startAt)

      The time from which the schedule runs, inclusive.

      Parameters:
      startAt - The time from which the schedule runs, inclusive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endAt

      CreateDataQualityEvaluationConfigRequest.Builder endAt(Instant endAt)

      The time at which the schedule stops running, exclusive.

      Parameters:
      endAt - The time at which the schedule stops running, exclusive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • role

      CreateDataQualityEvaluationConfigRequest.Builder role(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • numberOfWorkers

      CreateDataQualityEvaluationConfigRequest.Builder numberOfWorkers(Integer numberOfWorkers)

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

      Parameters:
      numberOfWorkers - The number of G.1X workers to be used in the run. The default is 5.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeout

      CreateDataQualityEvaluationConfigRequest.Builder timeout(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).

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • additionalRunOptions

      CreateDataQualityEvaluationConfigRequest.Builder additionalRunOptions(DataQualityEvaluationConfigAdditionalRunOptions additionalRunOptions)

      Additional run options you can specify for an evaluation run.

      Parameters:
      additionalRunOptions - Additional run options you can specify for an evaluation run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalRunOptions

      default CreateDataQualityEvaluationConfigRequest.Builder additionalRunOptions(Consumer<DataQualityEvaluationConfigAdditionalRunOptions.Builder> additionalRunOptions)

      Additional run options you can specify for an evaluation run.

      This is a convenience method that creates an instance of the DataQualityEvaluationConfigAdditionalRunOptions.Builder avoiding the need to create one manually via DataQualityEvaluationConfigAdditionalRunOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to additionalRunOptions(DataQualityEvaluationConfigAdditionalRunOptions).

      Parameters:
      additionalRunOptions - a consumer that will call methods on DataQualityEvaluationConfigAdditionalRunOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • additionalDataSources

      CreateDataQualityEvaluationConfigRequest.Builder additionalDataSources(Map<String,DataSource> additionalDataSources)

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

      Parameters:
      additionalDataSources - A map of reference strings to additional data sources you can specify for an evaluation run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateDataQualityEvaluationConfigRequest.Builder tags(Map<String,String> tags)

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

      Parameters:
      tags - A list of tags applied to the data quality evaluation configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateDataQualityEvaluationConfigRequest.Builder clientToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateDataQualityEvaluationConfigRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateDataQualityEvaluationConfigRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.