Class FrameSamplingStrategy

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

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

Specifies how Elemental Inference chooses frames from the media of each run, and how many frames it chooses. The media of a run is the interval, shot, scene, or clips that the run covers.

See Also:
  • Method Details

    • mode

      public final FrameSamplingMode mode()

      Which frames of the window to send: FIRST (the first frames), UNIFORM (frames spread evenly across the window), or LAST (the last frames).

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

      Returns:
      Which frames of the window to send: FIRST (the first frames), UNIFORM (frames spread evenly across the window), or LAST (the last frames).
      See Also:
    • modeAsString

      public final String modeAsString()

      Which frames of the window to send: FIRST (the first frames), UNIFORM (frames spread evenly across the window), or LAST (the last frames).

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

      Returns:
      Which frames of the window to send: FIRST (the first frames), UNIFORM (frames spread evenly across the window), or LAST (the last frames).
      See Also:
    • count

      public final Integer count()

      The number of frames to send on each run. Valid range: 1 to 64. The default is 1. Each frame adds to the size of the model request and to what the model charges for it.

      Returns:
      The number of frames to send on each run. Valid range: 1 to 64. The default is 1. Each frame adds to the size of the model request and to what the model charges for it.
    • toBuilder

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

      public static FrameSamplingStrategy.Builder builder()
    • serializableBuilderClass

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