@Generated(value="software.amazon.awssdk:codegen") public final class StreamJournalToKinesisRequest extends QldbRequest implements ToCopyableBuilder<StreamJournalToKinesisRequest.Builder,StreamJournalToKinesisRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
StreamJournalToKinesisRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static StreamJournalToKinesisRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
Instant |
exclusiveEndTime()
The exclusive date and time that specifies when the stream ends.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
Instant |
inclusiveStartTime()
The inclusive start date and time from which to start streaming journal data.
|
KinesisConfiguration |
kinesisConfiguration()
The configuration settings of the Kinesis Data Streams destination for your stream request.
|
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 StreamJournalToKinesisRequest.Builder> |
serializableBuilderClass() |
String |
streamName()
The name that you want to assign to the QLDB journal stream.
|
Map<String,String> |
tags()
The key-value pairs to add as tags to the stream that you want to create.
|
StreamJournalToKinesisRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String ledgerName()
The name of the ledger.
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.
To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the
iam:PassRole action on the IAM role resource. This is required for all journal stream requests.
To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the
iam:PassRole action on the IAM role resource. This is required for all journal stream
requests.
public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
public final 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.
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.
public final 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.
The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal
Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.
public final KinesisConfiguration kinesisConfiguration()
The configuration settings of the Kinesis Data Streams destination for your stream request.
public final 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.
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.
public StreamJournalToKinesisRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<StreamJournalToKinesisRequest.Builder,StreamJournalToKinesisRequest>toBuilder in class QldbRequestpublic static StreamJournalToKinesisRequest.Builder builder()
public static Class<? extends StreamJournalToKinesisRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.