Class FunctionConfig

java.lang.Object
software.amazon.awssdk.services.elementalinference.model.FunctionConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FunctionConfig.Builder,FunctionConfig>

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

The output configuration settings for a function. Use this structure to run a function on this feed. The name of the output is the name that you pass to GetMetadata to read the results.

Include the settings that the function's media context and trigger require. Elemental Inference ignores settings that neither uses. It also rejects settings whose frames are estimated to exceed the size of a single model request.

A feed that has an enabled function output must also have an enabled cropping, clipping, subtitling, or contextual metadata output. A feed that runs a function with a Bedrock target must specify an accessRoleArn.

See Also:
  • Method Details

    • functionArn

      public final String functionArn()

      The ARN of the function to run. The function must exist in the same account and the same Region as the feed.

      Returns:
      The ARN of the function to run. The function must exist in the same account and the same Region as the feed.
    • trigger

      public final Trigger trigger()

      Determines when the function runs.

      Returns:
      Determines when the function runs.
    • frameSettings

      public final FrameSettings frameSettings()

      The frames to send on each run: how many, which ones, and at what size. Applies to a function that references media.frames. If you omit this structure, Elemental Inference sends the first frame of the window, at its source size.

      Returns:
      The frames to send on each run: how many, which ones, and at what size. Applies to a function that references media.frames. If you omit this structure, Elemental Inference sends the first frame of the window, at its source size.
    • subtitlingSettings

      public final SubtitlingSettings subtitlingSettings()

      The smart subtitles output on this feed to read the transcript from. Required for a function that references media.transcript.

      Returns:
      The smart subtitles output on this feed to read the transcript from. Required for a function that references media.transcript.
    • contextualMetadataSettings

      public final ContextualMetadataSettings contextualMetadataSettings()

      The contextual metadata output on this feed to read scenes and classifications from. Required for a perScene trigger, and for a function that references media.contextual on a perShot trigger.

      Returns:
      The contextual metadata output on this feed to read scenes and classifications from. Required for a perScene trigger, and for a function that references media.contextual on a perShot trigger.
    • clippingSettings

      public final ClippingSettings clippingSettings()

      The event clipping output on this feed to read clips from. Required for a perClip trigger, and for a function that references media.clip.

      Returns:
      The event clipping output on this feed to read clips from. Required for a perClip trigger, and for a function that references media.clip.
    • toBuilder

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

      public static FunctionConfig.Builder builder()
    • serializableBuilderClass

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