software.amazon.awssdk.services.mediaconnect.model

Class MediaStreamSourceConfiguration

java.lang.Object

software.amazon.awssdk.services.mediaconnect.model.MediaStreamSourceConfiguration

All Implemented Interfaces:

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

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

The media stream that is associated with the source, and the parameters for that association.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MediaStreamSourceConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static MediaStreamSourceConfiguration.Builder	builder()
EncodingName	encodingName() The format that was used to encode the data.
String	encodingNameAsString() The format that was used to encode the data.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInputConfigurations() For responses, this returns true if the service returned a value for the InputConfigurations property.
List<InputConfiguration>	inputConfigurations() The transport parameters that are associated with an incoming media stream.
String	mediaStreamName() The name of the media stream.
List<SdkField<?>>	sdkFields()
static Class<? extends MediaStreamSourceConfiguration.Builder>	serializableBuilderClass()
MediaStreamSourceConfiguration.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

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

encodingName

public final EncodingName encodingName()

The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.

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

Returns:

The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.

See Also:

EncodingName

encodingNameAsString

public final String encodingNameAsString()

The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.

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

Returns:

The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.

See Also:

EncodingName

hasInputConfigurations

public final boolean hasInputConfigurations()

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

inputConfigurations

public final List<InputConfiguration> inputConfigurations()

The transport parameters that are associated with an incoming media stream.

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

Returns:

The transport parameters that are associated with an incoming media stream.

mediaStreamName

public final String mediaStreamName()

The name of the media stream.

Returns:

The name of the media stream.

toBuilder

public MediaStreamSourceConfiguration.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<MediaStreamSourceConfiguration.Builder,MediaStreamSourceConfiguration>

Returns:

a builder for type T

builder

public static MediaStreamSourceConfiguration.Builder builder()

serializableBuilderClass

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