Class ConcurrentExecutorConfiguration

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

The configuration for a CONCURRENT_EXECUTOR function. A CONCURRENT_EXECUTOR runs a set of child functions in parallel, up to a maximum concurrency, and combines their output when all functions complete. For more information about functions, see Working with functions 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()

      A map of output bindings that controls which bindings the executor commits to the session state after all child functions complete. Each key is a namespaced output path, and each value is an expression that MediaTailor evaluates against the combined results of the child functions.

      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:
      A map of output bindings that controls which bindings the executor commits to the session state after all child functions complete. Each key is a namespaced output path, and each value is an expression that MediaTailor evaluates against the combined results of the child functions.

    • 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()

      The list of child functions that MediaTailor runs in parallel. Each entry specifies a child function to execute and an optional run condition expression that controls whether the function runs.

      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:
      The list of child functions that MediaTailor runs in parallel. Each entry specifies a child function to execute and an optional run condition expression that controls whether the function runs.

    • timeoutMilliseconds

      public final Integer timeoutMilliseconds()

      The maximum time, in milliseconds, for all child functions to complete. This timeout covers every function in the list, including any HTTP calls the child functions make. If the executor exceeds this timeout, MediaTailor discards all output from the executor and proceeds with default behavior.

      Returns:
      The maximum time, in milliseconds, for all child functions to complete. This timeout covers every function in the list, including any HTTP calls the child functions make. If the executor exceeds this timeout, MediaTailor discards all output from the executor and proceeds with default behavior.

    • maxConcurrency

      public final Integer maxConcurrency()

      The maximum number of child functions that MediaTailor runs simultaneously. When the list contains more functions than MaxConcurrency, MediaTailor starts additional functions as running ones complete, so that no more than MaxConcurrency functions run at the same time.

      Returns:
      The maximum number of child functions that MediaTailor runs simultaneously. When the list contains more functions than MaxConcurrency, MediaTailor starts additional functions as running ones complete, so that no more than MaxConcurrency functions run at the same time.

    • toBuilder

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

    • builder

      public static ConcurrentExecutorConfiguration.Builder builder()

    • serializableBuilderClass

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