Class SequentialExecutorConfiguration

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

The configuration for a SEQUENTIAL_EXECUTOR function. A SEQUENTIAL_EXECUTOR runs a sequence of child functions in order, passing data between steps through temporary data. For more information, see SEQUENTIAL_EXECUTOR in the MediaTailor User Guide.

See Also:

  • Method Details

    • runtime

      public final RuntimeType runtime()

      The expression language used to evaluate expressions in the function configuration. Set this to JSONata.

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

      Returns:
      The expression language used to evaluate expressions in the function configuration. Set this to JSONata.
      See Also:

    • runtimeAsString

      public final String runtimeAsString()

      The expression language used to evaluate expressions in the function configuration. Set this to JSONata.

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

      Returns:
      The expression language used to evaluate expressions in the function configuration. Set this to JSONata.
      See Also:

    • hasOutput

      public final boolean hasOutput()
      For responses, this returns true if the service returned a value for the Output property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • output

      public final Map<String,String> output()

      An optional map of output bindings that controls which bindings the sequence commits to the session state after all steps complete. If omitted, MediaTailor commits all accumulated output bindings from all child steps.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOutput() method.

      Returns:
      An optional map of output bindings that controls which bindings the sequence commits to the session state after all steps complete. If omitted, MediaTailor commits all accumulated output bindings from all child steps.

    • hasFunctionList

      public final boolean hasFunctionList()
      For responses, this returns true if the service returned a value for the FunctionList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • functionList

      public final List<FunctionRef> functionList()

      An ordered list of 1 to 10 steps. Each step specifies a child function to execute and an optional run condition expression that controls whether the step runs. MediaTailor executes steps in order, passing data between steps through temporary data.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFunctionList() method.

      Returns:
      An ordered list of 1 to 10 steps. Each step specifies a child function to execute and an optional run condition expression that controls whether the step runs. MediaTailor executes steps in order, passing data between steps through temporary data.

    • timeoutMilliseconds

      public final Integer timeoutMilliseconds()

      The maximum time, in milliseconds, for the entire sequence to complete. This timeout covers all steps, including any HTTP calls made by child functions. If the sequence exceeds this timeout, MediaTailor discards all output from the sequence and proceeds with default behavior.

      Returns:
      The maximum time, in milliseconds, for the entire sequence to complete. This timeout covers all steps, including any HTTP calls made by child functions. If the sequence exceeds this timeout, MediaTailor discards all output from the sequence and proceeds with default behavior.

    • toBuilder

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

    • builder

      public static SequentialExecutorConfiguration.Builder builder()

    • serializableBuilderClass

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