Interface JournalKinesisStreamDescription.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<JournalKinesisStreamDescription.Builder,
,JournalKinesisStreamDescription> SdkBuilder<JournalKinesisStreamDescription.Builder,
,JournalKinesisStreamDescription> SdkPojo
- Enclosing class:
JournalKinesisStreamDescription
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the QLDB journal stream.creationTime
(Instant creationTime) The date and time, in epoch time format, when the QLDB journal stream was created.errorCause
(String errorCause) The error message that describes the reason that a stream has a status ofIMPAIRED
orFAILED
.errorCause
(ErrorCause errorCause) The error message that describes the reason that a stream has a status ofIMPAIRED
orFAILED
.exclusiveEndTime
(Instant exclusiveEndTime) The exclusive date and time that specifies when the stream ends.inclusiveStartTime
(Instant inclusiveStartTime) The inclusive start date and time from which to start streaming journal data.kinesisConfiguration
(Consumer<KinesisConfiguration.Builder> kinesisConfiguration) The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.kinesisConfiguration
(KinesisConfiguration kinesisConfiguration) The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.ledgerName
(String ledgerName) The name of the ledger.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.The current state of the QLDB journal stream.status
(StreamStatus status) The current state of the QLDB journal stream.The UUID (represented in Base62-encoded text) of the QLDB journal stream.streamName
(String streamName) The user-defined name of the QLDB journal stream.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
ledgerName
The name of the ledger.
- Parameters:
ledgerName
- The name of the ledger.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.)
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
inclusiveStartTime
The inclusive start date and time from which to start streaming journal data.
- Parameters:
inclusiveStartTime
- The inclusive start date and time from which to start streaming journal data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
streamId
The UUID (represented in Base62-encoded text) of the QLDB journal stream.
- Parameters:
streamId
- The UUID (represented in Base62-encoded text) of the QLDB journal stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
arn
The Amazon Resource Name (ARN) of the QLDB journal stream.
- Parameters:
arn
- The Amazon Resource Name (ARN) of the QLDB journal stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
The current state of the QLDB journal stream.
- Parameters:
status
- The current state of the QLDB journal stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The current state of the QLDB journal stream.
- Parameters:
status
- The current state of the QLDB journal stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
kinesisConfiguration
JournalKinesisStreamDescription.Builder kinesisConfiguration(KinesisConfiguration kinesisConfiguration) The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.
- Parameters:
kinesisConfiguration
- The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kinesisConfiguration
default JournalKinesisStreamDescription.Builder kinesisConfiguration(Consumer<KinesisConfiguration.Builder> kinesisConfiguration) The configuration settings of the Amazon Kinesis Data Streams destination for a QLDB journal stream.
This is a convenience method that creates an instance of theKinesisConfiguration.Builder
avoiding the need to create one manually viaKinesisConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tokinesisConfiguration(KinesisConfiguration)
.- Parameters:
kinesisConfiguration
- a consumer that will call methods onKinesisConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
errorCause
- The error message that describes the reason that a stream has a status ofIMPAIRED
orFAILED
. This is not applicable to streams that have other status values.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
errorCause
- The error message that describes the reason that a stream has a status ofIMPAIRED
orFAILED
. This is not applicable to streams that have other status values.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
streamName
The user-defined name of the QLDB journal stream.
- Parameters:
streamName
- The user-defined name of the QLDB journal stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-