StreamRecord (AWS Java SDK :: Services :: Amazon DynamoDB 2.16.67 API)

java.lang.Object
- software.amazon.awssdk.services.dynamodb.model.StreamRecord

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StreamRecord.Builder,StreamRecord>
```
@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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StreamRecord.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StreamRecord.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Instant`	`approximateCreationDateTime()` The approximate date and time when the stream record was created, in UNIX epoch time format.
`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()` Returns true if the Keys property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasNewImage()` Returns true if the NewImage property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasOldImage()` Returns true if the OldImage property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - approximateCreationDateTime
```
public final Instant approximateCreationDateTime()
```
    The approximate date and time when the stream record was created, in UNIX epoch time format.
    
    Returns:
    
    The approximate date and time when the stream record was created, in UNIX epoch time format.
  - hasKeys
```
public final boolean hasKeys()
```
    Returns true if the Keys property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - keys
```
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.
    
    You can use hasKeys() to see if a value was sent in this field.
    
    Returns:
    
    The primary key attribute(s) for the DynamoDB item that was modified.
  - hasNewImage
```
public final boolean hasNewImage()
```
    Returns true if the NewImage property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - newImage
```
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.
    
    You can use hasNewImage() to see if a value was sent in this field.
    
    Returns:
    
    The item in the DynamoDB table as it appeared after it was modified.
  - hasOldImage
```
public final boolean hasOldImage()
```
    Returns true if the OldImage property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - oldImage
```
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.
    
    You can use hasOldImage() to see if a value was sent in this field.
    
    Returns:
    
    The item in the DynamoDB table as it appeared before it was modified.
  - sequenceNumber
```
public final String sequenceNumber()
```
    The sequence number of the stream record.
    
    Returns:
    
    The sequence number of the stream record.
  - sizeBytes
```
public final Long sizeBytes()
```
    The size of the stream record, in bytes.
    
    Returns:
    
    The size of the stream record, in bytes.
  - streamViewType
```
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().
    Returns:
    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.
    See Also:
    
    StreamViewType
  - streamViewTypeAsString
```
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().
    Returns:
    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.
    See Also:
    
    StreamViewType
  - toBuilder
```
public StreamRecord.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StreamRecord.Builder,StreamRecord>
  - builder
```
public static StreamRecord.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StreamRecord.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class StreamRecord

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

approximateCreationDateTime

hasKeys

keys

hasNewImage

newImage

hasOldImage

oldImage

sequenceNumber

sizeBytes

streamViewType

streamViewTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields