Thumbnails (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.elastictranscoder.model.Thumbnails

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Thumbnails.Builder,Thumbnails>

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

Thumbnails for videos.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Thumbnails.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Thumbnails.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`aspectRatio()`
`static Thumbnails.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`String`	`format()` The format of thumbnails, if any.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`interval()` The approximate number of seconds between thumbnails.
`String`	`maxHeight()` The maximum height of thumbnails in pixels.
`String`	`maxWidth()` The maximum width of thumbnails in pixels.
`String`	`paddingPolicy()` When you set `PaddingPolicy` to `Pad`, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that you specified for thumbnail `MaxWidth` and `MaxHeight` settings.
`String`	`resolution()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Thumbnails.Builder>`	`serializableBuilderClass()`
`String`	`sizingPolicy()` Specify one of the following values to control scaling of thumbnails:
`Thumbnails.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - format
```
public String format()
```
    The format of thumbnails, if any. Valid values are jpg and png.
    
    You specify whether you want Elastic Transcoder to create thumbnails when you create a job.
    
    Returns:
    
    The format of thumbnails, if any. Valid values are jpg and png.
    
    You specify whether you want Elastic Transcoder to create thumbnails when you create a job.
  - interval
```
public String interval()
```
    The approximate number of seconds between thumbnails. Specify an integer value.
    
    Returns:
    
    The approximate number of seconds between thumbnails. Specify an integer value.
  - resolution
```
public String resolution()
```
    To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.
    
    The width and height of thumbnail files in pixels. Specify a value in the format width x height where both values are even integers. The values cannot exceed the width and height that you specified in the Video:Resolution object.
    
    Returns:
    
    To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.
    
    The width and height of thumbnail files in pixels. Specify a value in the format width x height where both values are even integers. The values cannot exceed the width and height that you specified in the Video:Resolution object.
  - aspectRatio
```
public String aspectRatio()
```
    To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.
    
    The aspect ratio of thumbnails. Valid values include:
    
    auto, 1:1, 4:3, 3:2, 16:9
    
    If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the video in the output file.
    
    Returns:
    
    To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.
    
    The aspect ratio of thumbnails. Valid values include:
    
    auto, 1:1, 4:3, 3:2, 16:9
    
    If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the video in the output file.
  - maxWidth
```
public String maxWidth()
```
    The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 4096.
    
    Returns:
    
    The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 4096.
  - maxHeight
```
public String maxHeight()
```
    The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 3072.
    
    Returns:
    
    The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 3072.
  - sizingPolicy
```
public String sizingPolicy()
```
    Specify one of the following values to control scaling of thumbnails:
    - Fit: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding the other value.
    - Fill: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings and matches or exceeds the other value. Elastic Transcoder centers the image in thumbnails and then crops in the dimension (if any) that exceeds the maximum value.
    - Stretch: Elastic Transcoder stretches thumbnails to match the values that you specified for thumbnail MaxWidth and MaxHeight settings. If the relative proportions of the input video and thumbnails are different, the thumbnails will be distorted.
    - Keep: Elastic Transcoder does not scale thumbnails. If either dimension of the input video exceeds the values that you specified for thumbnail MaxWidth and MaxHeight settings, Elastic Transcoder crops the thumbnails.
    - ShrinkToFit: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of thumbnail MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.
    - ShrinkToFill: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.
    Returns:
    Specify one of the following values to control scaling of thumbnails:
    
    Fit: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding the other value.
    
    Fill: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings and matches or exceeds the other value. Elastic Transcoder centers the image in thumbnails and then crops in the dimension (if any) that exceeds the maximum value.
    
    Stretch: Elastic Transcoder stretches thumbnails to match the values that you specified for thumbnail MaxWidth and MaxHeight settings. If the relative proportions of the input video and thumbnails are different, the thumbnails will be distorted.
    
    Keep: Elastic Transcoder does not scale thumbnails. If either dimension of the input video exceeds the values that you specified for thumbnail MaxWidth and MaxHeight settings, Elastic Transcoder crops the thumbnails.
    
    ShrinkToFit: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of thumbnail MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.
    
    ShrinkToFill: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.
  - paddingPolicy
```
public String paddingPolicy()
```
    When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that you specified for thumbnail MaxWidth and MaxHeight settings.
    
    Returns:
    
    When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that you specified for thumbnail MaxWidth and MaxHeight settings.
  - toBuilder
```
public Thumbnails.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<Thumbnails.Builder,Thumbnails>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Thumbnails.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Thumbnails.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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.

Class Thumbnails

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

format

interval

resolution

aspectRatio

maxWidth

maxHeight

sizingPolicy

paddingPolicy

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields