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

Class AthenaGetQueryResultsJsonataProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<AthenaGetQueryResultsJsonataProps>

Enclosing interface:

AthenaGetQueryResultsJsonataProps

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

A builder for AthenaGetQueryResultsJsonataProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AthenaGetQueryResultsJsonataProps.Builder	assign(Map<String,? extends Object> assign)	Sets the value of AssignableStateOptions.getAssign()
AthenaGetQueryResultsJsonataProps	build()	Builds the configured instance.
AthenaGetQueryResultsJsonataProps.Builder	comment(String comment)	Sets the value of StateBaseProps.getComment()
AthenaGetQueryResultsJsonataProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseOptions.getCredentials()
AthenaGetQueryResultsJsonataProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
AthenaGetQueryResultsJsonataProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()
AthenaGetQueryResultsJsonataProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseOptions.getIntegrationPattern()
AthenaGetQueryResultsJsonataProps.Builder	maxResults(Number maxResults)	Sets the value of AthenaGetQueryResultsJsonataProps.getMaxResults()
AthenaGetQueryResultsJsonataProps.Builder	nextToken(String nextToken)	Sets the value of AthenaGetQueryResultsJsonataProps.getNextToken()
AthenaGetQueryResultsJsonataProps.Builder	outputs(Object outputs)	Sets the value of JsonataCommonOptions.getOutputs()
AthenaGetQueryResultsJsonataProps.Builder	queryExecutionId(String queryExecutionId)	Sets the value of AthenaGetQueryResultsJsonataProps.getQueryExecutionId()
AthenaGetQueryResultsJsonataProps.Builder	queryLanguage(QueryLanguage queryLanguage)	Sets the value of StateBaseProps.getQueryLanguage()
AthenaGetQueryResultsJsonataProps.Builder	stateName(String stateName)	Sets the value of StateBaseProps.getStateName()
AthenaGetQueryResultsJsonataProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseOptions.getTaskTimeout()
AthenaGetQueryResultsJsonataProps.Builder	timeout(Duration timeout)	Deprecated. use `taskTimeout`

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

queryExecutionId

@Stability(Stable)
public AthenaGetQueryResultsJsonataProps.Builder queryExecutionId(String queryExecutionId)

Sets the value of AthenaGetQueryResultsJsonataProps.getQueryExecutionId()

Parameters:

queryExecutionId - Query that will be retrieved. This parameter is required. Example value: adfsaf-23trf23-f23rt23

Returns:

this

maxResults

@Stability(Stable)
public AthenaGetQueryResultsJsonataProps.Builder maxResults(Number maxResults)

Sets the value of AthenaGetQueryResultsJsonataProps.getMaxResults()

Parameters:

maxResults - Max number of results.

Returns:

this

nextToken

@Stability(Stable)
public AthenaGetQueryResultsJsonataProps.Builder nextToken(String nextToken)

Sets the value of AthenaGetQueryResultsJsonataProps.getNextToken()

Parameters:

nextToken - Pagination token.

Returns:

this

comment

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

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

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

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AthenaGetQueryResultsJsonataProps

Throws:

NullPointerException - if any required attribute was not provided