Class Record
- java.lang.Object
-
- software.amazon.awssdk.services.dynamodb.model.Record
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Record.Builder,Record>
@Generated("software.amazon.awssdk:codegen") public final class Record extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Record.Builder,Record>
A description of a unique event within a stream.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Record.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
awsRegion()
The region in which theGetRecords
request was received.static Record.Builder
builder()
StreamRecord
dynamodb()
The main body of the stream record, containing all of the DynamoDB-specific fields.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
eventID()
A globally unique identifier for the event that was recorded in this stream record.OperationType
eventName()
The type of data modification that was performed on the DynamoDB table:String
eventNameAsString()
The type of data modification that was performed on the DynamoDB table:String
eventSource()
The Amazon Web Services service from which the stream record originated.String
eventVersion()
The version number of the stream record format.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
List<SdkField<?>>
sdkFields()
static Class<? extends Record.Builder>
serializableBuilderClass()
Record.Builder
toBuilder()
String
toString()
Returns a string representation of this object.Identity
userIdentity()
Items that are deleted by the Time to Live process after expiration have the following fields:-
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
-
eventID
public final String eventID()
A globally unique identifier for the event that was recorded in this stream record.
- Returns:
- A globally unique identifier for the event that was recorded in this stream record.
-
eventName
public final OperationType eventName()
The type of data modification that was performed on the DynamoDB table:
-
INSERT
- a new item was added to the table. -
MODIFY
- one or more of an existing item's attributes were modified. -
REMOVE
- the item was deleted from the table
If the service returns an enum value that is not available in the current SDK version,
eventName
will returnOperationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventNameAsString()
.- Returns:
- The type of data modification that was performed on the DynamoDB table:
-
INSERT
- a new item was added to the table. -
MODIFY
- one or more of an existing item's attributes were modified. -
REMOVE
- the item was deleted from the table
-
- See Also:
OperationType
-
-
eventNameAsString
public final String eventNameAsString()
The type of data modification that was performed on the DynamoDB table:
-
INSERT
- a new item was added to the table. -
MODIFY
- one or more of an existing item's attributes were modified. -
REMOVE
- the item was deleted from the table
If the service returns an enum value that is not available in the current SDK version,
eventName
will returnOperationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeventNameAsString()
.- Returns:
- The type of data modification that was performed on the DynamoDB table:
-
INSERT
- a new item was added to the table. -
MODIFY
- one or more of an existing item's attributes were modified. -
REMOVE
- the item was deleted from the table
-
- See Also:
OperationType
-
-
eventVersion
public final String eventVersion()
The version number of the stream record format. This number is updated whenever the structure of
Record
is modified.Client applications must not assume that
eventVersion
will remain at a particular value, as this number is subject to change at any time. In general,eventVersion
will only increase as the low-level DynamoDB Streams API evolves.- Returns:
- The version number of the stream record format. This number is updated whenever the structure of
Record
is modified.Client applications must not assume that
eventVersion
will remain at a particular value, as this number is subject to change at any time. In general,eventVersion
will only increase as the low-level DynamoDB Streams API evolves.
-
eventSource
public final String eventSource()
The Amazon Web Services service from which the stream record originated. For DynamoDB Streams, this is
aws:dynamodb
.- Returns:
- The Amazon Web Services service from which the stream record originated. For DynamoDB Streams, this is
aws:dynamodb
.
-
awsRegion
public final String awsRegion()
The region in which the
GetRecords
request was received.- Returns:
- The region in which the
GetRecords
request was received.
-
dynamodb
public final StreamRecord dynamodb()
The main body of the stream record, containing all of the DynamoDB-specific fields.
- Returns:
- The main body of the stream record, containing all of the DynamoDB-specific fields.
-
userIdentity
public final Identity userIdentity()
Items that are deleted by the Time to Live process after expiration have the following fields:
-
Records[].userIdentity.type
"Service"
-
Records[].userIdentity.principalId
"dynamodb.amazonaws.com"
- Returns:
- Items that are deleted by the Time to Live process after expiration have the following fields:
-
Records[].userIdentity.type
"Service"
-
Records[].userIdentity.principalId
"dynamodb.amazonaws.com"
-
-
-
toBuilder
public Record.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<Record.Builder,Record>
-
builder
public static Record.Builder builder()
-
serializableBuilderClass
public static Class<? extends Record.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-