@Generated(value="software.amazon.awssdk:codegen") public final class StreamRecord extends Object implements SdkPojo, Serializable, ToCopyableBuilder<StreamRecord.Builder,StreamRecord>
A description of a single data modification that was performed on an item in a DynamoDB table.
Modifier and Type | Class and Description |
---|---|
static interface |
StreamRecord.Builder |
Modifier and Type | Method and Description |
---|---|
Instant |
approximateCreationDateTime()
The approximate date and time when the stream record was created, in UNIX epoch time format and rounded down to the closest second.
|
static StreamRecord.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasKeys()
For responses, this returns true if the service returned a value for the Keys property.
|
boolean |
hasNewImage()
For responses, this returns true if the service returned a value for the NewImage property.
|
boolean |
hasOldImage()
For responses, this returns true if the service returned a value for the OldImage property.
|
Map<String,AttributeValue> |
keys()
The primary key attribute(s) for the DynamoDB item that was modified.
|
Map<String,AttributeValue> |
newImage()
The item in the DynamoDB table as it appeared after it was modified.
|
Map<String,AttributeValue> |
oldImage()
The item in the DynamoDB table as it appeared before it was modified.
|
List<SdkField<?>> |
sdkFields() |
String |
sequenceNumber()
The sequence number of the stream record.
|
static Class<? extends StreamRecord.Builder> |
serializableBuilderClass() |
Long |
sizeBytes()
The size of the stream record, in bytes.
|
StreamViewType |
streamViewType()
The type of data from the modified DynamoDB item that was captured in this stream record:
|
String |
streamViewTypeAsString()
The type of data from the modified DynamoDB item that was captured in this stream record:
|
StreamRecord.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final Instant approximateCreationDateTime()
The approximate date and time when the stream record was created, in UNIX epoch time format and rounded down to the closest second.
public final boolean hasKeys()
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,AttributeValue> keys()
The primary key attribute(s) for the DynamoDB item that was modified.
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 hasKeys()
method.
public final boolean hasNewImage()
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,AttributeValue> newImage()
The item in the DynamoDB table as it appeared after it was modified.
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 hasNewImage()
method.
public final boolean hasOldImage()
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,AttributeValue> oldImage()
The item in the DynamoDB table as it appeared before it was modified.
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 hasOldImage()
method.
public final String sequenceNumber()
The sequence number of the stream record.
public final Long sizeBytes()
The size of the stream record, in bytes.
public final StreamViewType streamViewType()
The type of data from the modified DynamoDB item that was captured in this stream record:
KEYS_ONLY
- only the key attributes of the modified item.
NEW_IMAGE
- the entire item, as it appeared after it was modified.
OLD_IMAGE
- the entire item, as it appeared before it was modified.
NEW_AND_OLD_IMAGES
- both the new and the old item images of the item.
If the service returns an enum value that is not available in the current SDK version, streamViewType
will return StreamViewType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from streamViewTypeAsString()
.
KEYS_ONLY
- only the key attributes of the modified item.
NEW_IMAGE
- the entire item, as it appeared after it was modified.
OLD_IMAGE
- the entire item, as it appeared before it was modified.
NEW_AND_OLD_IMAGES
- both the new and the old item images of the item.
StreamViewType
public final String streamViewTypeAsString()
The type of data from the modified DynamoDB item that was captured in this stream record:
KEYS_ONLY
- only the key attributes of the modified item.
NEW_IMAGE
- the entire item, as it appeared after it was modified.
OLD_IMAGE
- the entire item, as it appeared before it was modified.
NEW_AND_OLD_IMAGES
- both the new and the old item images of the item.
If the service returns an enum value that is not available in the current SDK version, streamViewType
will return StreamViewType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from streamViewTypeAsString()
.
KEYS_ONLY
- only the key attributes of the modified item.
NEW_IMAGE
- the entire item, as it appeared after it was modified.
OLD_IMAGE
- the entire item, as it appeared before it was modified.
NEW_AND_OLD_IMAGES
- both the new and the old item images of the item.
StreamViewType
public StreamRecord.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<StreamRecord.Builder,StreamRecord>
public static StreamRecord.Builder builder()
public static Class<? extends StreamRecord.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2023. All rights reserved.