Class CdcSpecification

java.lang.Object
software.amazon.awssdk.services.keyspaces.model.CdcSpecification
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CdcSpecification.Builder,CdcSpecification>
@Generated("software.amazon.awssdk:codegen") public final class CdcSpecification extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CdcSpecification.Builder,CdcSpecification>

The settings for the CDC stream of a table. For more information about CDC streams, see Working with change data capture (CDC) streams in Amazon Keyspaces in the Amazon Keyspaces Developer Guide.

See Also:

  • Method Details

    • status

      public final CdcStatus status()

      The status of the CDC stream. You can enable or disable a stream for a table.

      If the service returns an enum value that is not available in the current SDK version, status will return CdcStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the CDC stream. You can enable or disable a stream for a table.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the CDC stream. You can enable or disable a stream for a table.

      If the service returns an enum value that is not available in the current SDK version, status will return CdcStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the CDC stream. You can enable or disable a stream for a table.
      See Also:

    • viewType

      public final ViewType viewType()

      The view type specifies the changes Amazon Keyspaces records for each changed row in the stream. After you create the stream, you can't make changes to this selection.

      The options are:

      • NEW_AND_OLD_IMAGES - both versions of the row, before and after the change. This is the default.

      • NEW_IMAGE - the version of the row after the change.

      • OLD_IMAGE - the version of the row before the change.

      • KEYS_ONLY - the partition and clustering keys of the row that was changed.

      If the service returns an enum value that is not available in the current SDK version, viewType will return ViewType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from viewTypeAsString().

      Returns:
      The view type specifies the changes Amazon Keyspaces records for each changed row in the stream. After you create the stream, you can't make changes to this selection.

      The options are:

      • NEW_AND_OLD_IMAGES - both versions of the row, before and after the change. This is the default.

      • NEW_IMAGE - the version of the row after the change.

      • OLD_IMAGE - the version of the row before the change.

      • KEYS_ONLY - the partition and clustering keys of the row that was changed.

      See Also:

    • viewTypeAsString

      public final String viewTypeAsString()

      The view type specifies the changes Amazon Keyspaces records for each changed row in the stream. After you create the stream, you can't make changes to this selection.

      The options are:

      • NEW_AND_OLD_IMAGES - both versions of the row, before and after the change. This is the default.

      • NEW_IMAGE - the version of the row after the change.

      • OLD_IMAGE - the version of the row before the change.

      • KEYS_ONLY - the partition and clustering keys of the row that was changed.

      If the service returns an enum value that is not available in the current SDK version, viewType will return ViewType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from viewTypeAsString().

      Returns:
      The view type specifies the changes Amazon Keyspaces records for each changed row in the stream. After you create the stream, you can't make changes to this selection.

      The options are:

      • NEW_AND_OLD_IMAGES - both versions of the row, before and after the change. This is the default.

      • NEW_IMAGE - the version of the row after the change.

      • OLD_IMAGE - the version of the row before the change.

      • KEYS_ONLY - the partition and clustering keys of the row that was changed.

      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • tags

      public final List<Tag> tags()

      The tags (key-value pairs) that you want to apply to the stream.

      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.

      Returns:
      The tags (key-value pairs) that you want to apply to the stream.

    • propagateTags

      public final CdcPropagateTags propagateTags()

      Specifies that the stream inherits the tags from the table.

      If the service returns an enum value that is not available in the current SDK version, propagateTags will return CdcPropagateTags.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from propagateTagsAsString().

      Returns:
      Specifies that the stream inherits the tags from the table.
      See Also:

    • propagateTagsAsString

      public final String propagateTagsAsString()

      Specifies that the stream inherits the tags from the table.

      If the service returns an enum value that is not available in the current SDK version, propagateTags will return CdcPropagateTags.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from propagateTagsAsString().

      Returns:
      Specifies that the stream inherits the tags from the table.
      See Also:

    • toBuilder

      public CdcSpecification.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CdcSpecification.Builder,CdcSpecification>
      Returns:
      a builder for type T

    • builder

      public static CdcSpecification.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CdcSpecification.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.