Package software.amazon.awscdk.services.stepfunctions.tasks

Class GlueStartJobRunJsonataProps.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.tasks.GlueStartJobRunJsonataProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GlueStartJobRunJsonataProps>

Enclosing interface:

GlueStartJobRunJsonataProps

@Stability(Stable)
public static final class GlueStartJobRunJsonataProps.Builder
extends Object
implements software.amazon.jsii.Builder<GlueStartJobRunJsonataProps>

A builder for GlueStartJobRunJsonataProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GlueStartJobRunJsonataProps.Builder	arguments(TaskInput arguments)	Sets the value of GlueStartJobRunJsonataProps.getArguments()
GlueStartJobRunJsonataProps.Builder	assign(Map<String,? extends Object> assign)	Sets the value of AssignableStateOptions.getAssign()
GlueStartJobRunJsonataProps	build()	Builds the configured instance.
GlueStartJobRunJsonataProps.Builder	comment(String comment)	Sets the value of StateBaseProps.getComment()
GlueStartJobRunJsonataProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseOptions.getCredentials()
GlueStartJobRunJsonataProps.Builder	executionClass(ExecutionClass executionClass)	Sets the value of GlueStartJobRunJsonataProps.getExecutionClass()
GlueStartJobRunJsonataProps.Builder	glueJobName(String glueJobName)	Sets the value of GlueStartJobRunJsonataProps.getGlueJobName()
GlueStartJobRunJsonataProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
GlueStartJobRunJsonataProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()
GlueStartJobRunJsonataProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseOptions.getIntegrationPattern()
GlueStartJobRunJsonataProps.Builder	notifyDelayAfter(Duration notifyDelayAfter)	Sets the value of GlueStartJobRunJsonataProps.getNotifyDelayAfter()
GlueStartJobRunJsonataProps.Builder	outputs(Object outputs)	Sets the value of JsonataCommonOptions.getOutputs()
GlueStartJobRunJsonataProps.Builder	queryLanguage(QueryLanguage queryLanguage)	Sets the value of StateBaseProps.getQueryLanguage()
GlueStartJobRunJsonataProps.Builder	securityConfiguration(String securityConfiguration)	Sets the value of GlueStartJobRunJsonataProps.getSecurityConfiguration()
GlueStartJobRunJsonataProps.Builder	stateName(String stateName)	Sets the value of StateBaseProps.getStateName()
GlueStartJobRunJsonataProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseOptions.getTaskTimeout()
GlueStartJobRunJsonataProps.Builder	timeout(Duration timeout)	Deprecated. use `taskTimeout`
GlueStartJobRunJsonataProps.Builder	workerConfiguration(WorkerConfigurationProperty workerConfiguration)	Sets the value of GlueStartJobRunJsonataProps.getWorkerConfiguration()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

glueJobName

@Stability(Stable)
public GlueStartJobRunJsonataProps.Builder glueJobName(String glueJobName)

Sets the value of GlueStartJobRunJsonataProps.getGlueJobName()

Parameters:

glueJobName - Glue job name. This parameter is required.

Returns:

this

arguments

@Stability(Stable)
public GlueStartJobRunJsonataProps.Builder arguments(TaskInput arguments)

Sets the value of GlueStartJobRunJsonataProps.getArguments()

Parameters:

arguments - The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.

Returns:

this

executionClass

@Stability(Stable)
public GlueStartJobRunJsonataProps.Builder executionClass(ExecutionClass executionClass)

Sets the value of GlueStartJobRunJsonataProps.getExecutionClass()

Parameters:

executionClass - The excecution class of the job.

Returns:

this

notifyDelayAfter

@Stability(Stable)
public GlueStartJobRunJsonataProps.Builder notifyDelayAfter(Duration notifyDelayAfter)

Sets the value of GlueStartJobRunJsonataProps.getNotifyDelayAfter()

Parameters:

notifyDelayAfter - After a job run starts, the number of minutes to wait before sending a job run delay notification. Must be at least 1 minute.

Returns:

this

securityConfiguration

@Stability(Stable)
public GlueStartJobRunJsonataProps.Builder securityConfiguration(String securityConfiguration)

Sets the value of GlueStartJobRunJsonataProps.getSecurityConfiguration()

Parameters:

securityConfiguration - The name of the SecurityConfiguration structure to be used with this job run. This must match the Glue API

Returns:

this

workerConfiguration

@Stability(Stable)
public GlueStartJobRunJsonataProps.Builder workerConfiguration(WorkerConfigurationProperty workerConfiguration)

Sets the value of GlueStartJobRunJsonataProps.getWorkerConfiguration()

Parameters:

workerConfiguration - The worker configuration for this run.

Returns:

this

comment

@Stability(Stable)
public GlueStartJobRunJsonataProps.Builder comment(String comment)

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

@Stability(Stable)
public GlueStartJobRunJsonataProps.Builder queryLanguage(QueryLanguage queryLanguage)

Sets the value of StateBaseProps.getQueryLanguage()

Parameters:

queryLanguage - The name of the query language used by the state. If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

Returns:

this

stateName

@Stability(Stable)
public GlueStartJobRunJsonataProps.Builder stateName(String stateName)

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

@Stability(Stable)
public GlueStartJobRunJsonataProps.Builder credentials(Credentials credentials)

Sets the value of TaskStateBaseOptions.getCredentials()

Parameters:

credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations.

Returns:

this

heartbeat

@Stability(Deprecated)
@Deprecated
public GlueStartJobRunJsonataProps.Builder heartbeat(Duration heartbeat)

Deprecated.

use `heartbeatTimeout`

Sets the value of TaskStateBaseOptions.getHeartbeat()

Parameters:

heartbeat - Timeout for the heartbeat.

Returns:

this

heartbeatTimeout

@Stability(Stable)
public GlueStartJobRunJsonataProps.Builder heartbeatTimeout(Timeout heartbeatTimeout)

Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()

Parameters:

heartbeatTimeout - Timeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

integrationPattern

@Stability(Stable)
public GlueStartJobRunJsonataProps.Builder integrationPattern(IntegrationPattern integrationPattern)

Sets the value of TaskStateBaseOptions.getIntegrationPattern()

Parameters:

integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

Returns:

this

taskTimeout

@Stability(Stable)
public GlueStartJobRunJsonataProps.Builder taskTimeout(Timeout taskTimeout)

Sets the value of TaskStateBaseOptions.getTaskTimeout()

Parameters:

taskTimeout - Timeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

timeout

@Stability(Deprecated)
@Deprecated
public GlueStartJobRunJsonataProps.Builder timeout(Duration timeout)

Deprecated.

use `taskTimeout`

Sets the value of TaskStateBaseOptions.getTimeout()

Parameters:

timeout - Timeout for the task.

Returns:

this

assign

@Stability(Stable)
public GlueStartJobRunJsonataProps.Builder assign(Map<String,? extends Object> assign)

Sets the value of AssignableStateOptions.getAssign()

Parameters:

assign - Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps.

Returns:

this

outputs

@Stability(Stable)
public GlueStartJobRunJsonataProps.Builder outputs(Object outputs)

Sets the value of JsonataCommonOptions.getOutputs()

Parameters:

outputs - Used to specify and transform output from the state. When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Returns:

this

build

@Stability(Stable)
public GlueStartJobRunJsonataProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<GlueStartJobRunJsonataProps>

Returns:

a new instance of GlueStartJobRunJsonataProps

Throws:

NullPointerException - if any required attribute was not provided