software.amazon.awscdk.services.stepfunctions.tasks

Class AthenaStartQueryExecutionProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<AthenaStartQueryExecutionProps>

Enclosing interface:

AthenaStartQueryExecutionProps

@Stability(value=Experimental)
public static final class AthenaStartQueryExecutionProps.Builder
extends Object
implements software.amazon.jsii.Builder<AthenaStartQueryExecutionProps>

A builder for AthenaStartQueryExecutionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AthenaStartQueryExecutionProps	build() Builds the configured instance.
AthenaStartQueryExecutionProps.Builder	clientRequestToken(String clientRequestToken) Sets the value of AthenaStartQueryExecutionProps.getClientRequestToken()
AthenaStartQueryExecutionProps.Builder	comment(String comment) Sets the value of TaskStateBaseProps.getComment()
AthenaStartQueryExecutionProps.Builder	heartbeat(Duration heartbeat) Sets the value of TaskStateBaseProps.getHeartbeat()
AthenaStartQueryExecutionProps.Builder	inputPath(String inputPath) Sets the value of TaskStateBaseProps.getInputPath()
AthenaStartQueryExecutionProps.Builder	integrationPattern(IntegrationPattern integrationPattern) Sets the value of TaskStateBaseProps.getIntegrationPattern()
AthenaStartQueryExecutionProps.Builder	outputPath(String outputPath) Sets the value of TaskStateBaseProps.getOutputPath()
AthenaStartQueryExecutionProps.Builder	queryExecutionContext(QueryExecutionContext queryExecutionContext) Sets the value of AthenaStartQueryExecutionProps.getQueryExecutionContext()
AthenaStartQueryExecutionProps.Builder	queryString(String queryString) Sets the value of AthenaStartQueryExecutionProps.getQueryString()
AthenaStartQueryExecutionProps.Builder	resultConfiguration(ResultConfiguration resultConfiguration) Sets the value of AthenaStartQueryExecutionProps.getResultConfiguration()
AthenaStartQueryExecutionProps.Builder	resultPath(String resultPath) Sets the value of TaskStateBaseProps.getResultPath()
AthenaStartQueryExecutionProps.Builder	resultSelector(Map<String,? extends Object> resultSelector) Sets the value of TaskStateBaseProps.getResultSelector()
AthenaStartQueryExecutionProps.Builder	timeout(Duration timeout) Sets the value of TaskStateBaseProps.getTimeout()
AthenaStartQueryExecutionProps.Builder	workGroup(String workGroup) Sets the value of AthenaStartQueryExecutionProps.getWorkGroup()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

queryString

@Stability(value=Experimental)
public AthenaStartQueryExecutionProps.Builder queryString(String queryString)

Sets the value of AthenaStartQueryExecutionProps.getQueryString()

Parameters:

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

Returns:

this

clientRequestToken

@Stability(value=Experimental)
public AthenaStartQueryExecutionProps.Builder clientRequestToken(String clientRequestToken)

Sets the value of AthenaStartQueryExecutionProps.getClientRequestToken()

Parameters:

clientRequestToken - Unique string string to ensure idempotence.

Returns:

this

queryExecutionContext

@Stability(value=Experimental)
public AthenaStartQueryExecutionProps.Builder queryExecutionContext(QueryExecutionContext queryExecutionContext)

Sets the value of AthenaStartQueryExecutionProps.getQueryExecutionContext()

Parameters:

queryExecutionContext - Database within which query executes.

Returns:

this

resultConfiguration

@Stability(value=Experimental)
public AthenaStartQueryExecutionProps.Builder resultConfiguration(ResultConfiguration resultConfiguration)

Sets the value of AthenaStartQueryExecutionProps.getResultConfiguration()

Parameters:

resultConfiguration - Configuration on how and where to save query.

Returns:

this

workGroup

@Stability(value=Experimental)
public AthenaStartQueryExecutionProps.Builder workGroup(String workGroup)

Sets the value of AthenaStartQueryExecutionProps.getWorkGroup()

Parameters:

workGroup - Configuration on how and where to save query.

Returns:

this

comment

@Stability(value=Experimental)
public AthenaStartQueryExecutionProps.Builder comment(String comment)

Sets the value of TaskStateBaseProps.getComment()

Parameters:

comment - An optional description for this state.

Returns:

this

heartbeat

@Stability(value=Experimental)
public AthenaStartQueryExecutionProps.Builder heartbeat(Duration heartbeat)

Sets the value of TaskStateBaseProps.getHeartbeat()

Parameters:

heartbeat - Timeout for the heartbeat.

Returns:

this

inputPath

@Stability(value=Experimental)
public AthenaStartQueryExecutionProps.Builder inputPath(String inputPath)

Sets the value of TaskStateBaseProps.getInputPath()

Parameters:

inputPath - JSONPath expression to select part of the state to be the input to this state. May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Returns:

this

integrationPattern

@Stability(value=Experimental)
public AthenaStartQueryExecutionProps.Builder integrationPattern(IntegrationPattern integrationPattern)

Sets the value of TaskStateBaseProps.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

Returns:

this

outputPath

@Stability(value=Experimental)
public AthenaStartQueryExecutionProps.Builder outputPath(String outputPath)

Sets the value of TaskStateBaseProps.getOutputPath()

Parameters:

outputPath - JSONPath expression to select select a portion of the state output to pass to the next state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Returns:

this

resultPath

@Stability(value=Experimental)
public AthenaStartQueryExecutionProps.Builder resultPath(String resultPath)

Sets the value of TaskStateBaseProps.getResultPath()

Parameters:

resultPath - JSONPath expression to indicate where to inject the state's output. May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

Returns:

this

resultSelector

@Stability(value=Experimental)
public AthenaStartQueryExecutionProps.Builder resultSelector(Map<String,? extends Object> resultSelector)

Sets the value of TaskStateBaseProps.getResultSelector()

Parameters:

resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

Returns:

this

timeout

@Stability(value=Experimental)
public AthenaStartQueryExecutionProps.Builder timeout(Duration timeout)

Sets the value of TaskStateBaseProps.getTimeout()

Parameters:

timeout - Timeout for the state machine.

Returns:

this

build

@Stability(value=Experimental)
public AthenaStartQueryExecutionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AthenaStartQueryExecutionProps

Throws:

NullPointerException - if any required attribute was not provided