Class GetDataQualityRulesetEvaluationRunResponse

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

  • Method Details

    • runId

      public final String runId()

      The unique run identifier associated with this run.

      Returns:
      The unique run identifier associated with this run.

    • dataSource

      public final DataSource dataSource()

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

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

    • role

      public final String role()

      An IAM role supplied to encrypt the results of the run.

      Returns:
      An IAM role supplied to encrypt the results of the run.

    • 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 DataQualityEvaluationRunAdditionalRunOptions additionalRunOptions()

      Additional run options you can specify for an evaluation run.

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

    • status

      public final TaskStatusType status()

      The status for this run.

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

      Returns:
      The status for this run.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status for this run.

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

      Returns:
      The status for this run.
      See Also:

    • errorString

      public final String errorString()

      The error strings that are associated with the run.

      Returns:
      The error strings that are associated with the run.

    • startedOn

      public final Instant startedOn()

      The date and time when this run started.

      Returns:
      The date and time when this run started.

    • lastModifiedOn

      public final Instant lastModifiedOn()

      A timestamp. The last point in time when this data quality rule recommendation run was modified.

      Returns:
      A timestamp. The last point in time when this data quality rule recommendation run was modified.

    • completedOn

      public final Instant completedOn()

      The date and time when this run was completed.

      Returns:
      The date and time when this run was completed.

    • executionTime

      public final Integer executionTime()

      The amount of time (in seconds) that the run consumed resources.

      Returns:
      The amount of time (in seconds) that the run consumed resources.

    • hasRulesetNames

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

    • rulesetNames

      public final List<String> rulesetNames()

      A list of ruleset names for the run. Currently, this parameter takes only one Ruleset name.

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

      Returns:
      A list of ruleset names for the run. Currently, this parameter takes only one Ruleset name.

    • hasResultIds

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

    • resultIds

      public final List<String> resultIds()

      A list of result IDs for the data quality results for the 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 hasResultIds() method.

      Returns:
      A list of result IDs for the data quality results for the 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.

    • toBuilder

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

    • builder

      public static GetDataQualityRulesetEvaluationRunResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.