Package software.amazon.awssdk.services.chimesdkmediapipelines.model

Class MediaCapturePipeline

java.lang.Object

software.amazon.awssdk.services.chimesdkmediapipelines.model.MediaCapturePipeline

All Implemented Interfaces:

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

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

A media pipeline object consisting of an ID, source type, source ARN, a sink type, a sink ARN, and a configuration object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MediaCapturePipeline.Builder

Method Summary

Modifier and Type	Method	Description
static MediaCapturePipeline.Builder	builder()
ChimeSdkMeetingConfiguration	chimeSdkMeetingConfiguration()	The configuration for a specified media pipeline.
Instant	createdTimestamp()	The time at which the pipeline was created, in ISO 8601 format.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	mediaPipelineArn()	The ARN of the media capture pipeline
String	mediaPipelineId()	The ID of a media pipeline.
List<SdkField<?>>	sdkFields()
static Class<? extends MediaCapturePipeline.Builder>	serializableBuilderClass()
String	sinkArn()	ARN of the destination to which the media artifacts are saved.
MediaPipelineSinkType	sinkType()	Destination type to which the media artifacts are saved.
String	sinkTypeAsString()	Destination type to which the media artifacts are saved.
String	sourceArn()	ARN of the source from which the media artifacts are saved.
MediaPipelineSourceType	sourceType()	Source type from which media artifacts are saved.
String	sourceTypeAsString()	Source type from which media artifacts are saved.
MediaPipelineStatus	status()	The status of the media pipeline.
String	statusAsString()	The status of the media pipeline.
MediaCapturePipeline.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	updatedTimestamp()	The time at which the pipeline was updated, in ISO 8601 format.

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 a media pipeline.

Returns:

The ID of a media pipeline.

mediaPipelineArn

public final String mediaPipelineArn()

The ARN of the media capture pipeline

Returns:

The ARN of the media capture pipeline

sourceType

public final MediaPipelineSourceType sourceType()

Source type from which media artifacts are saved. You must use ChimeMeeting.

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

Returns:

Source type from which media artifacts are saved. You must use ChimeMeeting.

See Also:

MediaPipelineSourceType

sourceTypeAsString

public final String sourceTypeAsString()

Source type from which media artifacts are saved. You must use ChimeMeeting.

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

Returns:

Source type from which media artifacts are saved. You must use ChimeMeeting.

See Also:

MediaPipelineSourceType

sourceArn

public final String sourceArn()

ARN of the source from which the media artifacts are saved.

Returns:

ARN of the source from which the media artifacts are saved.

status

public final MediaPipelineStatus status()

The status of the media 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 pipeline.

See Also:

MediaPipelineStatus

statusAsString

public final String statusAsString()

The status of the media 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 pipeline.

See Also:

MediaPipelineStatus

sinkType

public final MediaPipelineSinkType sinkType()

Destination type to which the media artifacts are saved. You must use an S3 Bucket.

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

Returns:

Destination type to which the media artifacts are saved. You must use an S3 Bucket.

See Also:

MediaPipelineSinkType

sinkTypeAsString

public final String sinkTypeAsString()

Destination type to which the media artifacts are saved. You must use an S3 Bucket.

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

Returns:

Destination type to which the media artifacts are saved. You must use an S3 Bucket.

See Also:

MediaPipelineSinkType

sinkArn

public final String sinkArn()

ARN of the destination to which the media artifacts are saved.

Returns:

ARN of the destination to which the media artifacts are saved.

createdTimestamp

public final Instant createdTimestamp()

The time at which the pipeline was created, in ISO 8601 format.

Returns:

The time at which the pipeline was created, in ISO 8601 format.

updatedTimestamp

public final Instant updatedTimestamp()

The time at which the pipeline was updated, in ISO 8601 format.

Returns:

The time at which the pipeline was updated, in ISO 8601 format.

chimeSdkMeetingConfiguration

public final ChimeSdkMeetingConfiguration chimeSdkMeetingConfiguration()

The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.

Returns:

The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.

toBuilder

public MediaCapturePipeline.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MediaCapturePipeline.Builder,MediaCapturePipeline>

builder

public static MediaCapturePipeline.Builder builder()

serializableBuilderClass

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