Interface JobRun.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<JobRun.Builder,
,JobRun> SdkBuilder<JobRun.Builder,
,JobRun> SdkPojo
- Enclosing class:
JobRun
-
Method Summary
Modifier and TypeMethodDescriptionThe number of times that DataBrew has attempted to run the job.completedOn
(Instant completedOn) The date and time when the job completed processing.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) The name of the dataset for the job to process.errorMessage
(String errorMessage) A message indicating an error (if any) that was encountered when the job ran.executionTime
(Integer executionTime) The amount of time, in seconds, during which a job run consumed resources.The name of the job being processed during this run.default JobRun.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.logGroupName
(String logGroupName) The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.logSubscription
(String logSubscription) The current status of Amazon CloudWatch logging for the job run.logSubscription
(LogSubscription logSubscription) The current status of Amazon CloudWatch logging for the job run.outputs
(Collection<Output> outputs) One or more output artifacts from a job run.outputs
(Consumer<Output.Builder>... outputs) One or more output artifacts from a job run.One or more output artifacts from a job run.default JobRun.Builder
recipeReference
(Consumer<RecipeReference.Builder> recipeReference) The set of steps processed by the job.recipeReference
(RecipeReference recipeReference) The set of steps processed by the job.The unique identifier of the job run.The Amazon Resource Name (ARN) of the user who initiated the job run.The date and time when the job run began.The current state of the job run entity itself.state
(JobRunState state) The current state of the job run entity itself.validationConfigurations
(Collection<ValidationConfiguration> validationConfigurations) List of validation configurations that are applied to the profile job run.validationConfigurations
(Consumer<ValidationConfiguration.Builder>... validationConfigurations) List of validation configurations that are applied to the profile job run.validationConfigurations
(ValidationConfiguration... validationConfigurations) List of validation configurations that are applied to the profile job run.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
-
attempt
The number of times that DataBrew has attempted to run the job.
- Parameters:
attempt
- The number of times that DataBrew has attempted to run the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
completedOn
The date and time when the job completed processing.
- Parameters:
completedOn
- The date and time when the job completed processing.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
datasetName
The name of the dataset for the job to process.
- Parameters:
datasetName
- The name of the dataset for the job to process.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
errorMessage
A message indicating an error (if any) that was encountered when the job ran.
- Parameters:
errorMessage
- A message indicating an error (if any) that was encountered when the job ran.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
executionTime
The amount of time, in seconds, during which a job run consumed resources.
- Parameters:
executionTime
- The amount of time, in seconds, during which a job run consumed resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobName
The name of the job being processed during this run.
- Parameters:
jobName
- The name of the job being processed during this run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
runId
The unique identifier of the job run.
- Parameters:
runId
- The unique identifier of the job run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
state
The current state of the job run entity itself.
- Parameters:
state
- The current state of the job run entity itself.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
state
The current state of the job run entity itself.
- Parameters:
state
- The current state of the job run entity itself.- 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 run.
- Parameters:
logSubscription
- The current status of Amazon CloudWatch logging for the job run.- 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 run.
- Parameters:
logSubscription
- The current status of Amazon CloudWatch logging for the job run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
logGroupName
The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.
- Parameters:
logGroupName
- The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputs
One or more output artifacts from a job run.
- Parameters:
outputs
- One or more output artifacts from a job run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputs
One or more output artifacts from a job run.
- Parameters:
outputs
- One or more output artifacts from a job run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputs
One or more output artifacts from a job run.
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:
-
recipeReference
The set of steps processed by the job.
- Parameters:
recipeReference
- The set of steps processed by the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
recipeReference
The set of steps processed by the job.
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:
-
startedBy
The Amazon Resource Name (ARN) of the user who initiated the job run.
- Parameters:
startedBy
- The Amazon Resource Name (ARN) of the user who initiated the job run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startedOn
The date and time when the job run began.
- Parameters:
startedOn
- The date and time when the job run began.- 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 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 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 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
JobRun.Builder validationConfigurations(Collection<ValidationConfiguration> validationConfigurations) List of validation configurations that are applied to the profile job run.
- Parameters:
validationConfigurations
- List of validation configurations that are applied to the profile job run.- 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 run.
- Parameters:
validationConfigurations
- List of validation configurations that are applied to the profile job run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
validationConfigurations
JobRun.Builder validationConfigurations(Consumer<ValidationConfiguration.Builder>... validationConfigurations) List of validation configurations that are applied to the profile job run.
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:
-