com.amazonaws.services.stepfunctions.model

Class StartSyncExecutionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.stepfunctions.model.StartSyncExecutionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartSyncExecutionRequest
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
StartSyncExecutionRequest()

Method Summary

Modifier and Type	Method and Description
StartSyncExecutionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getIncludedData() If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition.
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 X-Ray trace header.
int	hashCode()
void	setIncludedData(String includedData) If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition.
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 X-Ray trace header.
String	toString() Returns a string representation of this object.
StartSyncExecutionRequest	withIncludedData(IncludedData includedData) If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition.
StartSyncExecutionRequest	withIncludedData(String includedData) If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition.
StartSyncExecutionRequest	withInput(String input) The string that contains the JSON input data for the execution, for example:
StartSyncExecutionRequest	withName(String name) The name of the execution.
StartSyncExecutionRequest	withStateMachineArn(String stateMachineArn) The Amazon Resource Name (ARN) of the state machine to execute.
StartSyncExecutionRequest	withTraceHeader(String traceHeader) Passes the X-Ray trace header.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, 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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartSyncExecutionRequest

public StartSyncExecutionRequest()

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 StartSyncExecutionRequest 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.

Parameters:

name - The name of the execution.

getName

public String getName()

The name of the execution.

Returns:

The name of the execution.

withName

public StartSyncExecutionRequest withName(String name)

The name of the execution.

Parameters:

name - The name of the execution.

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 StartSyncExecutionRequest 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 X-Ray trace header. The trace header can also be passed in the request payload.

Parameters:

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

getTraceHeader

public String getTraceHeader()

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

Returns:

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

withTraceHeader

public StartSyncExecutionRequest withTraceHeader(String traceHeader)

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

Parameters:

traceHeader - Passes the 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.

setIncludedData

public void setIncludedData(String includedData)

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

Parameters:

includedData - If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

See Also:

IncludedData

getIncludedData

public String getIncludedData()

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

Returns:

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

See Also:

IncludedData

withIncludedData

public StartSyncExecutionRequest withIncludedData(String includedData)

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

Parameters:

includedData - If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

Returns:

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

See Also:

IncludedData

withIncludedData

public StartSyncExecutionRequest withIncludedData(IncludedData includedData)

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

Parameters:

includedData - If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

Returns:

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

See Also:

IncludedData

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 StartSyncExecutionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()