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

Class AthenaStartQueryExecutionJsonataProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<AthenaStartQueryExecutionJsonataProps>

Enclosing interface:

AthenaStartQueryExecutionJsonataProps

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

A builder for AthenaStartQueryExecutionJsonataProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AthenaStartQueryExecutionJsonataProps.Builder	assign(Map<String,? extends Object> assign)	Sets the value of AssignableStateOptions.getAssign()
AthenaStartQueryExecutionJsonataProps	build()	Builds the configured instance.
AthenaStartQueryExecutionJsonataProps.Builder	clientRequestToken(String clientRequestToken)	Sets the value of AthenaStartQueryExecutionJsonataProps.getClientRequestToken()
AthenaStartQueryExecutionJsonataProps.Builder	comment(String comment)	Sets the value of StateBaseProps.getComment()
AthenaStartQueryExecutionJsonataProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseOptions.getCredentials()
AthenaStartQueryExecutionJsonataProps.Builder	executionParameters(List<String> executionParameters)	Sets the value of AthenaStartQueryExecutionJsonataProps.getExecutionParameters()
AthenaStartQueryExecutionJsonataProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
AthenaStartQueryExecutionJsonataProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()
AthenaStartQueryExecutionJsonataProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseOptions.getIntegrationPattern()
AthenaStartQueryExecutionJsonataProps.Builder	outputs(Object outputs)	Sets the value of JsonataCommonOptions.getOutputs()
AthenaStartQueryExecutionJsonataProps.Builder	queryExecutionContext(QueryExecutionContext queryExecutionContext)	Sets the value of AthenaStartQueryExecutionJsonataProps.getQueryExecutionContext()
AthenaStartQueryExecutionJsonataProps.Builder	queryLanguage(QueryLanguage queryLanguage)	Sets the value of StateBaseProps.getQueryLanguage()
AthenaStartQueryExecutionJsonataProps.Builder	queryString(String queryString)	Sets the value of AthenaStartQueryExecutionJsonataProps.getQueryString()
AthenaStartQueryExecutionJsonataProps.Builder	resultConfiguration(ResultConfiguration resultConfiguration)	Sets the value of AthenaStartQueryExecutionJsonataProps.getResultConfiguration()
AthenaStartQueryExecutionJsonataProps.Builder	resultReuseConfigurationMaxAge(Duration resultReuseConfigurationMaxAge)	Sets the value of AthenaStartQueryExecutionJsonataProps.getResultReuseConfigurationMaxAge()
AthenaStartQueryExecutionJsonataProps.Builder	stateName(String stateName)	Sets the value of StateBaseProps.getStateName()
AthenaStartQueryExecutionJsonataProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseOptions.getTaskTimeout()
AthenaStartQueryExecutionJsonataProps.Builder	timeout(Duration timeout)	Deprecated. use `taskTimeout`
AthenaStartQueryExecutionJsonataProps.Builder	workGroup(String workGroup)	Sets the value of AthenaStartQueryExecutionJsonataProps.getWorkGroup()

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

queryString

@Stability(Stable)
public AthenaStartQueryExecutionJsonataProps.Builder queryString(String queryString)

Sets the value of AthenaStartQueryExecutionJsonataProps.getQueryString()

Parameters:

queryString - Query that will be started. This parameter is required.

Returns:

this

clientRequestToken

@Stability(Stable)
public AthenaStartQueryExecutionJsonataProps.Builder clientRequestToken(String clientRequestToken)

Sets the value of AthenaStartQueryExecutionJsonataProps.getClientRequestToken()

Parameters:

clientRequestToken - Unique string string to ensure idempotence.

Returns:

this

executionParameters

@Stability(Stable)
public AthenaStartQueryExecutionJsonataProps.Builder executionParameters(List<String> executionParameters)

Sets the value of AthenaStartQueryExecutionJsonataProps.getExecutionParameters()

Parameters:

executionParameters - A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.

Returns:

this

queryExecutionContext

@Stability(Stable)
public AthenaStartQueryExecutionJsonataProps.Builder queryExecutionContext(QueryExecutionContext queryExecutionContext)

Sets the value of AthenaStartQueryExecutionJsonataProps.getQueryExecutionContext()

Parameters:

queryExecutionContext - Database within which query executes.

Returns:

this

resultConfiguration

@Stability(Stable)
public AthenaStartQueryExecutionJsonataProps.Builder resultConfiguration(ResultConfiguration resultConfiguration)

Sets the value of AthenaStartQueryExecutionJsonataProps.getResultConfiguration()

Parameters:

resultConfiguration - Configuration on how and where to save query.

Returns:

this

resultReuseConfigurationMaxAge

@Stability(Stable)
public AthenaStartQueryExecutionJsonataProps.Builder resultReuseConfigurationMaxAge(Duration resultReuseConfigurationMaxAge)

Sets the value of AthenaStartQueryExecutionJsonataProps.getResultReuseConfigurationMaxAge()

Parameters:

resultReuseConfigurationMaxAge - Specifies, in minutes, the maximum age of a previous query result that Athena should consider for reuse.

Returns:

this

workGroup

@Stability(Stable)
public AthenaStartQueryExecutionJsonataProps.Builder workGroup(String workGroup)

Sets the value of AthenaStartQueryExecutionJsonataProps.getWorkGroup()

Parameters:

workGroup - Configuration on how and where to save query.

Returns:

this

comment

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

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

@Stability(Stable)
public AthenaStartQueryExecutionJsonataProps.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 AthenaStartQueryExecutionJsonataProps.Builder stateName(String stateName)

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

@Stability(Stable)
public AthenaStartQueryExecutionJsonataProps.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 AthenaStartQueryExecutionJsonataProps.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 AthenaStartQueryExecutionJsonataProps.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 AthenaStartQueryExecutionJsonataProps.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 AthenaStartQueryExecutionJsonataProps.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 AthenaStartQueryExecutionJsonataProps.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 AthenaStartQueryExecutionJsonataProps.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 AthenaStartQueryExecutionJsonataProps.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 AthenaStartQueryExecutionJsonataProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AthenaStartQueryExecutionJsonataProps

Throws:

NullPointerException - if any required attribute was not provided