com.amazonaws.services.stepfunctions.model

Class StartExecutionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.stepfunctions.model.StartExecutionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartExecutionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartExecutionRequest()

Method Summary

Modifier and Type	Method and Description
StartExecutionRequest	clone()
boolean	equals(Object obj)
String	getInput() The string that contains the JSON input data for the execution, for example:
String	getName() The name of the execution.
String	getStateMachineArn() The Amazon Resource Name (ARN) of the state machine to execute.
String	getTraceHeader() Passes the AWS X-Ray trace header.
int	hashCode()
void	setInput(String input) The string that contains the JSON input data for the execution, for example:
void	setName(String name) The name of the execution.
void	setStateMachineArn(String stateMachineArn) The Amazon Resource Name (ARN) of the state machine to execute.
void	setTraceHeader(String traceHeader) Passes the AWS X-Ray trace header.
String	toString() Returns a string representation of this object.
StartExecutionRequest	withInput(String input) The string that contains the JSON input data for the execution, for example:
StartExecutionRequest	withName(String name) The name of the execution.
StartExecutionRequest	withStateMachineArn(String stateMachineArn) The Amazon Resource Name (ARN) of the state machine to execute.
StartExecutionRequest	withTraceHeader(String traceHeader) Passes the AWS X-Ray trace header.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartExecutionRequest

public StartExecutionRequest()

Method Detail

setStateMachineArn

public void setStateMachineArn(String stateMachineArn)

The Amazon Resource Name (ARN) of the state machine to execute.

Parameters:

stateMachineArn - The Amazon Resource Name (ARN) of the state machine to execute.

getStateMachineArn

public String getStateMachineArn()

The Amazon Resource Name (ARN) of the state machine to execute.

Returns:

The Amazon Resource Name (ARN) of the state machine to execute.

withStateMachineArn

public StartExecutionRequest withStateMachineArn(String stateMachineArn)

The Amazon Resource Name (ARN) of the state machine to execute.

Parameters:

stateMachineArn - The Amazon Resource Name (ARN) of the state machine to execute.

Returns:

Returns a reference to this object so that method calls can be chained together.

setName

public void setName(String name)

The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

• white space

• brackets < > { } [ ]

• wildcard characters ? *

• special characters " # % \ ^ | ~ ` $ & , ; : /

• control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Parameters:

name - The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

• white space

• brackets < > { } [ ]

• wildcard characters ? *

• special characters " # % \ ^ | ~ ` $ & , ; : /

• control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

getName

public String getName()

The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

• white space

• brackets < > { } [ ]

• wildcard characters ? *

• special characters " # % \ ^ | ~ ` $ & , ; : /

• control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Returns:

The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

• white space

• brackets < > { } [ ]

• wildcard characters ? *

• special characters " # % \ ^ | ~ ` $ & , ; : /

• control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

withName

public StartExecutionRequest withName(String name)

The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

• white space

• brackets < > { } [ ]

• wildcard characters ? *

• special characters " # % \ ^ | ~ ` $ & , ; : /

• control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Parameters:

name - The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

• white space

• brackets < > { } [ ]

• wildcard characters ? *

• special characters " # % \ ^ | ~ ` $ & , ; : /

• control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInput

public void setInput(String input)

The string that contains the JSON input data for the execution, for example:

"input": "{\"first_name\" : \"test\"}"

If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

Parameters:

input - The string that contains the JSON input data for the execution, for example:

"input": "{\"first_name\" : \"test\"}"

If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

getInput

public String getInput()

The string that contains the JSON input data for the execution, for example:

"input": "{\"first_name\" : \"test\"}"

If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

Returns:

The string that contains the JSON input data for the execution, for example:

"input": "{\"first_name\" : \"test\"}"

If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

withInput

public StartExecutionRequest withInput(String input)

The string that contains the JSON input data for the execution, for example:

"input": "{\"first_name\" : \"test\"}"

If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

Parameters:

input - The string that contains the JSON input data for the execution, for example:

"input": "{\"first_name\" : \"test\"}"

If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTraceHeader

public void setTraceHeader(String traceHeader)

Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

Parameters:

traceHeader - Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

getTraceHeader

public String getTraceHeader()

Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

Returns:

Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

withTraceHeader

public StartExecutionRequest withTraceHeader(String traceHeader)

Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

Parameters:

traceHeader - Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartExecutionRequest clone()

Overrides:

clone in class AmazonWebServiceRequest