Package software.amazon.awssdk.services.databrew.model

Interface JobRun.Builder

    • Method Detail

      • attempt

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

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

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

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

        JobRun.Builder executionTime​(Integer 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

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

      • runId

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

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

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

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

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

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

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

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

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

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

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

      • databaseOutputs

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

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

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

        JobRun.Builder recipeReference​(RecipeReference 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.

      • startedBy

        JobRun.Builder startedBy​(String 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

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

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

        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

        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

        JobRun.Builder validationConfigurations​(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.