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(value="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 and Description
static interface	StreamInfo.Builder

Method Summary

Modifier and Type	Method and 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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsKeyId() The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video Streams uses to encrypt data on the stream.
String	mediaType() The MediaType of the stream.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	version() The version of the stream.

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

deviceName

public 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 String streamName()

The name of the stream.

Returns:

The name of the stream.

streamARN

public String streamARN()

The Amazon Resource Name (ARN) of the stream.

Returns:

The Amazon Resource Name (ARN) of the stream.

mediaType

public String mediaType()

The MediaType of the stream.

Returns:

The MediaType of the stream.

kmsKeyId

public String kmsKeyId()

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

Returns:

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

version

public String version()

The version of the stream.

Returns:

The version of the stream.

status

public 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 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 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 Integer dataRetentionInHours()

How long the stream retains data, in hours.

Returns:

How long the stream retains data, in hours.

toBuilder

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

Returns:

a builder for type T

builder

public static StreamInfo.Builder builder()

serializableBuilderClass

public static Class<? extends StreamInfo.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public 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.