Interface Job.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Job.Builder,
,Job> SdkBuilder<Job.Builder,
,Job> SdkPojo
- Enclosing class:
Job
-
Method Summary
Modifier and TypeMethodDescriptionThe ID of the Amazon Web Services account that owns the job.createDate
(Instant createDate) The date and time that the job was created.The Amazon Resource Name (ARN) of the user who created the job.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.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.databaseOutputs
(DatabaseOutput... databaseOutputs) Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.dataCatalogOutputs
(Collection<DataCatalogOutput> dataCatalogOutputs) One or more artifacts that represent the Glue Data Catalog output from running the job.dataCatalogOutputs
(Consumer<DataCatalogOutput.Builder>... dataCatalogOutputs) One or more artifacts that represent the Glue Data Catalog output from running the job.dataCatalogOutputs
(DataCatalogOutput... dataCatalogOutputs) One or more artifacts that represent the Glue Data Catalog output from running the job.datasetName
(String datasetName) A dataset that the job is to process.encryptionKeyArn
(String encryptionKeyArn) The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output.encryptionMode
(String encryptionMode) The encryption mode for the job, which can be one of the following:encryptionMode
(EncryptionMode 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.A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.lastModifiedBy
(String lastModifiedBy) The Amazon Resource Name (ARN) of the user who last modified the job.lastModifiedDate
(Instant lastModifiedDate) The modification date and time of the job.logSubscription
(String logSubscription) The current status of Amazon CloudWatch logging for the job.logSubscription
(LogSubscription logSubscription) The current status of Amazon CloudWatch logging for the job.maxCapacity
(Integer maxCapacity) The maximum number of nodes that can be consumed when the job processes data.maxRetries
(Integer maxRetries) The maximum number of times to retry the job after a job run fails.The unique name of the job.outputs
(Collection<Output> outputs) One or more artifacts that represent output from running the job.outputs
(Consumer<Output.Builder>... outputs) One or more artifacts that represent output from running the job.One or more artifacts that represent output from running the job.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.recipeReference
(RecipeReference recipeReference) A set of steps that the job runs.resourceArn
(String resourceArn) The unique Amazon Resource Name (ARN) for the job.The Amazon Resource Name (ARN) of the role to be assumed for this job.Metadata tags that have been applied to the job.The job's timeout in minutes.The job type of the job, which must be one of the following:The job type of the job, which must be one of the following:validationConfigurations
(Collection<ValidationConfiguration> validationConfigurations) List of validation configurations that are applied to the profile job.validationConfigurations
(Consumer<ValidationConfiguration.Builder>... validationConfigurations) List of validation configurations that are applied to the profile job.validationConfigurations
(ValidationConfiguration... validationConfigurations) List of validation configurations that are applied to the profile job.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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
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
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
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:
-
-
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
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:
-
-
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:
-
-
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
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
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
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:
-
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
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
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
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
One or more artifacts that represent output from running the job.
This is a convenience method that creates an instance of theOutput.Builder
avoiding the need to create one manually viaOutput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooutputs(List<Output>)
.- Parameters:
outputs
- a consumer that will call methods onOutput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theDataCatalogOutput.Builder
avoiding the need to create one manually viaDataCatalogOutput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todataCatalogOutputs(List<DataCatalogOutput>)
.- Parameters:
dataCatalogOutputs
- a consumer that will call methods onDataCatalogOutput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theDatabaseOutput.Builder
avoiding the need to create one manually viaDatabaseOutput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todatabaseOutputs(List<DatabaseOutput>)
.- Parameters:
databaseOutputs
- a consumer that will call methods onDatabaseOutput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
A set of steps that the job runs.
This is a convenience method that creates an instance of theRecipeReference.Builder
avoiding the need to create one manually viaRecipeReference.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torecipeReference(RecipeReference)
.- Parameters:
recipeReference
- a consumer that will call methods onRecipeReference.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 ofTIMEOUT
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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 aJobSample
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
A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a
This is a convenience method that creates an instance of theJobSample
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.JobSample.Builder
avoiding the need to create one manually viaJobSample.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tojobSample(JobSample)
.- Parameters:
jobSample
- a consumer that will call methods onJobSample.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theValidationConfiguration.Builder
avoiding the need to create one manually viaValidationConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovalidationConfigurations(List<ValidationConfiguration>)
.- Parameters:
validationConfigurations
- a consumer that will call methods onValidationConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-