Package software.amazon.awssdk.services.glue.model

Class StartDataQualityRulesetEvaluationRunRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartDataQualityRulesetEvaluationRunRequest.Builder,StartDataQualityRulesetEvaluationRunRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartDataQualityRulesetEvaluationRunRequest
extends GlueRequest
implements ToCopyableBuilder<StartDataQualityRulesetEvaluationRunRequest.Builder,StartDataQualityRulesetEvaluationRunRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartDataQualityRulesetEvaluationRunRequest.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,DataSource>	additionalDataSources()	A map of reference strings to additional data sources you can specify for an evaluation run.
DataQualityEvaluationRunAdditionalRunOptions	additionalRunOptions()	Additional run options you can specify for an evaluation run.
static StartDataQualityRulesetEvaluationRunRequest.Builder	builder()
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.
DataSource	dataSource()	The data source (Glue table) associated with this run.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdditionalDataSources()	For responses, this returns true if the service returned a value for the AdditionalDataSources property.
int	hashCode()
boolean	hasRulesetNames()	For responses, this returns true if the service returned a value for the RulesetNames property.
Integer	numberOfWorkers()	The number of G.1X workers to be used in the run.
String	role()	An IAM role supplied to encrypt the results of the run.
List<String>	rulesetNames()	A list of ruleset names.
List<SdkField<?>>	sdkFields()
static Class<? extends StartDataQualityRulesetEvaluationRunRequest.Builder>	serializableBuilderClass()
Integer	timeout()	The timeout for a run in minutes.
StartDataQualityRulesetEvaluationRunRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

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

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

Additional run options you can specify for an evaluation run.

Returns:

Additional run options you can specify for an evaluation run.

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.

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.

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 StartDataQualityRulesetEvaluationRunRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartDataQualityRulesetEvaluationRunRequest.Builder,StartDataQualityRulesetEvaluationRunRequest>

Specified by:

toBuilder in class GlueRequest

builder

public static StartDataQualityRulesetEvaluationRunRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo