Class StartDataQualityRuleRecommendationRunRequest

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.StartDataQualityRuleRecommendationRunRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartDataQualityRuleRecommendationRunRequest.Builder,StartDataQualityRuleRecommendationRunRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartDataQualityRuleRecommendationRunRequest extends GlueRequest implements ToCopyableBuilder<StartDataQualityRuleRecommendationRunRequest.Builder,StartDataQualityRuleRecommendationRunRequest>

The request of the Data Quality rule recommendation request.

  • Method Details

    • dataSource

      public final DataSource dataSource()

      The data source (Glue table) associated with this run.

      Returns:
      The data source (Glue table) associated with this run.

    • role

      public final String role()

      The IAM role that Glue assumes to access resources for the run.

      For more information, see Configure IAM permissions for Glue Data Quality.

      Returns:
      The IAM role that Glue assumes to access resources for the run.

      For more information, see Configure IAM permissions for Glue Data Quality.

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

    • createdRulesetName

      public final String createdRulesetName()

      A name for the ruleset.

      Returns:
      A name for the ruleset.

    • dataQualitySecurityConfiguration

      public final String dataQualitySecurityConfiguration()

      The name of the security configuration created with the data quality encryption option.

      Returns:
      The name of the security configuration created with the data quality encryption option.

    • clientToken

      public final String clientToken()

      Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.

      Returns:
      Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.

    • additionalRunOptions

      public final DataQualityRuleRecommendationRunAdditionalRunOptions additionalRunOptions()

      Additional run options you can specify for a recommendation run.

      Returns:
      Additional run options you can specify for a recommendation run.

    • recommendationMode

      public final RecommendationMode recommendationMode()

      The mode that Glue Data Quality uses to recommend rules.

      The default is BASIC.

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

      Returns:
      The mode that Glue Data Quality uses to recommend rules.

      The default is BASIC.

      See Also:

    • recommendationModeAsString

      public final String recommendationModeAsString()

      The mode that Glue Data Quality uses to recommend rules.

      The default is BASIC.

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

      Returns:
      The mode that Glue Data Quality uses to recommend rules.

      The default is BASIC.

      See Also:

    • toBuilder

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

    • builder

      public static StartDataQualityRuleRecommendationRunRequest.Builder builder()

    • serializableBuilderClass

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