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:

  • Method Details

    • 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:

    • 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:

    • toBuilder

      public PipeTargetStateMachineParameters.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PipeTargetStateMachineParameters.Builder,PipeTargetStateMachineParameters>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.