Package software.amazon.awssdk.services.ivs.model

Class IngestConfigurations

java.lang.Object

software.amazon.awssdk.services.ivs.model.IngestConfigurations

All Implemented Interfaces:

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

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

Object specifying the ingest configuration set up by the broadcaster, usually in an encoder.

Note: Use IngestConfigurations instead of IngestConfiguration (which is deprecated). If multitrack is not enabled, IngestConfiguration and IngestConfigurations contain the same data, namely information about track0 (the sole track). If multitrack is enabled, IngestConfiguration contains data for only the first track (track0) and IngestConfigurations contains data for all tracks.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IngestConfigurations.Builder

Method Summary

Modifier and Type	Method	Description
List<AudioConfiguration>	audioConfigurations()	Encoder settings for audio.
static IngestConfigurations.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAudioConfigurations()	For responses, this returns true if the service returned a value for the AudioConfigurations property.
int	hashCode()
boolean	hasVideoConfigurations()	For responses, this returns true if the service returned a value for the VideoConfigurations property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends IngestConfigurations.Builder>	serializableBuilderClass()
IngestConfigurations.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<VideoConfiguration>	videoConfigurations()	Encoder settings for video

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

hasAudioConfigurations

public final boolean hasAudioConfigurations()

For responses, this returns true if the service returned a value for the AudioConfigurations 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.

audioConfigurations

public final List<AudioConfiguration> audioConfigurations()

Encoder settings for audio.

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

Returns:

Encoder settings for audio.

hasVideoConfigurations

public final boolean hasVideoConfigurations()

For responses, this returns true if the service returned a value for the VideoConfigurations 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.

videoConfigurations

public final List<VideoConfiguration> videoConfigurations()

Encoder settings for video

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

Returns:

Encoder settings for video

toBuilder

public IngestConfigurations.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IngestConfigurations.Builder,IngestConfigurations>

builder

public static IngestConfigurations.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo