software.amazon.awssdk.services.databrew.model

Class UpdateRecipeJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.databrew.model.DataBrewRequest

software.amazon.awssdk.services.databrew.model.UpdateRecipeJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateRecipeJobRequest.Builder,UpdateRecipeJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateRecipeJobRequest
extends DataBrewRequest
implements ToCopyableBuilder<UpdateRecipeJobRequest.Builder,UpdateRecipeJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateRecipeJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateRecipeJobRequest.Builder	builder()
List<DatabaseOutput>	databaseOutputs() Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
List<DataCatalogOutput>	dataCatalogOutputs() One or more artifacts that represent the Glue Data Catalog output from running the job.
String	encryptionKeyArn() The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
EncryptionMode	encryptionMode() The encryption mode for the job, which can be one of the following:
String	encryptionModeAsString() The encryption mode for the job, which can be one of the following:
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDatabaseOutputs() For responses, this returns true if the service returned a value for the DatabaseOutputs property.
boolean	hasDataCatalogOutputs() For responses, this returns true if the service returned a value for the DataCatalogOutputs property.
int	hashCode()
boolean	hasOutputs() For responses, this returns true if the service returned a value for the Outputs property.
LogSubscription	logSubscription() Enables or disables Amazon CloudWatch logging for the job.
String	logSubscriptionAsString() Enables or disables Amazon CloudWatch logging for the job.
Integer	maxCapacity() The maximum number of nodes that DataBrew can consume when the job processes data.
Integer	maxRetries() The maximum number of times to retry the job after a job run fails.
String	name() The name of the job to update.
List<Output>	outputs() One or more artifacts that represent the output from running the job.
String	roleArn() The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateRecipeJobRequest.Builder>	serializableBuilderClass()
Integer	timeout() The job's timeout in minutes.
UpdateRecipeJobRequest.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

encryptionKeyArn

public final String encryptionKeyArn()

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

Returns:

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

encryptionMode

public final EncryptionMode encryptionMode()

The encryption mode for the job, which can be one of the following:

• SSE-KMS - Server-side encryption with keys managed by KMS.

• SSE-S3 - Server-side encryption with keys managed by Amazon S3.

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

Returns:

The encryption mode for the job, which can be one of the following:

• SSE-KMS - Server-side encryption with keys managed by KMS.

• SSE-S3 - Server-side encryption with keys managed by Amazon S3.

See Also:

EncryptionMode

encryptionModeAsString

public final String encryptionModeAsString()

The encryption mode for the job, which can be one of the following:

• SSE-KMS - Server-side encryption with keys managed by KMS.

• SSE-S3 - Server-side encryption with keys managed by Amazon S3.

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

Returns:

The encryption mode for the job, which can be one of the following:

• SSE-KMS - Server-side encryption with keys managed by KMS.

• SSE-S3 - Server-side encryption with keys managed by Amazon S3.

See Also:

EncryptionMode

name

public final String name()

The name of the job to update.

Returns:

The name of the job to update.

logSubscription

public final LogSubscription logSubscription()

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

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

Returns:

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

See Also:

LogSubscription

logSubscriptionAsString

public final String logSubscriptionAsString()

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

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

Returns:

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

See Also:

LogSubscription

maxCapacity

public final Integer maxCapacity()

The maximum number of nodes that DataBrew can consume when the job processes data.

Returns:

The maximum number of nodes that DataBrew can consume when the job processes data.

maxRetries

public final Integer maxRetries()

The maximum number of times to retry the job after a job run fails.

Returns:

The maximum number of times to retry the job after a job run fails.

hasOutputs

public final boolean hasOutputs()

For responses, this returns true if the service returned a value for the Outputs 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.

outputs

public final List<Output> outputs()

One or more artifacts that represent the output from running the job.

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

Returns:

One or more artifacts that represent the output from running the job.

hasDataCatalogOutputs

public final boolean hasDataCatalogOutputs()

For responses, this returns true if the service returned a value for the DataCatalogOutputs 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.

dataCatalogOutputs

public final List<DataCatalogOutput> dataCatalogOutputs()

One or more artifacts that represent the Glue Data Catalog output from running the job.

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

Returns:

One or more artifacts that represent the Glue Data Catalog output from running the job.

hasDatabaseOutputs

public final boolean hasDatabaseOutputs()

For responses, this returns true if the service returned a value for the DatabaseOutputs 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.

databaseOutputs

public final List<DatabaseOutput> databaseOutputs()

Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

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

Returns:

Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

Returns:

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

timeout

public final Integer timeout()

The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

Returns:

The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

toBuilder

public UpdateRecipeJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateRecipeJobRequest.Builder,UpdateRecipeJobRequest>

Specified by:

toBuilder in class DataBrewRequest

builder

public static UpdateRecipeJobRequest.Builder builder()

serializableBuilderClass

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