com.amazonaws.services.dynamodbv2.model.StreamSpecification Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dynamodb Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.dynamodbv2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Represents the DynamoDB Streams configuration for a table in DynamoDB.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StreamSpecification implements Serializable, Cloneable, StructuredPojo {
/**
*
* Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
*
*/
private Boolean streamEnabled;
/**
*
* When an item in the table is modified, StreamViewType determines what information is written to the
* stream for this table. Valid values for StreamViewType 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.
*
*
*
*/
private String streamViewType;
/**
*
* Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
*
*
* @param streamEnabled
* Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
*/
public void setStreamEnabled(Boolean streamEnabled) {
this.streamEnabled = streamEnabled;
}
/**
*
* Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
*
*
* @return Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
*/
public Boolean getStreamEnabled() {
return this.streamEnabled;
}
/**
*
* Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
*
*
* @param streamEnabled
* Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StreamSpecification withStreamEnabled(Boolean streamEnabled) {
setStreamEnabled(streamEnabled);
return this;
}
/**
*
* Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
*
*
* @return Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
*/
public Boolean isStreamEnabled() {
return this.streamEnabled;
}
/**
*
* When an item in the table is modified, StreamViewType determines what information is written to the
* stream for this table. Valid values for StreamViewType 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.
*
*
*
*
* @param streamViewType
* When an item in the table is modified, StreamViewType determines what information is written
* to the stream for this table. Valid values for StreamViewType 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 StreamViewType
*/
public void setStreamViewType(String streamViewType) {
this.streamViewType = streamViewType;
}
/**
*
* When an item in the table is modified, StreamViewType determines what information is written to the
* stream for this table. Valid values for StreamViewType 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.
*
*
*
*
* @return When an item in the table is modified, StreamViewType determines what information is written
* to the stream for this table. Valid values for StreamViewType 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 StreamViewType
*/
public String getStreamViewType() {
return this.streamViewType;
}
/**
*
* When an item in the table is modified, StreamViewType determines what information is written to the
* stream for this table. Valid values for StreamViewType 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.
*
*
*
*
* @param streamViewType
* When an item in the table is modified, StreamViewType determines what information is written
* to the stream for this table. Valid values for StreamViewType 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see StreamViewType
*/
public StreamSpecification withStreamViewType(String streamViewType) {
setStreamViewType(streamViewType);
return this;
}
/**
*
* When an item in the table is modified, StreamViewType determines what information is written to the
* stream for this table. Valid values for StreamViewType 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.
*
*
*
*
* @param streamViewType
* When an item in the table is modified, StreamViewType determines what information is written
* to the stream for this table. Valid values for StreamViewType 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 StreamViewType
*/
public void setStreamViewType(StreamViewType streamViewType) {
withStreamViewType(streamViewType);
}
/**
*
* When an item in the table is modified, StreamViewType determines what information is written to the
* stream for this table. Valid values for StreamViewType 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.
*
*
*
*
* @param streamViewType
* When an item in the table is modified, StreamViewType determines what information is written
* to the stream for this table. Valid values for StreamViewType 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see StreamViewType
*/
public StreamSpecification withStreamViewType(StreamViewType streamViewType) {
this.streamViewType = streamViewType.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getStreamEnabled() != null)
sb.append("StreamEnabled: ").append(getStreamEnabled()).append(",");
if (getStreamViewType() != null)
sb.append("StreamViewType: ").append(getStreamViewType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StreamSpecification == false)
return false;
StreamSpecification other = (StreamSpecification) obj;
if (other.getStreamEnabled() == null ^ this.getStreamEnabled() == null)
return false;
if (other.getStreamEnabled() != null && other.getStreamEnabled().equals(this.getStreamEnabled()) == false)
return false;
if (other.getStreamViewType() == null ^ this.getStreamViewType() == null)
return false;
if (other.getStreamViewType() != null && other.getStreamViewType().equals(this.getStreamViewType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getStreamEnabled() == null) ? 0 : getStreamEnabled().hashCode());
hashCode = prime * hashCode + ((getStreamViewType() == null) ? 0 : getStreamViewType().hashCode());
return hashCode;
}
@Override
public StreamSpecification clone() {
try {
return (StreamSpecification) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.dynamodbv2.model.transform.StreamSpecificationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}