Class VerticalLayoutConfiguration

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

Defines the configuration settings for a vertical layout.

See Also:

  • Method Details

    • tileOrder

      public final TileOrder tileOrder()

      Sets the automatic ordering of the video tiles.

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

      Returns:
      Sets the automatic ordering of the video tiles.
      See Also:

    • tileOrderAsString

      public final String tileOrderAsString()

      Sets the automatic ordering of the video tiles.

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

      Returns:
      Sets the automatic ordering of the video tiles.
      See Also:

    • tilePosition

      public final VerticalTilePosition tilePosition()

      Sets the position of vertical tiles.

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

      Returns:
      Sets the position of vertical tiles.
      See Also:

    • tilePositionAsString

      public final String tilePositionAsString()

      Sets the position of vertical tiles.

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

      Returns:
      Sets the position of vertical tiles.
      See Also:

    • tileCount

      public final Integer tileCount()

      The maximum number of tiles to display.

      Returns:
      The maximum number of tiles to display.

    • tileAspectRatio

      public final String tileAspectRatio()

      Sets the aspect ratio of the video tiles, such as 16:9.

      Returns:
      Sets the aspect ratio of the video tiles, such as 16:9.

    • toBuilder

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

    • builder

      public static VerticalLayoutConfiguration.Builder builder()

    • serializableBuilderClass

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