Class FrameSettings

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

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

The frames that a function receives in media.frames on each run: which frames, how many, and at what size. Elemental Inference applies these settings only to a function that references media.frames.

When you add or change the function output, Elemental Inference estimates the size of the frames and rejects settings whose frames won't fit in one model request. To send more frames in each request, specify a smaller frameSize.

See Also:
  • Method Details

    • frameSampling

      public final FrameSamplingStrategy frameSampling()

      The method for choosing which frames to send.

      Returns:
      The method for choosing which frames to send.
    • frameSize

      public final FrameSize frameSize()

      The size to resize each frame to. If you omit this structure, frames keep their source size. Smaller frames reduce the size of the model request.

      Returns:
      The size to resize each frame to. If you omit this structure, frames keep their source size. Smaller frames reduce the size of the model request.
    • toBuilder

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

      public static FrameSettings.Builder builder()
    • serializableBuilderClass

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