Job (AWS Java SDK :: Services :: Data Brew 2.20.111 API)

java.lang.Object
- software.amazon.awssdk.services.databrew.model.Job

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Job.Builder,Job>

@Generated(value="software.amazon.awssdk:codegen")
public final class Job
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Job.Builder,Job>

Represents all of the attributes of a DataBrew job.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Job.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Job.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`accountId()` The ID of the Amazon Web Services account that owns the job.
`static Job.Builder`	`builder()`
`Instant`	`createDate()` The date and time that the job was created.
`String`	`createdBy()` The Amazon Resource Name (ARN) of the user who created the job.
`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`	`datasetName()` A dataset that the job is to process.
`String`	`encryptionKeyArn()` The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output.
`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.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`boolean`	`hasValidationConfigurations()` For responses, this returns true if the service returned a value for the ValidationConfigurations property.
`JobSample`	`jobSample()` A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.
`String`	`lastModifiedBy()` The Amazon Resource Name (ARN) of the user who last modified the job.
`Instant`	`lastModifiedDate()` The modification date and time of the job.
`LogSubscription`	`logSubscription()` The current status of Amazon CloudWatch logging for the job.
`String`	`logSubscriptionAsString()` The current status of Amazon CloudWatch logging for the job.
`Integer`	`maxCapacity()` The maximum number of nodes that can be consumed when the job processes data.
`Integer`	`maxRetries()` The maximum number of times to retry the job after a job run fails.
`String`	`name()` The unique name of the job.
`List<Output>`	`outputs()` One or more artifacts that represent output from running the job.
`String`	`projectName()` The name of the project that the job is associated with.
`RecipeReference`	`recipeReference()` A set of steps that the job runs.
`String`	`resourceArn()` The unique Amazon Resource Name (ARN) for the job.
`String`	`roleArn()` The Amazon Resource Name (ARN) of the role to be assumed for this job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Job.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` Metadata tags that have been applied to the job.
`Integer`	`timeout()` The job's timeout in minutes.
`Job.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`JobType`	`type()` The job type of the job, which must be one of the following:
`String`	`typeAsString()` The job type of the job, which must be one of the following:
`List<ValidationConfiguration>`	`validationConfigurations()` List of validation configurations that are applied to the profile job.

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
  - accountId
```
public final String accountId()
```
    The ID of the Amazon Web Services account that owns the job.
    
    Returns:
    
    The ID of the Amazon Web Services account that owns the job.
  - createdBy
```
public final String createdBy()
```
    The Amazon Resource Name (ARN) of the user who created the job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the user who created the job.
  - createDate
```
public final Instant createDate()
```
    The date and time that the job was created.
    
    Returns:
    
    The date and time that the job was created.
  - datasetName
```
public final String datasetName()
```
    A dataset that the job is to process.
    
    Returns:
    
    A dataset that the job is to process.
  - encryptionKeyArn
```
public final String encryptionKeyArn()
```
    The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see Encrypting data written by DataBrew jobs
    
    Returns:
    
    The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see Encrypting data written by DataBrew jobs
  - 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 unique name of the job.
    
    Returns:
    
    The unique name of the job.
  - type
```
public final JobType type()
```
    The job type of the job, which must be one of the following:
    - PROFILE - A job to analyze a dataset, to determine its size, data types, data distribution, and more.
    - RECIPE - A job to apply one or more transformations to a dataset.
    If the service returns an enum value that is not available in the current SDK version, type will return JobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    Returns:
    The job type of the job, which must be one of the following:
    
    PROFILE - A job to analyze a dataset, to determine its size, data types, data distribution, and more.
    
    RECIPE - A job to apply one or more transformations to a dataset.
    See Also:
    
    JobType
  - typeAsString
```
public final String typeAsString()
```
    The job type of the job, which must be one of the following:
    - PROFILE - A job to analyze a dataset, to determine its size, data types, data distribution, and more.
    - RECIPE - A job to apply one or more transformations to a dataset.
    If the service returns an enum value that is not available in the current SDK version, type will return JobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    Returns:
    The job type of the job, which must be one of the following:
    
    PROFILE - A job to analyze a dataset, to determine its size, data types, data distribution, and more.
    
    RECIPE - A job to apply one or more transformations to a dataset.
    See Also:
    
    JobType
  - lastModifiedBy
```
public final String lastModifiedBy()
```
    The Amazon Resource Name (ARN) of the user who last modified the job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the user who last modified the job.
  - lastModifiedDate
```
public final Instant lastModifiedDate()
```
    The modification date and time of the job.
    
    Returns:
    
    The modification date and time of the job.
  - logSubscription
```
public final LogSubscription logSubscription()
```
    The current status of Amazon CloudWatch logging for the job.
    
    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:
    
    The current status of Amazon CloudWatch logging for the job.
    
    See Also:
    
    LogSubscription
  - logSubscriptionAsString
```
public final String logSubscriptionAsString()
```
    The current status of Amazon CloudWatch logging for the job.
    
    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:
    
    The current status of Amazon CloudWatch logging for the job.
    
    See Also:
    
    LogSubscription
  - maxCapacity
```
public final Integer maxCapacity()
```
    The maximum number of nodes that can be consumed when the job processes data.
    
    Returns:
    
    The maximum number of nodes that can be consumed 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 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 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.
  - projectName
```
public final String projectName()
```
    The name of the project that the job is associated with.
    
    Returns:
    
    The name of the project that the job is associated with.
  - recipeReference
```
public final RecipeReference recipeReference()
```
    A set of steps that the job runs.
    
    Returns:
    
    A set of steps that the job runs.
  - resourceArn
```
public final String resourceArn()
```
    The unique Amazon Resource Name (ARN) for the job.
    
    Returns:
    
    The unique Amazon Resource Name (ARN) for the job.
  - roleArn
```
public final String roleArn()
```
    The Amazon Resource Name (ARN) of the role to be assumed for this job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the role to be assumed for this 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.
  - 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 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.
  - tags
```
public final Map<String,String> tags()
```
    Metadata tags that have been applied to 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 hasTags() method.
    
    Returns:
    
    Metadata tags that have been applied to the job.
  - jobSample
```
public final JobSample jobSample()
```
    A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample value isn't provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.
    
    Returns:
    
    A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample value isn't provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.
  - hasValidationConfigurations
```
public final boolean hasValidationConfigurations()
```
    For responses, this returns true if the service returned a value for the ValidationConfigurations 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.
  - validationConfigurations
```
public final List<ValidationConfiguration> validationConfigurations()
```
    List of validation configurations that are applied to the profile 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 hasValidationConfigurations() method.
    
    Returns:
    
    List of validation configurations that are applied to the profile job.
  - toBuilder
```
public Job.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Job.Builder,Job>
  - builder
```
public static Job.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Job.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Job

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

accountId

createdBy

createDate

datasetName

encryptionKeyArn

encryptionMode

encryptionModeAsString

name

type

typeAsString

lastModifiedBy

lastModifiedDate

logSubscription

logSubscriptionAsString

maxCapacity

maxRetries

hasOutputs

outputs

hasDataCatalogOutputs

dataCatalogOutputs

hasDatabaseOutputs

databaseOutputs

projectName

recipeReference

resourceArn

roleArn

timeout

hasTags

tags

jobSample

hasValidationConfigurations

validationConfigurations

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields