Class StreamSpecification
- java.lang.Object
-
- software.amazon.awssdk.services.dynamodb.model.StreamSpecification
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<StreamSpecification.Builder,StreamSpecification>
@Generated("software.amazon.awssdk:codegen") public final class StreamSpecification extends Object implements SdkPojo, Serializable, ToCopyableBuilder<StreamSpecification.Builder,StreamSpecification>
Represents the DynamoDB Streams configuration for a table in DynamoDB.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
StreamSpecification.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static StreamSpecification.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
List<SdkField<?>>
sdkFields()
static Class<? extends StreamSpecification.Builder>
serializableBuilderClass()
Boolean
streamEnabled()
Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.StreamViewType
streamViewType()
When an item in the table is modified,StreamViewType
determines what information is written to the stream for this table.String
streamViewTypeAsString()
When an item in the table is modified,StreamViewType
determines what information is written to the stream for this table.StreamSpecification.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
-
streamEnabled
public final Boolean streamEnabled()
Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
- Returns:
- Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
-
streamViewType
public final StreamViewType streamViewType()
When an item in the table is modified,
StreamViewType
determines what information is written to the stream for this table. Valid values forStreamViewType
are:-
KEYS_ONLY
- Only the key attributes of the modified item are written to the stream. -
NEW_IMAGE
- The entire item, as it appears after it was modified, is written to the stream. -
OLD_IMAGE
- The entire item, as it appeared before it was modified, is written to the stream. -
NEW_AND_OLD_IMAGES
- Both the new and the old item images of the item are written to the stream.
If the service returns an enum value that is not available in the current SDK version,
streamViewType
will returnStreamViewType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstreamViewTypeAsString()
.- Returns:
- When an item in the table is modified,
StreamViewType
determines what information is written to the stream for this table. Valid values forStreamViewType
are:-
KEYS_ONLY
- Only the key attributes of the modified item are written to the stream. -
NEW_IMAGE
- The entire item, as it appears after it was modified, is written to the stream. -
OLD_IMAGE
- The entire item, as it appeared before it was modified, is written to the stream. -
NEW_AND_OLD_IMAGES
- Both the new and the old item images of the item are written to the stream.
-
- See Also:
StreamViewType
-
-
streamViewTypeAsString
public final String streamViewTypeAsString()
When an item in the table is modified,
StreamViewType
determines what information is written to the stream for this table. Valid values forStreamViewType
are:-
KEYS_ONLY
- Only the key attributes of the modified item are written to the stream. -
NEW_IMAGE
- The entire item, as it appears after it was modified, is written to the stream. -
OLD_IMAGE
- The entire item, as it appeared before it was modified, is written to the stream. -
NEW_AND_OLD_IMAGES
- Both the new and the old item images of the item are written to the stream.
If the service returns an enum value that is not available in the current SDK version,
streamViewType
will returnStreamViewType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstreamViewTypeAsString()
.- Returns:
- When an item in the table is modified,
StreamViewType
determines what information is written to the stream for this table. Valid values forStreamViewType
are:-
KEYS_ONLY
- Only the key attributes of the modified item are written to the stream. -
NEW_IMAGE
- The entire item, as it appears after it was modified, is written to the stream. -
OLD_IMAGE
- The entire item, as it appeared before it was modified, is written to the stream. -
NEW_AND_OLD_IMAGES
- Both the new and the old item images of the item are written to the stream.
-
- See Also:
StreamViewType
-
-
toBuilder
public StreamSpecification.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<StreamSpecification.Builder,StreamSpecification>
-
builder
public static StreamSpecification.Builder builder()
-
serializableBuilderClass
public static Class<? extends StreamSpecification.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.
-
-