public static final class AthenaStartQueryExecution.Builder
extends java.lang.Object
AthenaStartQueryExecution
.Modifier and Type | Method and Description |
---|---|
AthenaStartQueryExecution |
build() |
AthenaStartQueryExecution.Builder |
clientRequestToken(java.lang.String clientRequestToken)
Unique string string to ensure idempotence.
|
AthenaStartQueryExecution.Builder |
comment(java.lang.String comment)
An optional description for this state.
|
static AthenaStartQueryExecution.Builder |
create(software.constructs.Construct scope,
java.lang.String id) |
AthenaStartQueryExecution.Builder |
heartbeat(Duration heartbeat)
Timeout for the heartbeat.
|
AthenaStartQueryExecution.Builder |
inputPath(java.lang.String inputPath)
JSONPath expression to select part of the state to be the input to this state.
|
AthenaStartQueryExecution.Builder |
integrationPattern(IntegrationPattern integrationPattern)
AWS Step Functions integrates with services directly in the Amazon States Language.
|
AthenaStartQueryExecution.Builder |
outputPath(java.lang.String outputPath)
JSONPath expression to select select a portion of the state output to pass to the next state.
|
AthenaStartQueryExecution.Builder |
queryExecutionContext(QueryExecutionContext queryExecutionContext)
Database within which query executes.
|
AthenaStartQueryExecution.Builder |
queryString(java.lang.String queryString)
Query that will be started.
|
AthenaStartQueryExecution.Builder |
resultConfiguration(ResultConfiguration resultConfiguration)
Configuration on how and where to save query.
|
AthenaStartQueryExecution.Builder |
resultPath(java.lang.String resultPath)
JSONPath expression to indicate where to inject the state's output.
|
AthenaStartQueryExecution.Builder |
resultSelector(java.util.Map<java.lang.String,? extends java.lang.Object> resultSelector)
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
|
AthenaStartQueryExecution.Builder |
timeout(Duration timeout)
Timeout for the state machine.
|
AthenaStartQueryExecution.Builder |
workGroup(java.lang.String workGroup)
Configuration on how and where to save query.
|
public static AthenaStartQueryExecution.Builder create(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.AthenaStartQueryExecution.Builder
.public AthenaStartQueryExecution.Builder comment(java.lang.String comment)
Default: - No comment
comment
- An optional description for this state. This parameter is required.this
public AthenaStartQueryExecution.Builder heartbeat(Duration heartbeat)
Default: - None
heartbeat
- Timeout for the heartbeat. This parameter is required.this
public AthenaStartQueryExecution.Builder inputPath(java.lang.String inputPath)
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
Default: - The entire task input (JSON path '$')
inputPath
- JSONPath expression to select part of the state to be the input to this state. This parameter is required.this
public AthenaStartQueryExecution.Builder integrationPattern(IntegrationPattern integrationPattern)
You can control these AWS services using service integration patterns
Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.
integrationPattern
- AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.this
public AthenaStartQueryExecution.Builder outputPath(java.lang.String outputPath)
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
outputPath
- JSONPath expression to select select a portion of the state output to pass to the next state. This parameter is required.this
public AthenaStartQueryExecution.Builder resultPath(java.lang.String resultPath)
May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
Default: - Replaces the entire input with the result (JSON path '$')
resultPath
- JSONPath expression to indicate where to inject the state's output. This parameter is required.this
public AthenaStartQueryExecution.Builder resultSelector(java.util.Map<java.lang.String,? extends java.lang.Object> resultSelector)
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
Default: - None
resultSelector
- The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.this
public AthenaStartQueryExecution.Builder timeout(Duration timeout)
Default: - None
timeout
- Timeout for the state machine. This parameter is required.this
public AthenaStartQueryExecution.Builder queryString(java.lang.String queryString)
queryString
- Query that will be started. This parameter is required.this
public AthenaStartQueryExecution.Builder clientRequestToken(java.lang.String clientRequestToken)
Default: - No client request token
clientRequestToken
- Unique string string to ensure idempotence. This parameter is required.this
public AthenaStartQueryExecution.Builder queryExecutionContext(QueryExecutionContext queryExecutionContext)
Default: - No query execution context
queryExecutionContext
- Database within which query executes. This parameter is required.this
public AthenaStartQueryExecution.Builder resultConfiguration(ResultConfiguration resultConfiguration)
Default: - No result configuration
resultConfiguration
- Configuration on how and where to save query. This parameter is required.this
public AthenaStartQueryExecution.Builder workGroup(java.lang.String workGroup)
Default: - No work group
workGroup
- Configuration on how and where to save query. This parameter is required.this
public AthenaStartQueryExecution build()