Class CompositionThumbnailConfiguration
- java.lang.Object
-
- software.amazon.awssdk.services.ivsrealtime.model.CompositionThumbnailConfiguration
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<CompositionThumbnailConfiguration.Builder,CompositionThumbnailConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class CompositionThumbnailConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CompositionThumbnailConfiguration.Builder,CompositionThumbnailConfiguration>
An object representing a configuration of thumbnails for recorded video for a Composition.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCompositionThumbnailConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CompositionThumbnailConfiguration.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasStorage()For responses, this returns true if the service returned a value for the Storage property.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CompositionThumbnailConfiguration.Builder>serializableBuilderClass()List<ThumbnailStorageType>storage()Indicates the format in which thumbnails are recorded.List<String>storageAsStrings()Indicates the format in which thumbnails are recorded.IntegertargetIntervalSeconds()The targeted thumbnail-generation interval in seconds.CompositionThumbnailConfiguration.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
targetIntervalSeconds
public final Integer targetIntervalSeconds()
The targeted thumbnail-generation interval in seconds. Default: 60.
- Returns:
- The targeted thumbnail-generation interval in seconds. Default: 60.
-
storage
public final List<ThumbnailStorageType> storage()
Indicates the format in which thumbnails are recorded.
SEQUENTIALrecords all generated thumbnails in a serial manner, to the media/thumbnails/(width)x(height) directory, where (width) and (height) are the width and height of the thumbnail.LATESTsaves the latest thumbnail in media/latest_thumbnail/(width)x(height)/thumb.jpg and overwrites it at the interval specified bytargetIntervalSeconds. You can enable bothSEQUENTIALandLATEST. Default:SEQUENTIAL.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasStorage()method.- Returns:
- Indicates the format in which thumbnails are recorded.
SEQUENTIALrecords all generated thumbnails in a serial manner, to the media/thumbnails/(width)x(height) directory, where (width) and (height) are the width and height of the thumbnail.LATESTsaves the latest thumbnail in media/latest_thumbnail/(width)x(height)/thumb.jpg and overwrites it at the interval specified bytargetIntervalSeconds. You can enable bothSEQUENTIALandLATEST. Default:SEQUENTIAL.
-
hasStorage
public final boolean hasStorage()
For responses, this returns true if the service returned a value for the Storage property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
storageAsStrings
public final List<String> storageAsStrings()
Indicates the format in which thumbnails are recorded.
SEQUENTIALrecords all generated thumbnails in a serial manner, to the media/thumbnails/(width)x(height) directory, where (width) and (height) are the width and height of the thumbnail.LATESTsaves the latest thumbnail in media/latest_thumbnail/(width)x(height)/thumb.jpg and overwrites it at the interval specified bytargetIntervalSeconds. You can enable bothSEQUENTIALandLATEST. Default:SEQUENTIAL.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasStorage()method.- Returns:
- Indicates the format in which thumbnails are recorded.
SEQUENTIALrecords all generated thumbnails in a serial manner, to the media/thumbnails/(width)x(height) directory, where (width) and (height) are the width and height of the thumbnail.LATESTsaves the latest thumbnail in media/latest_thumbnail/(width)x(height)/thumb.jpg and overwrites it at the interval specified bytargetIntervalSeconds. You can enable bothSEQUENTIALandLATEST. Default:SEQUENTIAL.
-
toBuilder
public CompositionThumbnailConfiguration.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CompositionThumbnailConfiguration.Builder,CompositionThumbnailConfiguration>
-
builder
public static CompositionThumbnailConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends CompositionThumbnailConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-