Package software.amazon.awssdk.services.pipes.model

Class PipeTargetStateMachineParameters

java.lang.Object

software.amazon.awssdk.services.pipes.model.PipeTargetStateMachineParameters

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PipeTargetStateMachineParameters.Builder,PipeTargetStateMachineParameters>

@Generated("software.amazon.awssdk:codegen")
public final class PipeTargetStateMachineParameters
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PipeTargetStateMachineParameters.Builder,PipeTargetStateMachineParameters>

The parameters for using a Step Functions state machine as a target.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PipeTargetStateMachineParameters.Builder

Method Summary

Modifier and Type	Method	Description
static PipeTargetStateMachineParameters.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
PipeTargetInvocationType	invocationType()	Specify whether to invoke the Step Functions state machine synchronously or asynchronously.
String	invocationTypeAsString()	Specify whether to invoke the Step Functions state machine synchronously or asynchronously.
List<SdkField<?>>	sdkFields()
static Class<? extends PipeTargetStateMachineParameters.Builder>	serializableBuilderClass()
PipeTargetStateMachineParameters.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

invocationType

public final PipeTargetInvocationType invocationType()

Specify whether to invoke the Step Functions state machine synchronously or asynchronously.

• REQUEST_RESPONSE (default) - Invoke synchronously. For more information, see StartSyncExecution in the Step Functions API Reference.

  REQUEST_RESPONSE is not supported for STANDARD state machine workflows.

• FIRE_AND_FORGET - Invoke asynchronously. For more information, see StartExecution in the Step Functions API Reference.

For more information, see Invocation types in the Amazon EventBridge User Guide.

If the service returns an enum value that is not available in the current SDK version, invocationType will return PipeTargetInvocationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from invocationTypeAsString().

Returns:

Specify whether to invoke the Step Functions state machine synchronously or asynchronously.

• REQUEST_RESPONSE (default) - Invoke synchronously. For more information, see StartSyncExecution in the Step Functions API Reference.

  REQUEST_RESPONSE is not supported for STANDARD state machine workflows.

• FIRE_AND_FORGET - Invoke asynchronously. For more information, see StartExecution in the Step Functions API Reference.

For more information, see Invocation types in the Amazon EventBridge User Guide.

See Also:

PipeTargetInvocationType

invocationTypeAsString

public final String invocationTypeAsString()

Specify whether to invoke the Step Functions state machine synchronously or asynchronously.

• REQUEST_RESPONSE (default) - Invoke synchronously. For more information, see StartSyncExecution in the Step Functions API Reference.

  REQUEST_RESPONSE is not supported for STANDARD state machine workflows.

• FIRE_AND_FORGET - Invoke asynchronously. For more information, see StartExecution in the Step Functions API Reference.

For more information, see Invocation types in the Amazon EventBridge User Guide.

If the service returns an enum value that is not available in the current SDK version, invocationType will return PipeTargetInvocationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from invocationTypeAsString().

Returns:

Specify whether to invoke the Step Functions state machine synchronously or asynchronously.

• REQUEST_RESPONSE (default) - Invoke synchronously. For more information, see StartSyncExecution in the Step Functions API Reference.

  REQUEST_RESPONSE is not supported for STANDARD state machine workflows.

• FIRE_AND_FORGET - Invoke asynchronously. For more information, see StartExecution in the Step Functions API Reference.

For more information, see Invocation types in the Amazon EventBridge User Guide.

See Also:

PipeTargetInvocationType

toBuilder

public PipeTargetStateMachineParameters.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PipeTargetStateMachineParameters.Builder,PipeTargetStateMachineParameters>

builder

public static PipeTargetStateMachineParameters.Builder builder()

serializableBuilderClass

public static Class<? extends PipeTargetStateMachineParameters.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo