Package software.amazon.awscdk.services.stepfunctions

Class SingleStateOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.stepfunctions.SingleStateOptions.Jsii$Proxy

All Implemented Interfaces:

AssignableStateOptions, JsonataCommonOptions, JsonPathCommonOptions, ParallelProps, SingleStateOptions, StateBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

SingleStateOptions

@Stability(Stable)
@Internal
public static final class SingleStateOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements SingleStateOptions

An implementation for SingleStateOptions

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.SingleStateOptions

SingleStateOptions.Builder, SingleStateOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(SingleStateOptions.Builder builder)	Constructor that initializes the object based on literal property values passed by the SingleStateOptions.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Map<String,Object>	getArguments()	Parameters pass a collection of key-value pairs, either static values or JSONata expressions that select from the input.
final Map<String,Object>	getAssign()	Workflow variables to store in this step.
final String	getComment()	A comment describing this state.
final String	getInputPath()	JSONPath expression to select part of the state to be the input to this state.
final String	getOutputPath()	JSONPath expression to select part of the state to be the output to this state.
final Object	getOutputs()	Used to specify and transform output from the state.
final Map<String,Object>	getParameters()	Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.
final String	getPrefixStates()	String to prefix all stateIds in the state machine with.
final QueryLanguage	getQueryLanguage()	The name of the query language used by the state.
final String	getResultPath()	JSONPath expression to indicate where to inject the state's output.
final Map<String,Object>	getResultSelector()	The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
final String	getStateId()	ID of newly created containing state.
final String	getStateName()	Optional name for this state.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(SingleStateOptions.Builder builder)

Constructor that initializes the object based on literal property values passed by the SingleStateOptions.Builder.

Method Details

getPrefixStates

public final String getPrefixStates()

Description copied from interface: SingleStateOptions

String to prefix all stateIds in the state machine with.

Default: stateId

Specified by:

getPrefixStates in interface SingleStateOptions

getStateId

public final String getStateId()

Description copied from interface: SingleStateOptions

ID of newly created containing state.

Default: Construct ID of the StateMachineFragment

Specified by:

getStateId in interface SingleStateOptions

getArguments

public final Map<String,Object> getArguments()

Description copied from interface: ParallelProps

Parameters pass a collection of key-value pairs, either static values or JSONata expressions that select from the input.

Default: No arguments

Specified by:

getArguments in interface ParallelProps

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/transforming-data.html

getParameters

public final Map<String,Object> getParameters()

Description copied from interface: ParallelProps

Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.

Default: No parameters

Specified by:

getParameters in interface ParallelProps

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-parameters

getResultPath

public final String getResultPath()

Description copied from interface: ParallelProps

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.

Default: $

Specified by:

getResultPath in interface ParallelProps

getResultSelector

public final Map<String,Object> getResultSelector()

Description copied from interface: ParallelProps

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.

Default: - None

Specified by:

getResultSelector in interface ParallelProps

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

getComment

public final String getComment()

Description copied from interface: StateBaseProps

A comment describing this state.

Default: No comment

Specified by:

getComment in interface StateBaseProps

getQueryLanguage

public final QueryLanguage getQueryLanguage()

Description copied from interface: StateBaseProps

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.

Default: - JSONPath

Specified by:

getQueryLanguage in interface StateBaseProps

getStateName

public final String getStateName()

Description copied from interface: StateBaseProps

Optional name for this state.

Default: - The construct ID will be used as state name

Specified by:

getStateName in interface StateBaseProps

getAssign

public final Map<String,Object> getAssign()

Description copied from interface: AssignableStateOptions

Workflow variables to store in this step.

Using workflow variables, you can store data in a step and retrieve that data in future steps.

Default: - Not assign variables

Specified by:

getAssign in interface AssignableStateOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

getInputPath

public final String getInputPath()

Description copied from interface: JsonPathCommonOptions

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 {}.

Default: $

Specified by:

getInputPath in interface JsonPathCommonOptions

getOutputPath

public final String getOutputPath()

Description copied from interface: JsonPathCommonOptions

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 {}.

Default: $

Specified by:

getOutputPath in interface JsonPathCommonOptions

getOutputs

public final Object getOutputs()

Description copied from interface: JsonataCommonOptions

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.

Default: - $states.result or $states.errorOutput

Specified by:

getOutputs in interface JsonataCommonOptions

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object