software.amazon.awssdk.services.chimesdkmediapipelines.model

Class MediaStreamPipeline

java.lang.Object

software.amazon.awssdk.services.chimesdkmediapipelines.model.MediaStreamPipeline

All Implemented Interfaces:

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

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

Structure that contains the settings for a media stream pipeline.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MediaStreamPipeline.Builder

Method Summary

Modifier and Type	Method and Description
static MediaStreamPipeline.Builder	builder()
Instant	createdTimestamp() The time at which the media stream pipeline was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSinks() For responses, this returns true if the service returned a value for the Sinks property.
boolean	hasSources() For responses, this returns true if the service returned a value for the Sources property.
String	mediaPipelineArn() The ARN of the media stream pipeline.
String	mediaPipelineId() The ID of the media stream pipeline
List<SdkField<?>>	sdkFields()
static Class<? extends MediaStreamPipeline.Builder>	serializableBuilderClass()
List<MediaStreamSink>	sinks() The media stream pipeline's data sinks.
List<MediaStreamSource>	sources() The media stream pipeline's data sources.
MediaPipelineStatus	status() The status of the media stream pipeline.
String	statusAsString() The status of the media stream pipeline.
MediaStreamPipeline.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Instant	updatedTimestamp() The time at which the media stream pipeline was updated.

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

mediaPipelineId

public final String mediaPipelineId()

The ID of the media stream pipeline

Returns:

The ID of the media stream pipeline

mediaPipelineArn

public final String mediaPipelineArn()

The ARN of the media stream pipeline.

Returns:

The ARN of the media stream pipeline.

createdTimestamp

public final Instant createdTimestamp()

The time at which the media stream pipeline was created.

Returns:

The time at which the media stream pipeline was created.

updatedTimestamp

public final Instant updatedTimestamp()

The time at which the media stream pipeline was updated.

Returns:

The time at which the media stream pipeline was updated.

status

public final MediaPipelineStatus status()

The status of the media stream pipeline.

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

Returns:

The status of the media stream pipeline.

See Also:

MediaPipelineStatus

statusAsString

public final String statusAsString()

The status of the media stream pipeline.

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

Returns:

The status of the media stream pipeline.

See Also:

MediaPipelineStatus

hasSources

public final boolean hasSources()

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

sources

public final List<MediaStreamSource> sources()

The media stream pipeline's data sources.

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

Returns:

The media stream pipeline's data sources.

hasSinks

public final boolean hasSinks()

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

sinks

public final List<MediaStreamSink> sinks()

The media stream pipeline's data sinks.

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

Returns:

The media stream pipeline's data sinks.

toBuilder

public MediaStreamPipeline.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MediaStreamPipeline.Builder,MediaStreamPipeline>

builder

public static MediaStreamPipeline.Builder builder()

serializableBuilderClass

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