Class StepFunctionsParameters

java.lang.Object
software.amazon.awssdk.services.eventbridgev2.model.StepFunctionsParameters
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<StepFunctionsParameters.Builder,StepFunctionsParameters>
@Generated("software.amazon.awssdk:codegen") public final class StepFunctionsParameters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<StepFunctionsParameters.Builder,StepFunctionsParameters>

Step Functions invocation parameters for subscribers. Values are forwarded to the Step Functions StartExecution or StartSyncExecution API. Every string member accepts a literal or a JSONata expression (e.g. "{% $events.Data.executionName %}").

See Also:

  • Method Details

    • invocationType

      public final InvocationType invocationType()

      Selects StartExecution (EVENT) or StartSyncExecution (REQUEST_RESPONSE) at delivery.

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

      Returns:
      Selects StartExecution (EVENT) or StartSyncExecution (REQUEST_RESPONSE) at delivery.
      See Also:

    • invocationTypeAsString

      public final String invocationTypeAsString()

      Selects StartExecution (EVENT) or StartSyncExecution (REQUEST_RESPONSE) at delivery.

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

      Returns:
      Selects StartExecution (EVENT) or StartSyncExecution (REQUEST_RESPONSE) at delivery.
      See Also:

    • name

      public final String name()

      Name for the execution. Must be unique per account/region/state machine. Accepts JSONata expression.

      Returns:
      Name for the execution. Must be unique per account/region/state machine. Accepts JSONata expression.

    • traceHeader

      public final String traceHeader()

      X-Ray trace header for distributed tracing. Accepts JSONata expression.

      Returns:
      X-Ray trace header for distributed tracing. Accepts JSONata expression.

    • invocationTimeoutSeconds

      public final String invocationTimeoutSeconds()

      Timeout in seconds for each invocation of the target (1-30). String-typed (not integer) so the value may be a JSONata expression.

      Returns:
      Timeout in seconds for each invocation of the target (1-30). String-typed (not integer) so the value may be a JSONata expression.

    • toBuilder

      public StepFunctionsParameters.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<StepFunctionsParameters.Builder,StepFunctionsParameters>
      Returns:
      a builder for type T

    • builder

      public static StepFunctionsParameters.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StepFunctionsParameters.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.