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

Class StreamSummary

java.lang.Object

software.amazon.awssdk.services.kinesis.model.StreamSummary

All Implemented Interfaces:

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

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

The summary of a stream.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StreamSummary.Builder

Method Summary

Modifier and Type	Method	Description
static StreamSummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StreamSummary.Builder>	serializableBuilderClass()
String	streamARN()	The ARN of the stream.
Instant	streamCreationTimestamp()	The timestamp at which the stream was created.
StreamModeDetails	streamModeDetails()	Returns the value of the StreamModeDetails property for this object.
String	streamName()	The name of a stream.
StreamStatus	streamStatus()	The status of the stream.
String	streamStatusAsString()	The status of the stream.
StreamSummary.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

streamName

public final String streamName()

The name of a stream.

Returns:

The name of a stream.

streamARN

public final String streamARN()

The ARN of the stream.

Returns:

The ARN of the stream.

streamStatus

public final StreamStatus streamStatus()

The status of the stream.

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

Returns:

The status of the stream.

See Also:

StreamStatus

streamStatusAsString

public final String streamStatusAsString()

The status of the stream.

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

Returns:

The status of the stream.

See Also:

StreamStatus

streamModeDetails

public final StreamModeDetails streamModeDetails()

Returns the value of the StreamModeDetails property for this object.

Returns:

The value of the StreamModeDetails property for this object.

streamCreationTimestamp

public final Instant streamCreationTimestamp()

The timestamp at which the stream was created.

Returns:

The timestamp at which the stream was created.

toBuilder

public StreamSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StreamSummary.Builder,StreamSummary>

builder

public static StreamSummary.Builder builder()

serializableBuilderClass

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