software.amazon.awssdk.services.chimesdkmediapipelines.model

Class MediaInsightsPipeline

java.lang.Object

software.amazon.awssdk.services.chimesdkmediapipelines.model.MediaInsightsPipeline

All Implemented Interfaces:

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

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

A media pipeline that streams call analytics data.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MediaInsightsPipeline.Builder

Method Summary

Modifier and Type	Method and Description
static MediaInsightsPipeline.Builder	builder()
Instant	createdTimestamp() The time at which the media insights pipeline was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMediaInsightsRuntimeMetadata() For responses, this returns true if the service returned a value for the MediaInsightsRuntimeMetadata property.
KinesisVideoStreamRecordingSourceRuntimeConfiguration	kinesisVideoStreamRecordingSourceRuntimeConfiguration() The runtime configuration settings for a Kinesis recording video stream in a media insights pipeline.
KinesisVideoStreamSourceRuntimeConfiguration	kinesisVideoStreamSourceRuntimeConfiguration() The configuration settings for a Kinesis runtime video stream in a media insights pipeline.
String	mediaInsightsPipelineConfigurationArn() The ARN of a media insight pipeline's configuration settings.
Map<String,String>	mediaInsightsRuntimeMetadata() The runtime metadata of a media insights pipeline.
String	mediaPipelineArn() The ARN of a media insights pipeline.
String	mediaPipelineId() The ID of a media insights pipeline.
S3RecordingSinkRuntimeConfiguration	s3RecordingSinkRuntimeConfiguration() The runtime configuration of the Amazon S3 bucket that stores recordings in a media insights pipeline.
List<SdkField<?>>	sdkFields()
static Class<? extends MediaInsightsPipeline.Builder>	serializableBuilderClass()
MediaPipelineStatus	status() The status of a media insights pipeline.
String	statusAsString() The status of a media insights pipeline.
MediaInsightsPipeline.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

mediaPipelineId

public final String mediaPipelineId()

The ID of a media insights pipeline.

Returns:

The ID of a media insights pipeline.

mediaPipelineArn

public final String mediaPipelineArn()

The ARN of a media insights pipeline.

Returns:

The ARN of a media insights pipeline.

mediaInsightsPipelineConfigurationArn

public final String mediaInsightsPipelineConfigurationArn()

The ARN of a media insight pipeline's configuration settings.

Returns:

The ARN of a media insight pipeline's configuration settings.

status

public final MediaPipelineStatus status()

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

See Also:

MediaPipelineStatus

statusAsString

public final String statusAsString()

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

See Also:

MediaPipelineStatus

kinesisVideoStreamSourceRuntimeConfiguration

public final KinesisVideoStreamSourceRuntimeConfiguration kinesisVideoStreamSourceRuntimeConfiguration()

The configuration settings for a Kinesis runtime video stream in a media insights pipeline.

Returns:

The configuration settings for a Kinesis runtime video stream in a media insights pipeline.

hasMediaInsightsRuntimeMetadata

public final boolean hasMediaInsightsRuntimeMetadata()

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

mediaInsightsRuntimeMetadata

public final Map<String,String> mediaInsightsRuntimeMetadata()

The runtime metadata of a media insights pipeline.

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

Returns:

The runtime metadata of a media insights pipeline.

kinesisVideoStreamRecordingSourceRuntimeConfiguration

public final KinesisVideoStreamRecordingSourceRuntimeConfiguration kinesisVideoStreamRecordingSourceRuntimeConfiguration()

The runtime configuration settings for a Kinesis recording video stream in a media insights pipeline.

Returns:

The runtime configuration settings for a Kinesis recording video stream in a media insights pipeline.

s3RecordingSinkRuntimeConfiguration

public final S3RecordingSinkRuntimeConfiguration s3RecordingSinkRuntimeConfiguration()

The runtime configuration of the Amazon S3 bucket that stores recordings in a media insights pipeline.

Returns:

The runtime configuration of the Amazon S3 bucket that stores recordings in a media insights pipeline.

createdTimestamp

public final Instant createdTimestamp()

The time at which the media insights pipeline was created.

Returns:

The time at which the media insights pipeline was created.

toBuilder

public MediaInsightsPipeline.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MediaInsightsPipeline.Builder,MediaInsightsPipeline>

builder

public static MediaInsightsPipeline.Builder builder()

serializableBuilderClass

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