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

Interface JournalKinesisStreamDescription.Builder

All Superinterfaces:
Buildable, CopyableBuilder<JournalKinesisStreamDescription.Builder,JournalKinesisStreamDescription>, SdkBuilder<JournalKinesisStreamDescription.Builder,JournalKinesisStreamDescription>, SdkPojo
Enclosing class:
JournalKinesisStreamDescription
public static interface JournalKinesisStreamDescription.Builder extends SdkPojo, CopyableBuilder<JournalKinesisStreamDescription.Builder,JournalKinesisStreamDescription>

  • Method Details

    • ledgerName

      JournalKinesisStreamDescription.Builder ledgerName(String 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

      JournalKinesisStreamDescription.Builder creationTime(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.)

      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

      JournalKinesisStreamDescription.Builder inclusiveStartTime(Instant 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

      JournalKinesisStreamDescription.Builder exclusiveEndTime(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.

      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

      JournalKinesisStreamDescription.Builder roleArn(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.

      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

      JournalKinesisStreamDescription.Builder streamId(String 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

      JournalKinesisStreamDescription.Builder arn(String 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

      JournalKinesisStreamDescription.Builder status(String 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

      JournalKinesisStreamDescription.Builder status(StreamStatus 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 the KinesisConfiguration.Builder avoiding the need to create one manually via KinesisConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to kinesisConfiguration(KinesisConfiguration).

      Parameters:
      kinesisConfiguration - a consumer that will call methods on KinesisConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • errorCause

      JournalKinesisStreamDescription.Builder errorCause(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • errorCause

      JournalKinesisStreamDescription.Builder errorCause(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • streamName

      JournalKinesisStreamDescription.Builder streamName(String 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.