software.amazon.awssdk.services.ivs.model

Class RenditionConfiguration

java.lang.Object

software.amazon.awssdk.services.ivs.model.RenditionConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RenditionConfiguration.Builder,RenditionConfiguration>

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

Object that describes which renditions should be recorded for a stream.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RenditionConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static RenditionConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRenditions() For responses, this returns true if the service returned a value for the Renditions property.
List<RenditionConfigurationRendition>	renditions() Indicates which renditions are recorded for a stream, if renditionSelection is CUSTOM; otherwise, this field is irrelevant.
List<String>	renditionsAsStrings() Indicates which renditions are recorded for a stream, if renditionSelection is CUSTOM; otherwise, this field is irrelevant.
RenditionConfigurationRenditionSelection	renditionSelection() Indicates which set of renditions are recorded for a stream.
String	renditionSelectionAsString() Indicates which set of renditions are recorded for a stream.
List<SdkField<?>>	sdkFields()
static Class<? extends RenditionConfiguration.Builder>	serializableBuilderClass()
RenditionConfiguration.Builder	toBuilder()
String	toString() 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

renditionSelection

public final RenditionConfigurationRenditionSelection renditionSelection()

Indicates which set of renditions are recorded for a stream. For BASIC channels, the CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must be specified in the renditions field. Default: ALL.

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

Returns:

Indicates which set of renditions are recorded for a stream. For BASIC channels, the CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must be specified in the renditions field. Default: ALL.

See Also:

RenditionConfigurationRenditionSelection

renditionSelectionAsString

public final String renditionSelectionAsString()

Indicates which set of renditions are recorded for a stream. For BASIC channels, the CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must be specified in the renditions field. Default: ALL.

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

Returns:

Indicates which set of renditions are recorded for a stream. For BASIC channels, the CUSTOM value has no effect. If CUSTOM is specified, a set of renditions must be specified in the renditions field. Default: ALL.

See Also:

RenditionConfigurationRenditionSelection

renditions

public final List<RenditionConfigurationRendition> renditions()

Indicates which renditions are recorded for a stream, if renditionSelection is CUSTOM; otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3.

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 hasRenditions() method.

Returns:

Indicates which renditions are recorded for a stream, if renditionSelection is CUSTOM; otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3.

hasRenditions

public final boolean hasRenditions()

For responses, this returns true if the service returned a value for the Renditions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

renditionsAsStrings

public final List<String> renditionsAsStrings()

Indicates which renditions are recorded for a stream, if renditionSelection is CUSTOM; otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3.

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 hasRenditions() method.

Returns:

Indicates which renditions are recorded for a stream, if renditionSelection is CUSTOM; otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3.

toBuilder

public RenditionConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RenditionConfiguration.Builder,RenditionConfiguration>

builder

public static RenditionConfiguration.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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