software.amazon.awssdk.services.databrew.model

Interface DescribeJobRunResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeJobRunResponse.Builder,DescribeJobRunResponse>, DataBrewResponse.Builder, SdkBuilder<DescribeJobRunResponse.Builder,DescribeJobRunResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeJobRunResponse

public static interface DescribeJobRunResponse.Builder
extends DataBrewResponse.Builder, SdkPojo, CopyableBuilder<DescribeJobRunResponse.Builder,DescribeJobRunResponse>

Method Summary

Modifier and Type	Method and Description
DescribeJobRunResponse.Builder	attempt(Integer attempt) The number of times that DataBrew has attempted to run the job.
DescribeJobRunResponse.Builder	completedOn(Instant completedOn) The date and time when the job completed processing.
DescribeJobRunResponse.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.
DescribeJobRunResponse.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.
DescribeJobRunResponse.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.
DescribeJobRunResponse.Builder	dataCatalogOutputs(Collection<DataCatalogOutput> dataCatalogOutputs) One or more artifacts that represent the Glue Data Catalog output from running the job.
DescribeJobRunResponse.Builder	dataCatalogOutputs(Consumer<DataCatalogOutput.Builder>... dataCatalogOutputs) One or more artifacts that represent the Glue Data Catalog output from running the job.
DescribeJobRunResponse.Builder	dataCatalogOutputs(DataCatalogOutput... dataCatalogOutputs) One or more artifacts that represent the Glue Data Catalog output from running the job.
DescribeJobRunResponse.Builder	datasetName(String datasetName) The name of the dataset for the job to process.
DescribeJobRunResponse.Builder	errorMessage(String errorMessage) A message indicating an error (if any) that was encountered when the job ran.
DescribeJobRunResponse.Builder	executionTime(Integer executionTime) The amount of time, in seconds, during which the job run consumed resources.
DescribeJobRunResponse.Builder	jobName(String jobName) The name of the job being processed during this run.
default DescribeJobRunResponse.Builder	jobSample(Consumer<JobSample.Builder> jobSample) Sample configuration for profile jobs only.
DescribeJobRunResponse.Builder	jobSample(JobSample jobSample) Sample configuration for profile jobs only.
DescribeJobRunResponse.Builder	logGroupName(String logGroupName) The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.
DescribeJobRunResponse.Builder	logSubscription(LogSubscription logSubscription) The current status of Amazon CloudWatch logging for the job run.
DescribeJobRunResponse.Builder	logSubscription(String logSubscription) The current status of Amazon CloudWatch logging for the job run.
DescribeJobRunResponse.Builder	outputs(Collection<Output> outputs) One or more output artifacts from a job run.
DescribeJobRunResponse.Builder	outputs(Consumer<Output.Builder>... outputs) One or more output artifacts from a job run.
DescribeJobRunResponse.Builder	outputs(Output... outputs) One or more output artifacts from a job run.
default DescribeJobRunResponse.Builder	profileConfiguration(Consumer<ProfileConfiguration.Builder> profileConfiguration) Configuration for profile jobs.
DescribeJobRunResponse.Builder	profileConfiguration(ProfileConfiguration profileConfiguration) Configuration for profile jobs.
default DescribeJobRunResponse.Builder	recipeReference(Consumer<RecipeReference.Builder> recipeReference) Sets the value of the RecipeReference property for this object.
DescribeJobRunResponse.Builder	recipeReference(RecipeReference recipeReference) Sets the value of the RecipeReference property for this object.
DescribeJobRunResponse.Builder	runId(String runId) The unique identifier of the job run.
DescribeJobRunResponse.Builder	startedBy(String startedBy) The Amazon Resource Name (ARN) of the user who started the job run.
DescribeJobRunResponse.Builder	startedOn(Instant startedOn) The date and time when the job run began.
DescribeJobRunResponse.Builder	state(JobRunState state) The current state of the job run entity itself.
DescribeJobRunResponse.Builder	state(String state) The current state of the job run entity itself.
DescribeJobRunResponse.Builder	validationConfigurations(Collection<ValidationConfiguration> validationConfigurations) List of validation configurations that are applied to the profile job.
DescribeJobRunResponse.Builder	validationConfigurations(Consumer<ValidationConfiguration.Builder>... validationConfigurations) List of validation configurations that are applied to the profile job.
DescribeJobRunResponse.Builder	validationConfigurations(ValidationConfiguration... validationConfigurations) List of validation configurations that are applied to the profile job.

