Class CreateRecipeJobRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateRecipeJobRequest.Builder,
CreateRecipeJobRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final List
<DatabaseOutput> Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to.final List
<DataCatalogOutput> One or more artifacts that represent the Glue Data Catalog output from running the job.final String
The name of the dataset that this job processes.final String
The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.final EncryptionMode
The encryption mode for the job, which can be one of the following:final String
The encryption mode for the job, which can be one of the following:final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the DatabaseOutputs property.final boolean
For responses, this returns true if the service returned a value for the DataCatalogOutputs property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Outputs property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final LogSubscription
Enables or disables Amazon CloudWatch logging for the job.final String
Enables or disables Amazon CloudWatch logging for the job.final Integer
The maximum number of nodes that DataBrew can consume when the job processes data.final Integer
The maximum number of times to retry the job after a job run fails.final String
name()
A unique name for the job.outputs()
One or more artifacts that represent the output from running the job.final String
Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.final RecipeReference
Returns the value of the RecipeReference property for this object.final String
roleArn()
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.static Class
<? extends CreateRecipeJobRequest.Builder> tags()
Metadata tags to apply to this job.final Integer
timeout()
The job's timeout in minutes.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
datasetName
The name of the dataset that this job processes.
- Returns:
- The name of the dataset that this job processes.
-
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
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 returnEncryptionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencryptionModeAsString()
.- 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:
-
-
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 returnEncryptionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencryptionModeAsString()
.- 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:
-
-
name
A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
- Returns:
- A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.
-
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 returnLogSubscription.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlogSubscriptionAsString()
.- 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:
-
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 returnLogSubscription.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlogSubscriptionAsString()
.- 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:
-
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
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to.
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 to.
-
projectName
Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.
- Returns:
- Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.
-
recipeReference
Returns the value of the RecipeReference property for this object.- Returns:
- The value of the RecipeReference property for this object.
-
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.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
tags
Metadata tags to apply to this 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
hasTags()
method.- Returns:
- Metadata tags to apply to this job.
-
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
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 interfaceToCopyableBuilder<CreateRecipeJobRequest.Builder,
CreateRecipeJobRequest> - Specified by:
toBuilder
in classDataBrewRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-