Package software.amazon.awssdk.services.kinesis.model

Class StreamDescription

java.lang.Object

software.amazon.awssdk.services.kinesis.model.StreamDescription

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<StreamDescription.Builder,StreamDescription>

@Generated("software.amazon.awssdk:codegen")
public class StreamDescription
extends Object
implements StructuredPojo, ToCopyableBuilder<StreamDescription.Builder,StreamDescription>

Represents the output for DescribeStream.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StreamDescription.Builder

Method Summary

Modifier and Type	Method	Description
static StreamDescription.Builder	builder()
List<EnhancedMetrics>	enhancedMonitoring()	Represents the current enhanced monitoring settings of the stream.
boolean	equals(Object obj)
int	hashCode()
Boolean	hasMoreShards()	If set to true, more shards in the stream are available to describe.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
Integer	retentionPeriodHours()	The current retention period, in hours.
static Class<? extends StreamDescription.Builder>	serializableBuilderClass()
List<Shard>	shards()	The shards that comprise the stream.
String	streamARN()	The Amazon Resource Name (ARN) for the stream being described.
Date	streamCreationTimestamp()	The approximate time that the stream was created.
String	streamName()	The name of the stream being described.
String	streamStatus()	The current status of the stream being described.
StreamDescription.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

streamName

public String streamName()

The name of the stream being described.

Returns:

The name of the stream being described.

streamARN

public String streamARN()

The Amazon Resource Name (ARN) for the stream being described.

Returns:

The Amazon Resource Name (ARN) for the stream being described.

streamStatus

public String streamStatus()

The current status of the stream being described. The stream status is one of the following states:

• CREATING - The stream is being created. Amazon Kinesis immediately returns and sets StreamStatus to CREATING.

• DELETING - The stream is being deleted. The specified stream is in the DELETING state until Amazon Kinesis completes the deletion.

• ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

• UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

Returns:

The current status of the stream being described. The stream status is one of the following states:

• CREATING - The stream is being created. Amazon Kinesis immediately returns and sets StreamStatus to CREATING.

• DELETING - The stream is being deleted. The specified stream is in the DELETING state until Amazon Kinesis completes the deletion.

• ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

• UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

See Also:

StreamStatus

shards

public List<Shard> shards()

The shards that comprise the stream.

Returns:

The shards that comprise the stream.

hasMoreShards

public Boolean hasMoreShards()

If set to true, more shards in the stream are available to describe.

Returns:

If set to true, more shards in the stream are available to describe.

retentionPeriodHours

public Integer retentionPeriodHours()

The current retention period, in hours.

Returns:

The current retention period, in hours.

streamCreationTimestamp

public Date streamCreationTimestamp()

The approximate time that the stream was created.

Returns:

The approximate time that the stream was created.

enhancedMonitoring

public List<EnhancedMetrics> enhancedMonitoring()

Represents the current enhanced monitoring settings of the stream.

Returns:

Represents the current enhanced monitoring settings of the stream.

toBuilder

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

Returns:

a builder for type T

builder

public static StreamDescription.Builder builder()

serializableBuilderClass

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

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.