Package software.amazon.awssdk.services.kinesisvideo.model

Class StreamInfo

java.lang.Object

software.amazon.awssdk.services.kinesisvideo.model.StreamInfo

All Implemented Interfaces:

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

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

An object describing a Kinesis video stream.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StreamInfo.Builder

Method Summary

Modifier and Type	Method	Description
static StreamInfo.Builder	builder()
Instant	creationTime()	A time stamp that indicates when the stream was created.
Integer	dataRetentionInHours()	How long the stream retains data, in hours.
String	deviceName()	The name of the device that is associated with the stream.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsKeyId()	The ID of the Key Management Service (KMS) key that Kinesis Video Streams uses to encrypt data on the stream.
String	mediaType()	The MediaType of the stream.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StreamInfo.Builder>	serializableBuilderClass()
Status	status()	The status of the stream.
String	statusAsString()	The status of the stream.
String	streamARN()	The Amazon Resource Name (ARN) of the stream.
String	streamName()	The name of the stream.
StreamInfo.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	version()	The version of the stream.

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

deviceName

public final String deviceName()

The name of the device that is associated with the stream.

Returns:

The name of the device that is associated with the stream.

streamName

public final String streamName()

The name of the stream.

Returns:

The name of the stream.

streamARN

public final String streamARN()

The Amazon Resource Name (ARN) of the stream.

Returns:

The Amazon Resource Name (ARN) of the stream.

mediaType

public final String mediaType()

The MediaType of the stream.

Returns:

The MediaType of the stream.

kmsKeyId

public final String kmsKeyId()

The ID of the Key Management Service (KMS) key that Kinesis Video Streams uses to encrypt data on the stream.

Returns:

The ID of the Key Management Service (KMS) key that Kinesis Video Streams uses to encrypt data on the stream.

version

public final String version()

The version of the stream.

Returns:

The version of the stream.

status

public final Status status()

The status of the stream.

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

Returns:

The status of the stream.

See Also:

Status

statusAsString

public final String statusAsString()

The status of the stream.

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

Returns:

The status of the stream.

See Also:

Status

creationTime

public final Instant creationTime()

A time stamp that indicates when the stream was created.

Returns:

A time stamp that indicates when the stream was created.

dataRetentionInHours

public final Integer dataRetentionInHours()

How long the stream retains data, in hours.

Returns:

How long the stream retains data, in hours.

toBuilder

public StreamInfo.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StreamInfo.Builder,StreamInfo>

builder

public static StreamInfo.Builder builder()

serializableBuilderClass

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