software.amazon.awssdk.services.qldb.model

Interface StreamJournalToKinesisRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StreamJournalToKinesisRequest.Builder,StreamJournalToKinesisRequest>, QldbRequest.Builder, SdkBuilder<StreamJournalToKinesisRequest.Builder,StreamJournalToKinesisRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StreamJournalToKinesisRequest

public static interface StreamJournalToKinesisRequest.Builder
extends QldbRequest.Builder, SdkPojo, CopyableBuilder<StreamJournalToKinesisRequest.Builder,StreamJournalToKinesisRequest>

Method Summary

Modifier and Type	Method and Description
StreamJournalToKinesisRequest.Builder	exclusiveEndTime(Instant exclusiveEndTime) The exclusive date and time that specifies when the stream ends.
StreamJournalToKinesisRequest.Builder	inclusiveStartTime(Instant inclusiveStartTime) The inclusive start date and time from which to start streaming journal data.
default StreamJournalToKinesisRequest.Builder	kinesisConfiguration(Consumer<KinesisConfiguration.Builder> kinesisConfiguration) The configuration settings of the Kinesis Data Streams destination for your stream request.
StreamJournalToKinesisRequest.Builder	kinesisConfiguration(KinesisConfiguration kinesisConfiguration) The configuration settings of the Kinesis Data Streams destination for your stream request.
StreamJournalToKinesisRequest.Builder	ledgerName(String ledgerName) The name of the ledger.
StreamJournalToKinesisRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StreamJournalToKinesisRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StreamJournalToKinesisRequest.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.
StreamJournalToKinesisRequest.Builder	streamName(String streamName) The name that you want to assign to the QLDB journal stream.
StreamJournalToKinesisRequest.Builder	tags(Map<String,String> tags) The key-value pairs to add as tags to the stream that you want to create.

Methods inherited from interface software.amazon.awssdk.services.qldb.model.QldbRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

ledgerName

StreamJournalToKinesisRequest.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.

roleArn

StreamJournalToKinesisRequest.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.

tags

StreamJournalToKinesisRequest.Builder tags(Map<String,String> tags)

The key-value pairs to add as tags to the stream that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Parameters:

tags - The key-value pairs to add as tags to the stream that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

Returns:

Returns a reference to this object so that method calls can be chained together.

inclusiveStartTime

StreamJournalToKinesisRequest.Builder inclusiveStartTime(Instant inclusiveStartTime)

The inclusive start date and time from which to start streaming journal data. This parameter must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z

The InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime.

If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, QLDB effectively defaults it to the ledger's CreationDateTime.

Parameters:

inclusiveStartTime - The inclusive start date and time from which to start streaming journal data. This parameter must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z

The InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime.

If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, QLDB effectively defaults it to the ledger's CreationDateTime.

Returns:

Returns a reference to this object so that method calls can be chained together.

exclusiveEndTime

StreamJournalToKinesisRequest.Builder exclusiveEndTime(Instant exclusiveEndTime)

The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it.

The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z

Parameters:

exclusiveEndTime - The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it.

The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z

Returns:

Returns a reference to this object so that method calls can be chained together.

kinesisConfiguration

StreamJournalToKinesisRequest.Builder kinesisConfiguration(KinesisConfiguration kinesisConfiguration)

The configuration settings of the Kinesis Data Streams destination for your stream request.

Parameters:

kinesisConfiguration - The configuration settings of the Kinesis Data Streams destination for your stream request.

Returns:

Returns a reference to this object so that method calls can be chained together.

kinesisConfiguration

default StreamJournalToKinesisRequest.Builder kinesisConfiguration(Consumer<KinesisConfiguration.Builder> kinesisConfiguration)

The configuration settings of the Kinesis Data Streams destination for your stream request.

This is a convenience 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:

kinesisConfiguration(KinesisConfiguration)

streamName

StreamJournalToKinesisRequest.Builder streamName(String streamName)

The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream.

Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

Parameters:

streamName - The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream.

Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

StreamJournalToKinesisRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

StreamJournalToKinesisRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder