Class AthenaGetQueryResultsProps.Builder
java.lang.Object
software.amazon.awscdk.services.stepfunctions.tasks.AthenaGetQueryResultsProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<AthenaGetQueryResultsProps>
- Enclosing interface:
AthenaGetQueryResultsProps
@Stability(Stable)
public static final class AthenaGetQueryResultsProps.Builder
extends Object
implements software.amazon.jsii.Builder<AthenaGetQueryResultsProps>
A builder for
AthenaGetQueryResultsProps
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionSets the value ofAssignableStateOptions.getAssign()
build()
Builds the configured instance.Sets the value ofStateBaseProps.getComment()
credentials
(Credentials credentials) Sets the value ofTaskStateBaseOptions.getCredentials()
Deprecated.use `heartbeatTimeout`heartbeatTimeout
(Timeout heartbeatTimeout) Sets the value ofTaskStateBaseOptions.getHeartbeatTimeout()
Sets the value ofJsonPathCommonOptions.getInputPath()
integrationPattern
(IntegrationPattern integrationPattern) Sets the value ofTaskStateBaseOptions.getIntegrationPattern()
maxResults
(Number maxResults) Sets the value ofAthenaGetQueryResultsProps.getMaxResults()
Sets the value ofAthenaGetQueryResultsProps.getNextToken()
outputPath
(String outputPath) Sets the value ofJsonPathCommonOptions.getOutputPath()
Sets the value ofJsonataCommonOptions.getOutputs()
queryExecutionId
(String queryExecutionId) Sets the value ofAthenaGetQueryResultsProps.getQueryExecutionId()
queryLanguage
(QueryLanguage queryLanguage) Sets the value ofStateBaseProps.getQueryLanguage()
resultPath
(String resultPath) Sets the value ofTaskStateBaseProps.getResultPath()
resultSelector
(Map<String, ? extends Object> resultSelector) Sets the value ofTaskStateBaseProps.getResultSelector()
Sets the value ofStateBaseProps.getStateName()
taskTimeout
(Timeout taskTimeout) Sets the value ofTaskStateBaseOptions.getTaskTimeout()
Deprecated.use `taskTimeout`
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
queryExecutionId
@Stability(Stable) public AthenaGetQueryResultsProps.Builder queryExecutionId(String queryExecutionId) Sets the value ofAthenaGetQueryResultsProps.getQueryExecutionId()
- Parameters:
queryExecutionId
- Query that will be retrieved. This parameter is required. Example value:adfsaf-23trf23-f23rt23
- Returns:
this
-
maxResults
Sets the value ofAthenaGetQueryResultsProps.getMaxResults()
- Parameters:
maxResults
- Max number of results.- Returns:
this
-
nextToken
Sets the value ofAthenaGetQueryResultsProps.getNextToken()
- Parameters:
nextToken
- Pagination token.- Returns:
this
-
resultPath
Sets the value ofTaskStateBaseProps.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(Stable) public AthenaGetQueryResultsProps.Builder resultSelector(Map<String, ? extends Object> resultSelector) Sets the value ofTaskStateBaseProps.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
-
comment
Sets the value ofStateBaseProps.getComment()
- Parameters:
comment
- A comment describing this state.- Returns:
this
-
queryLanguage
@Stability(Stable) public AthenaGetQueryResultsProps.Builder queryLanguage(QueryLanguage queryLanguage) Sets the value ofStateBaseProps.getQueryLanguage()
- Parameters:
queryLanguage
- The name of the query language used by the state. If the state does not contain aqueryLanguage
field, then it will use the query language specified in the top-levelqueryLanguage
field.- Returns:
this
-
stateName
Sets the value ofStateBaseProps.getStateName()
- Parameters:
stateName
- Optional name for this state.- Returns:
this
-
credentials
Sets the value ofTaskStateBaseOptions.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 AthenaGetQueryResultsProps.Builder heartbeat(Duration heartbeat) Deprecated.use `heartbeatTimeout`Sets the value ofTaskStateBaseOptions.getHeartbeat()
- Parameters:
heartbeat
- Timeout for the heartbeat.- Returns:
this
-
heartbeatTimeout
@Stability(Stable) public AthenaGetQueryResultsProps.Builder heartbeatTimeout(Timeout heartbeatTimeout) Sets the value ofTaskStateBaseOptions.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 AthenaGetQueryResultsProps.Builder integrationPattern(IntegrationPattern integrationPattern) Sets the value ofTaskStateBaseOptions.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
Sets the value ofTaskStateBaseOptions.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 AthenaGetQueryResultsProps.Builder timeout(Duration timeout) Deprecated.use `taskTimeout`Sets the value ofTaskStateBaseOptions.getTimeout()
- Parameters:
timeout
- Timeout for the task.- Returns:
this
-
assign
@Stability(Stable) public AthenaGetQueryResultsProps.Builder assign(Map<String, ? extends Object> assign) Sets the value ofAssignableStateOptions.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
-
inputPath
Sets the value ofJsonPathCommonOptions.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
-
outputPath
Sets the value ofJsonPathCommonOptions.getOutputPath()
- Parameters:
outputPath
- JSONPath expression to select part of the state to be the output to this state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.- Returns:
this
-
outputs
Sets the value ofJsonataCommonOptions.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
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<AthenaGetQueryResultsProps>
- Returns:
- a new instance of
AthenaGetQueryResultsProps
- Throws:
NullPointerException
- if any required attribute was not provided
-