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

All Superinterfaces:

Buildable, CopyableBuilder<Job.Builder,Job>, SdkBuilder<Job.Builder,Job>, SdkPojo

Enclosing class:

Job
```
public static interface Job.Builder
extends SdkPojo, CopyableBuilder<Job.Builder,Job>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Job.Builder`	`accountId(String accountId)` The ID of the Amazon Web Services account that owns the job.
`Job.Builder`	`createDate(Instant createDate)` The date and time that the job was created.
`Job.Builder`	`createdBy(String createdBy)` The Amazon Resource Name (ARN) of the user who created the job.
`Job.Builder`	`databaseOutputs(Collection<DatabaseOutput> databaseOutputs)` Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
`Job.Builder`	`databaseOutputs(Consumer<DatabaseOutput.Builder>... databaseOutputs)` Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
`Job.Builder`	`databaseOutputs(DatabaseOutput... databaseOutputs)` Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
`Job.Builder`	`dataCatalogOutputs(Collection<DataCatalogOutput> dataCatalogOutputs)` One or more artifacts that represent the Glue Data Catalog output from running the job.
`Job.Builder`	`dataCatalogOutputs(Consumer<DataCatalogOutput.Builder>... dataCatalogOutputs)` One or more artifacts that represent the Glue Data Catalog output from running the job.
`Job.Builder`	`dataCatalogOutputs(DataCatalogOutput... dataCatalogOutputs)` One or more artifacts that represent the Glue Data Catalog output from running the job.
`Job.Builder`	`datasetName(String datasetName)` A dataset that the job is to process.
`Job.Builder`	`encryptionKeyArn(String encryptionKeyArn)` The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output.
`Job.Builder`	`encryptionMode(EncryptionMode encryptionMode)` The encryption mode for the job, which can be one of the following:
`Job.Builder`	`encryptionMode(String encryptionMode)` The encryption mode for the job, which can be one of the following:
`default Job.Builder`	`jobSample(Consumer<JobSample.Builder> jobSample)` A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.
`Job.Builder`	`jobSample(JobSample jobSample)` A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.
`Job.Builder`	`lastModifiedBy(String lastModifiedBy)` The Amazon Resource Name (ARN) of the user who last modified the job.
`Job.Builder`	`lastModifiedDate(Instant lastModifiedDate)` The modification date and time of the job.
`Job.Builder`	`logSubscription(LogSubscription logSubscription)` The current status of Amazon CloudWatch logging for the job.
`Job.Builder`	`logSubscription(String logSubscription)` The current status of Amazon CloudWatch logging for the job.
`Job.Builder`	`maxCapacity(Integer maxCapacity)` The maximum number of nodes that can be consumed when the job processes data.
`Job.Builder`	`maxRetries(Integer maxRetries)` The maximum number of times to retry the job after a job run fails.
`Job.Builder`	`name(String name)` The unique name of the job.
`Job.Builder`	`outputs(Collection<Output> outputs)` One or more artifacts that represent output from running the job.
`Job.Builder`	`outputs(Consumer<Output.Builder>... outputs)` One or more artifacts that represent output from running the job.
`Job.Builder`	`outputs(Output... outputs)` One or more artifacts that represent output from running the job.
`Job.Builder`	`projectName(String projectName)` The name of the project that the job is associated with.
`default Job.Builder`	`recipeReference(Consumer<RecipeReference.Builder> recipeReference)` A set of steps that the job runs.
`Job.Builder`	`recipeReference(RecipeReference recipeReference)` A set of steps that the job runs.
`Job.Builder`	`resourceArn(String resourceArn)` The unique Amazon Resource Name (ARN) for the job.
`Job.Builder`	`roleArn(String roleArn)` The Amazon Resource Name (ARN) of the role to be assumed for this job.
`Job.Builder`	`tags(Map<String,String> tags)` Metadata tags that have been applied to the job.
`Job.Builder`	`timeout(Integer timeout)` The job's timeout in minutes.
`Job.Builder`	`type(JobType type)` The job type of the job, which must be one of the following:
`Job.Builder`	`type(String type)` The job type of the job, which must be one of the following:
`Job.Builder`	`validationConfigurations(Collection<ValidationConfiguration> validationConfigurations)` List of validation configurations that are applied to the profile job.
`Job.Builder`	`validationConfigurations(Consumer<ValidationConfiguration.Builder>... validationConfigurations)` List of validation configurations that are applied to the profile job.
`Job.Builder`	`validationConfigurations(ValidationConfiguration... validationConfigurations)` List of validation configurations that are applied to the profile job.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - accountId
```
Job.Builder accountId(String accountId)
```
    The ID of the Amazon Web Services account that owns the job.
    
    Parameters:
    
    accountId - The ID of the Amazon Web Services account that owns the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - createdBy
