software.amazon.awssdk.services.glue.model

Interface JobRun.Builder

All Superinterfaces:

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

Enclosing class:

JobRun

public static interface JobRun.Builder
extends SdkPojo, CopyableBuilder<JobRun.Builder,JobRun>

Method Summary

Modifier and Type	Method and Description
JobRun.Builder	allocatedCapacity(Integer allocatedCapacity) The number of AWS Glue data processing units (DPUs) allocated to this JobRun.
JobRun.Builder	arguments(Map<String,String> arguments) The job arguments associated with this run.
JobRun.Builder	attempt(Integer attempt) The number of the attempt to run this job.
JobRun.Builder	completedOn(Instant completedOn) The date and time this job run completed.
JobRun.Builder	errorMessage(String errorMessage) An error message associated with this job run.
JobRun.Builder	executionTime(Integer executionTime) The amount of time (in seconds) that the job run consumed resources.
JobRun.Builder	id(String id) The ID of this job run.
JobRun.Builder	jobName(String jobName) The name of the job definition being used in this run.
JobRun.Builder	jobRunState(JobRunState jobRunState) The current state of the job run.
JobRun.Builder	jobRunState(String jobRunState) The current state of the job run.
JobRun.Builder	lastModifiedOn(Instant lastModifiedOn) The last time this job run was modified.
JobRun.Builder	logGroupName(String logGroupName) The name of the log group for secure logging, that can be server-side encrypted in CloudWatch using KMS.
default JobRun.Builder	notificationProperty(Consumer<NotificationProperty.Builder> notificationProperty) Specifies configuration properties of a job run notification.
JobRun.Builder	notificationProperty(NotificationProperty notificationProperty) Specifies configuration properties of a job run notification.
JobRun.Builder	predecessorRuns(Collection<Predecessor> predecessorRuns) A list of predecessors to this job run.
JobRun.Builder	predecessorRuns(Consumer<Predecessor.Builder>... predecessorRuns) A list of predecessors to this job run.
JobRun.Builder	predecessorRuns(Predecessor... predecessorRuns) A list of predecessors to this job run.
JobRun.Builder	previousRunId(String previousRunId) The ID of the previous run of this job.
JobRun.Builder	securityConfiguration(String securityConfiguration) The name of the SecurityConfiguration structure to be used with this job run.
JobRun.Builder	startedOn(Instant startedOn) The date and time at which this job run was started.
JobRun.Builder	timeout(Integer timeout) The JobRun timeout in minutes.
JobRun.Builder	triggerName(String triggerName) The name of the trigger that started this job run.

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

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

id

JobRun.Builder id(String id)

The ID of this job run.

Parameters:

id - The ID of this job run.

Returns:

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

attempt

JobRun.Builder attempt(Integer attempt)

The number of the attempt to run this job.

Parameters:

attempt - The number of the attempt to run this job.

Returns:

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

previousRunId

JobRun.Builder previousRunId(String previousRunId)

The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.

Parameters:

previousRunId - The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.

Returns:

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

triggerName

JobRun.Builder triggerName(String triggerName)

The name of the trigger that started this job run.

Parameters:

triggerName - The name of the trigger that started this job run.

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 definition being used in this run.

Parameters:

jobName - The name of the job definition being used in this 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 at which this job run was started.

Parameters:

startedOn - The date and time at which this job run was started.

Returns:

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

lastModifiedOn

JobRun.Builder lastModifiedOn(Instant lastModifiedOn)

The last time this job run was modified.

Parameters:

lastModifiedOn - The last time this job run was modified.

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 this job run completed.

Parameters:

completedOn - The date and time this job run completed.

Returns:

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

jobRunState

JobRun.Builder jobRunState(String jobRunState)

The current state of the job run.

Parameters:

jobRunState - The current state of the job run.

Returns:

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

See Also:

JobRunState, JobRunState

jobRunState

JobRun.Builder jobRunState(JobRunState jobRunState)

The current state of the job run.

Parameters:

jobRunState - The current state of the job run.

Returns:

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

See Also:

JobRunState, JobRunState

arguments

JobRun.Builder arguments(Map<String,String> arguments)

The job arguments associated with this run. These override equivalent default arguments set for the job.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

Parameters:

arguments - The job arguments associated with this run. These override equivalent default arguments set for the job.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

Returns:

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

errorMessage

JobRun.Builder errorMessage(String errorMessage)

An error message associated with this job run.

Parameters:

errorMessage - An error message associated with this job run.

Returns:

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

predecessorRuns

JobRun.Builder predecessorRuns(Collection<Predecessor> predecessorRuns)

A list of predecessors to this job run.

Parameters:

predecessorRuns - A list of predecessors to this job run.

Returns:

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

predecessorRuns

JobRun.Builder predecessorRuns(Predecessor... predecessorRuns)

A list of predecessors to this job run.

Parameters:

predecessorRuns - A list of predecessors to this job run.

Returns:

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

predecessorRuns

JobRun.Builder predecessorRuns(Consumer<Predecessor.Builder>... predecessorRuns)

A list of predecessors to this job run.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #predecessorRuns(List).

Parameters:

predecessorRuns - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#predecessorRuns(List)

allocatedCapacity

JobRun.Builder allocatedCapacity(Integer allocatedCapacity)

The number of AWS Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

Parameters:

allocatedCapacity - The number of AWS Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

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) that the job run consumed resources.

Parameters:

executionTime - The amount of time (in seconds) that the job run consumed resources.

Returns:

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

timeout

JobRun.Builder timeout(Integer timeout)

The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

Parameters:

timeout - The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

Returns:

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

notificationProperty

JobRun.Builder notificationProperty(NotificationProperty notificationProperty)

Specifies configuration properties of a job run notification.

Parameters:

notificationProperty - Specifies configuration properties of a job run notification.

Returns:

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

notificationProperty

default JobRun.Builder notificationProperty(Consumer<NotificationProperty.Builder> notificationProperty)

Specifies configuration properties of a job run notification.

This is a convenience that creates an instance of the NotificationProperty.Builder avoiding the need to create one manually via NotificationProperty.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to notificationProperty(NotificationProperty).

Parameters:

notificationProperty - a consumer that will call methods on NotificationProperty.Builder

Returns:

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

See Also:

notificationProperty(NotificationProperty)

securityConfiguration

JobRun.Builder securityConfiguration(String securityConfiguration)

The name of the SecurityConfiguration structure to be used with this job run.

Parameters:

securityConfiguration - The name of the SecurityConfiguration structure to be used with this job run.

Returns:

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

logGroupName

JobRun.Builder logGroupName(String logGroupName)

The name of the log group for secure logging, that can be server-side encrypted in CloudWatch using KMS. This name can be /aws-glue/jobs/, in which case the default encryption is NONE. If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/), then that security configuration will be used to encrypt the log group.

Parameters:

logGroupName - The name of the log group for secure logging, that can be server-side encrypted in CloudWatch using KMS. This name can be /aws-glue/jobs/, in which case the default encryption is NONE. If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/), then that security configuration will be used to encrypt the log group.

Returns:

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