Package software.amazon.awssdk.services.qldb.model

Class JournalKinesisStreamDescription

java.lang.Object

software.amazon.awssdk.services.qldb.model.JournalKinesisStreamDescription

All Implemented Interfaces:

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

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

Information about an Amazon QLDB journal stream, including the Amazon Resource Name (ARN), stream name, creation time, current status, and the parameters of the original stream creation request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JournalKinesisStreamDescription.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the QLDB journal stream.
static JournalKinesisStreamDescription.Builder	builder()
Instant	creationTime()	The date and time, in epoch time format, when the QLDB journal stream was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ErrorCause	errorCause()	The error message that describes the reason that a stream has a status of IMPAIRED or FAILED.
String	errorCauseAsString()	The error message that describes the reason that a stream has a status of IMPAIRED or FAILED.
Instant	exclusiveEndTime()	The exclusive date and time that specifies when the stream ends.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	inclusiveStartTime()	The inclusive start date and time from which to start streaming journal data.
KinesisConfiguration	kinesisConfiguration()	The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.
String	ledgerName()	The name of the ledger.
String	roleArn()	The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
List<SdkField<?>>	sdkFields()
static Class<? extends JournalKinesisStreamDescription.Builder>	serializableBuilderClass()
StreamStatus	status()	The current state of the QLDB journal stream.
String	statusAsString()	The current state of the QLDB journal stream.
String	streamId()	The UUID (represented in Base62-encoded text) of the QLDB journal stream.
String	streamName()	The user-defined name of the QLDB journal stream.
JournalKinesisStreamDescription.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

ledgerName

public final String ledgerName()

The name of the ledger.

Returns:

The name of the ledger.

creationTime

public final Instant creationTime()

The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

Returns:

The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

inclusiveStartTime

public final Instant inclusiveStartTime()

The inclusive start date and time from which to start streaming journal data.

Returns:

The inclusive start date and time from which to start streaming journal data.

exclusiveEndTime

public final Instant exclusiveEndTime()

The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.

Returns:

The exclusive date and time that specifies when the stream ends. If this parameter is undefined, the stream runs indefinitely until you cancel it.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.

Returns:

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.

streamId

public final String streamId()

The UUID (represented in Base62-encoded text) of the QLDB journal stream.

Returns:

The UUID (represented in Base62-encoded text) of the QLDB journal stream.

arn

public final String arn()

The Amazon Resource Name (ARN) of the QLDB journal stream.

Returns:

The Amazon Resource Name (ARN) of the QLDB journal stream.

status

public final StreamStatus status()

The current state of the QLDB journal stream.

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

Returns:

The current state of the QLDB journal stream.

See Also:

StreamStatus

statusAsString

public final String statusAsString()

The current state of the QLDB journal stream.

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

Returns:

The current state of the QLDB journal stream.

See Also:

StreamStatus

kinesisConfiguration

public final KinesisConfiguration kinesisConfiguration()

The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.

Returns:

The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.

errorCause

public final ErrorCause errorCause()

The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.

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

Returns:

The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.

See Also:

ErrorCause

errorCauseAsString

public final String errorCauseAsString()

The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.

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

Returns:

The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.

See Also:

ErrorCause

streamName

public final String streamName()

The user-defined name of the QLDB journal stream.

Returns:

The user-defined name of the QLDB journal stream.

toBuilder

public JournalKinesisStreamDescription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JournalKinesisStreamDescription.Builder,JournalKinesisStreamDescription>

builder

public static JournalKinesisStreamDescription.Builder builder()

serializableBuilderClass

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