Class JournalKinesisStreamDescription
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the QLDB journal stream.builder()
final Instant
The date and time, in epoch time format, when the QLDB journal stream was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ErrorCause
The error message that describes the reason that a stream has a status ofIMPAIRED
orFAILED
.final String
The error message that describes the reason that a stream has a status ofIMPAIRED
orFAILED
.final Instant
The exclusive date and time that specifies when the stream ends.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Instant
The inclusive start date and time from which to start streaming journal data.final KinesisConfiguration
The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.final String
The name of the ledger.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.static Class
<? extends JournalKinesisStreamDescription.Builder> final StreamStatus
status()
The current state of the QLDB journal stream.final String
The current state of the QLDB journal stream.final String
streamId()
The UUID (represented in Base62-encoded text) of the QLDB journal stream.final String
The user-defined name of the QLDB journal stream.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
ledgerName
The name of the ledger.
- Returns:
- The name of the ledger.
-
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
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
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
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
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
The Amazon Resource Name (ARN) of the QLDB journal stream.
- Returns:
- The Amazon Resource Name (ARN) of the QLDB journal stream.
-
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 returnStreamStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current state of the QLDB journal stream.
- See Also:
-
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 returnStreamStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current state of the QLDB journal stream.
- See Also:
-
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
The error message that describes the reason that a stream has a status of
IMPAIRED
orFAILED
. 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 returnErrorCause.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromerrorCauseAsString()
.- Returns:
- The error message that describes the reason that a stream has a status of
IMPAIRED
orFAILED
. This is not applicable to streams that have other status values. - See Also:
-
errorCauseAsString
The error message that describes the reason that a stream has a status of
IMPAIRED
orFAILED
. 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 returnErrorCause.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromerrorCauseAsString()
.- Returns:
- The error message that describes the reason that a stream has a status of
IMPAIRED
orFAILED
. This is not applicable to streams that have other status values. - See Also:
-
streamName
The user-defined name of the QLDB journal stream.
- Returns:
- The user-defined name of the QLDB journal stream.
-
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 interfaceToCopyableBuilder<JournalKinesisStreamDescription.Builder,
JournalKinesisStreamDescription> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-