Methods inherited from interface software.amazon.awssdk.services.databrew.model.DataBrewResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

attempt

DescribeJobRunResponse.Builder attempt(Integer 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

DescribeJobRunResponse.Builder completedOn(Instant 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

DescribeJobRunResponse.Builder datasetName(String 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

DescribeJobRunResponse.Builder errorMessage(String 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

DescribeJobRunResponse.Builder executionTime(Integer executionTime)

The amount of time, in seconds, during which the job run consumed resources.

Parameters:

executionTime - The amount of time, in seconds, during which the job run consumed resources.

Returns:

Returns a reference to this object so that method calls can be chained together.

jobName

DescribeJobRunResponse.Builder jobName(String 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.

profileConfiguration

DescribeJobRunResponse.Builder profileConfiguration(ProfileConfiguration profileConfiguration)

Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

Parameters:

profileConfiguration - Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

Returns:

Returns a reference to this object so that method calls can be chained together.

profileConfiguration

default DescribeJobRunResponse.Builder profileConfiguration(Consumer<ProfileConfiguration.Builder> profileConfiguration)

Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

This is a convenience method that creates an instance of the ProfileConfiguration.Builder avoiding the need to create one manually via ProfileConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to profileConfiguration(ProfileConfiguration).

Parameters:

profileConfiguration - a consumer that will call methods on ProfileConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

profileConfiguration(ProfileConfiguration)

validationConfigurations

DescribeJobRunResponse.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

DescribeJobRunResponse.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

DescribeJobRunResponse.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)

runId

DescribeJobRunResponse.Builder runId(String 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

DescribeJobRunResponse.Builder state(String 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:

JobRunState, JobRunState

state

DescribeJobRunResponse.Builder state(JobRunState 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:

JobRunState, JobRunState

logSubscription

DescribeJobRunResponse.Builder logSubscription(String 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, LogSubscription

logSubscription

DescribeJobRunResponse.Builder logSubscription(LogSubscription 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, LogSubscription

logGroupName

DescribeJobRunResponse.Builder logGroupName(String 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

DescribeJobRunResponse.Builder outputs(Collection<Output> 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

DescribeJobRunResponse.Builder outputs(Output... 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

DescribeJobRunResponse.Builder outputs(Consumer<Output.Builder>... outputs)

One or more output artifacts from a job run.

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

DescribeJobRunResponse.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

DescribeJobRunResponse.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

DescribeJobRunResponse.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

DescribeJobRunResponse.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

DescribeJobRunResponse.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

DescribeJobRunResponse.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)

recipeReference

DescribeJobRunResponse.Builder recipeReference(RecipeReference recipeReference)

Sets the value of the RecipeReference property for this object.

Parameters:

recipeReference - The new value for the RecipeReference property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

recipeReference

default DescribeJobRunResponse.Builder recipeReference(Consumer<RecipeReference.Builder> recipeReference)

Sets the value of the RecipeReference property for this object. 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)

startedBy

DescribeJobRunResponse.Builder startedBy(String startedBy)

The Amazon Resource Name (ARN) of the user who started the job run.

Parameters:

startedBy - The Amazon Resource Name (ARN) of the user who started the job run.

Returns:

Returns a reference to this object so that method calls can be chained together.

startedOn

DescribeJobRunResponse.Builder startedOn(Instant 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

DescribeJobRunResponse.Builder jobSample(JobSample jobSample)

Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

Parameters:

jobSample - Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

jobSample

default DescribeJobRunResponse.Builder jobSample(Consumer<JobSample.Builder> jobSample)

Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 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)