Class Trigger

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

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

Determines when a function runs. Specify exactly one member.

See Also:
  • Method Details

    • fixedInterval

      public final FixedIntervalTrigger fixedInterval()

      Run the function at a fixed interval of content. This is the only trigger for a function that references media.transcript. Can't be used with a function that references media.contextual.

      Returns:
      Run the function at a fixed interval of content. This is the only trigger for a function that references media.transcript. Can't be used with a function that references media.contextual.
    • perShot

      public final ShotTrigger perShot()

      Run the function once for each shot that Elemental Inference detects. Can't be used with a function that references media.transcript or media.clip.

      Returns:
      Run the function once for each shot that Elemental Inference detects. Can't be used with a function that references media.transcript or media.clip.
    • perScene

      public final SceneTrigger perScene()

      Run the function once for each scene boundary that a contextual metadata output reports. Requires contextualMetadataSettings. Can't be used with a function that references media.transcript or media.clip.

      Returns:
      Run the function once for each scene boundary that a contextual metadata output reports. Requires contextualMetadataSettings. Can't be used with a function that references media.transcript or media.clip.
    • perClip

      public final ClipTrigger perClip()

      Run the function once for each clip that an event clipping output detects. Requires clippingSettings. Can't be used with a function that references media.transcript or media.contextual.

      Returns:
      Run the function once for each clip that an event clipping output detects. Requires clippingSettings. Can't be used with a function that references media.transcript or media.contextual.
    • toBuilder

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

      public static Trigger.Builder builder()
    • serializableBuilderClass

      public static Class<? extends Trigger.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)
    • fromFixedInterval

      public static Trigger fromFixedInterval(FixedIntervalTrigger fixedInterval)
      Create an instance of this class with fixedInterval() initialized to the given value.

      Run the function at a fixed interval of content. This is the only trigger for a function that references media.transcript. Can't be used with a function that references media.contextual.

      Parameters:
      fixedInterval - Run the function at a fixed interval of content. This is the only trigger for a function that references media.transcript. Can't be used with a function that references media.contextual.
    • fromFixedInterval

      public static Trigger fromFixedInterval(Consumer<FixedIntervalTrigger.Builder> fixedInterval)
      Create an instance of this class with fixedInterval() initialized to the given value.

      Run the function at a fixed interval of content. This is the only trigger for a function that references media.transcript. Can't be used with a function that references media.contextual.

      Parameters:
      fixedInterval - Run the function at a fixed interval of content. This is the only trigger for a function that references media.transcript. Can't be used with a function that references media.contextual.
    • fromPerShot

      public static Trigger fromPerShot(ShotTrigger perShot)
      Create an instance of this class with perShot() initialized to the given value.

      Run the function once for each shot that Elemental Inference detects. Can't be used with a function that references media.transcript or media.clip.

      Parameters:
      perShot - Run the function once for each shot that Elemental Inference detects. Can't be used with a function that references media.transcript or media.clip.
    • fromPerShot

      public static Trigger fromPerShot(Consumer<ShotTrigger.Builder> perShot)
      Create an instance of this class with perShot() initialized to the given value.

      Run the function once for each shot that Elemental Inference detects. Can't be used with a function that references media.transcript or media.clip.

      Parameters:
      perShot - Run the function once for each shot that Elemental Inference detects. Can't be used with a function that references media.transcript or media.clip.
    • fromPerScene

      public static Trigger fromPerScene(SceneTrigger perScene)
      Create an instance of this class with perScene() initialized to the given value.

      Run the function once for each scene boundary that a contextual metadata output reports. Requires contextualMetadataSettings. Can't be used with a function that references media.transcript or media.clip.

      Parameters:
      perScene - Run the function once for each scene boundary that a contextual metadata output reports. Requires contextualMetadataSettings. Can't be used with a function that references media.transcript or media.clip.
    • fromPerScene

      public static Trigger fromPerScene(Consumer<SceneTrigger.Builder> perScene)
      Create an instance of this class with perScene() initialized to the given value.

      Run the function once for each scene boundary that a contextual metadata output reports. Requires contextualMetadataSettings. Can't be used with a function that references media.transcript or media.clip.

      Parameters:
      perScene - Run the function once for each scene boundary that a contextual metadata output reports. Requires contextualMetadataSettings. Can't be used with a function that references media.transcript or media.clip.
    • fromPerClip

      public static Trigger fromPerClip(ClipTrigger perClip)
      Create an instance of this class with perClip() initialized to the given value.

      Run the function once for each clip that an event clipping output detects. Requires clippingSettings. Can't be used with a function that references media.transcript or media.contextual.

      Parameters:
      perClip - Run the function once for each clip that an event clipping output detects. Requires clippingSettings. Can't be used with a function that references media.transcript or media.contextual.
    • fromPerClip

      public static Trigger fromPerClip(Consumer<ClipTrigger.Builder> perClip)
      Create an instance of this class with perClip() initialized to the given value.

      Run the function once for each clip that an event clipping output detects. Requires clippingSettings. Can't be used with a function that references media.transcript or media.contextual.

      Parameters:
      perClip - Run the function once for each clip that an event clipping output detects. Requires clippingSettings. Can't be used with a function that references media.transcript or media.contextual.
    • type

      public Trigger.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be Trigger.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be Trigger.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.
    • 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.