```
Job.Builder createdBy(String createdBy)
```
    The Amazon Resource Name (ARN) of the user who created the job.
    
    Parameters:
    
    createdBy - The Amazon Resource Name (ARN) of the user who created the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - createDate
```
Job.Builder createDate(Instant createDate)
```
    The date and time that the job was created.
    
    Parameters:
    
    createDate - The date and time that the job was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - datasetName
```
Job.Builder datasetName(String datasetName)
```
    A dataset that the job is to process.
    
    Parameters:
    
    datasetName - A dataset that the job is to process.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - encryptionKeyArn
```
Job.Builder encryptionKeyArn(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
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - encryptionMode
```
Job.Builder encryptionMode(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EncryptionMode, EncryptionMode
  - encryptionMode
```
Job.Builder encryptionMode(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EncryptionMode, EncryptionMode
  - name
```
Job.Builder name(String name)
```
    The unique name of the job.
    
    Parameters:
    
    name - The unique name of the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - type
```
Job.Builder type(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobType, JobType
  - type
```
Job.Builder type(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobType, JobType
  - lastModifiedBy
```
Job.Builder lastModifiedBy(String lastModifiedBy)
```
    The Amazon Resource Name (ARN) of the user who last modified the job.
    
    Parameters:
    
    lastModifiedBy - The Amazon Resource Name (ARN) of the user who last modified the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - lastModifiedDate
```
Job.Builder lastModifiedDate(Instant lastModifiedDate)
```
    The modification date and time of the job.
    
    Parameters:
    
    lastModifiedDate - The modification date and time of the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - logSubscription
```
Job.Builder logSubscription(String logSubscription)
```
    The current status of Amazon CloudWatch logging for the job.
    
    Parameters:
    
    logSubscription - The current status of Amazon CloudWatch logging for the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LogSubscription, LogSubscription
  - logSubscription
```
Job.Builder logSubscription(LogSubscription logSubscription)
```
    The current status of Amazon CloudWatch logging for the job.
    
    Parameters:
    
    logSubscription - The current status of Amazon CloudWatch logging for the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LogSubscription, LogSubscription
  - maxCapacity
```
Job.Builder maxCapacity(Integer maxCapacity)
```
    The maximum number of nodes that can be consumed when the job processes data.
    
    Parameters:
    
    maxCapacity - The maximum number of nodes that can be consumed when the job processes data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - maxRetries
```
Job.Builder maxRetries(Integer maxRetries)
```
    The maximum number of times to retry the job after a job run fails.
    
    Parameters:
    
    maxRetries - The maximum number of times to retry the job after a job run fails.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - outputs
```
Job.Builder outputs(Collection<Output> outputs)
```
    One or more artifacts that represent output from running the job.
    
    Parameters:
    
    outputs - One or more artifacts that represent output from running the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - outputs
```
Job.Builder outputs(Output... outputs)
```
    One or more artifacts that represent output from running the job.
    
    Parameters:
    
    outputs - One or more artifacts that represent output from running the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - outputs
```
Job.Builder outputs(Consumer<Output.Builder>... outputs)
```
    One or more artifacts that represent output from running the job.
    This is a convenience method that creates an instance of the Output.Builder avoiding the need to create one manually via Output.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #outputs(List).
    
    Parameters:
    
    outputs - a consumer that will call methods on Output.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #outputs(java.util.Collection)
  - dataCatalogOutputs
```
Job.Builder dataCatalogOutputs(Collection<DataCatalogOutput> dataCatalogOutputs)
```
    One or more artifacts that represent the Glue Data Catalog output from running the job.
    
    Parameters:
    
    dataCatalogOutputs - One or more artifacts that represent the Glue Data Catalog output from running the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dataCatalogOutputs
```
Job.Builder dataCatalogOutputs(DataCatalogOutput... dataCatalogOutputs)
```
    One or more artifacts that represent the Glue Data Catalog output from running the job.
    
    Parameters:
    
    dataCatalogOutputs - One or more artifacts that represent the Glue Data Catalog output from running the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dataCatalogOutputs
```
Job.Builder dataCatalogOutputs(Consumer<DataCatalogOutput.Builder>... dataCatalogOutputs)
```
    One or more artifacts that represent the Glue Data Catalog output from running the job.
    This is a convenience method that creates an instance of the DataCatalogOutput.Builder avoiding the need to create one manually via DataCatalogOutput.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #dataCatalogOutputs(List).
    
    Parameters:
    
    dataCatalogOutputs - a consumer that will call methods on DataCatalogOutput.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #dataCatalogOutputs(java.util.Collection)
  - databaseOutputs
```
Job.Builder databaseOutputs(Collection<DatabaseOutput> databaseOutputs)
```
    Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
    
    Parameters:
    
    databaseOutputs - Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - databaseOutputs
```
Job.Builder databaseOutputs(DatabaseOutput... databaseOutputs)
```
    Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
    
    Parameters:
    
    databaseOutputs - Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - databaseOutputs
```
Job.Builder databaseOutputs(Consumer<DatabaseOutput.Builder>... databaseOutputs)
```
    Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
    This is a convenience method that creates an instance of the DatabaseOutput.Builder avoiding the need to create one manually via DatabaseOutput.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #databaseOutputs(List).
    
    Parameters:
    
    databaseOutputs - a consumer that will call methods on DatabaseOutput.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #databaseOutputs(java.util.Collection)
  - projectName
```
Job.Builder projectName(String projectName)
```
    The name of the project that the job is associated with.
    
    Parameters:
    
    projectName - The name of the project that the job is associated with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - recipeReference
```
Job.Builder recipeReference(RecipeReference recipeReference)
```
    A set of steps that the job runs.
    
    Parameters:
    
    recipeReference - A set of steps that the job runs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - recipeReference
```
default Job.Builder recipeReference(Consumer<RecipeReference.Builder> recipeReference)
```
    A set of steps that the job runs.
    This is a convenience method that creates an instance of the RecipeReference.Builder avoiding the need to create one manually via RecipeReference.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to recipeReference(RecipeReference).
    
    Parameters:
    
    recipeReference - a consumer that will call methods on RecipeReference.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    recipeReference(RecipeReference)
  - resourceArn
```
Job.Builder resourceArn(String resourceArn)
```
    The unique Amazon Resource Name (ARN) for the job.
    
    Parameters:
    
    resourceArn - The unique Amazon Resource Name (ARN) for the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - roleArn
```
Job.Builder roleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the role to be assumed for this job.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the role to be assumed for this job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - timeout
```
Job.Builder timeout(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
Job.Builder tags(Map<String,String> tags)
```
    Metadata tags that have been applied to the job.
    
    Parameters:
    
    tags - Metadata tags that have been applied to the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - jobSample
```
Job.Builder jobSample(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - jobSample
```
default Job.Builder jobSample(Consumer<JobSample.Builder> 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.
    This is a convenience method that creates an instance of the JobSample.Builder avoiding the need to create one manually via JobSample.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jobSample(JobSample).
    
    Parameters:
    
    jobSample - a consumer that will call methods on JobSample.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    jobSample(JobSample)
  - validationConfigurations
```
Job.Builder validationConfigurations(Collection<ValidationConfiguration> validationConfigurations)
```
    List of validation configurations that are applied to the profile job.
    
    Parameters:
    
    validationConfigurations - List of validation configurations that are applied to the profile job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - validationConfigurations
```
Job.Builder validationConfigurations(ValidationConfiguration... validationConfigurations)
```
    List of validation configurations that are applied to the profile job.
    
    Parameters:
    
    validationConfigurations - List of validation configurations that are applied to the profile job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - validationConfigurations
```
Job.Builder validationConfigurations(Consumer<ValidationConfiguration.Builder>... validationConfigurations)
```
    List of validation configurations that are applied to the profile job.
    This is a convenience method that creates an instance of the ValidationConfiguration.Builder avoiding the need to create one manually via ValidationConfiguration.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #validationConfigurations(List).
    
    Parameters:
    
    validationConfigurations - a consumer that will call methods on ValidationConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #validationConfigurations(java.util.Collection)

Interface Job.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

accountId

createdBy

createDate

datasetName

encryptionKeyArn

encryptionMode

encryptionMode

name

type

type

lastModifiedBy

lastModifiedDate

logSubscription

logSubscription

maxCapacity

maxRetries

outputs

outputs

outputs

dataCatalogOutputs

dataCatalogOutputs

dataCatalogOutputs

databaseOutputs

databaseOutputs

databaseOutputs

projectName

recipeReference

recipeReference

resourceArn

roleArn

timeout

tags

jobSample

jobSample

validationConfigurations

validationConfigurations

validationConfigurations