software.amazon.awssdk.services.dynamodb.model.StreamDescription Maven / Gradle / Ivy
/*
* Copyright 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 software.amazon.awssdk.services.dynamodb.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Represents all of the data describing a particular stream.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class StreamDescription implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField STREAM_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StreamArn").getter(getter(StreamDescription::streamArn)).setter(setter(Builder::streamArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StreamArn").build()).build();
private static final SdkField STREAM_LABEL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StreamLabel").getter(getter(StreamDescription::streamLabel)).setter(setter(Builder::streamLabel))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StreamLabel").build()).build();
private static final SdkField STREAM_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StreamStatus").getter(getter(StreamDescription::streamStatusAsString))
.setter(setter(Builder::streamStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StreamStatus").build()).build();
private static final SdkField STREAM_VIEW_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StreamViewType").getter(getter(StreamDescription::streamViewTypeAsString))
.setter(setter(Builder::streamViewType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StreamViewType").build()).build();
private static final SdkField CREATION_REQUEST_DATE_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreationRequestDateTime").getter(getter(StreamDescription::creationRequestDateTime))
.setter(setter(Builder::creationRequestDateTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreationRequestDateTime").build())
.build();
private static final SdkField TABLE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TableName").getter(getter(StreamDescription::tableName)).setter(setter(Builder::tableName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TableName").build()).build();
private static final SdkField> KEY_SCHEMA_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("KeySchema")
.getter(getter(StreamDescription::keySchema))
.setter(setter(Builder::keySchema))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeySchema").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(KeySchemaElement::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> SHARDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Shards")
.getter(getter(StreamDescription::shards))
.setter(setter(Builder::shards))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Shards").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Shard::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField LAST_EVALUATED_SHARD_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LastEvaluatedShardId").getter(getter(StreamDescription::lastEvaluatedShardId))
.setter(setter(Builder::lastEvaluatedShardId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastEvaluatedShardId").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(STREAM_ARN_FIELD,
STREAM_LABEL_FIELD, STREAM_STATUS_FIELD, STREAM_VIEW_TYPE_FIELD, CREATION_REQUEST_DATE_TIME_FIELD, TABLE_NAME_FIELD,
KEY_SCHEMA_FIELD, SHARDS_FIELD, LAST_EVALUATED_SHARD_ID_FIELD));
private static final long serialVersionUID = 1L;
private final String streamArn;
private final String streamLabel;
private final String streamStatus;
private final String streamViewType;
private final Instant creationRequestDateTime;
private final String tableName;
private final List keySchema;
private final List shards;
private final String lastEvaluatedShardId;
private StreamDescription(BuilderImpl builder) {
this.streamArn = builder.streamArn;
this.streamLabel = builder.streamLabel;
this.streamStatus = builder.streamStatus;
this.streamViewType = builder.streamViewType;
this.creationRequestDateTime = builder.creationRequestDateTime;
this.tableName = builder.tableName;
this.keySchema = builder.keySchema;
this.shards = builder.shards;
this.lastEvaluatedShardId = builder.lastEvaluatedShardId;
}
/**
*
* The Amazon Resource Name (ARN) for the stream.
*
*
* @return The Amazon Resource Name (ARN) for the stream.
*/
public final String streamArn() {
return streamArn;
}
/**
*
* A timestamp, in ISO 8601 format, for this stream.
*
*
* Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a
* stream from another table might have the same timestamp. However, the combination of the following three elements
* is guaranteed to be unique:
*
*
* -
*
* the AWS customer ID.
*
*
* -
*
* the table name
*
*
* -
*
* the StreamLabel
*
*
*
*
* @return A timestamp, in ISO 8601 format, for this stream.
*
* Note that LatestStreamLabel is not a unique identifier for the stream, because it is
* possible that a stream from another table might have the same timestamp. However, the combination of the
* following three elements is guaranteed to be unique:
*
*
* -
*
* the AWS customer ID.
*
*
* -
*
* the table name
*
*
* -
*
* the StreamLabel
*
*
*/
public final String streamLabel() {
return streamLabel;
}
/**
*
* Indicates the current status of the stream:
*
*
* -
*
* ENABLING - Streams is currently being enabled on the DynamoDB table.
*
*
* -
*
* ENABLED - the stream is enabled.
*
*
* -
*
* DISABLING - Streams is currently being disabled on the DynamoDB table.
*
*
* -
*
* DISABLED - the stream is disabled.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #streamStatus} will
* return {@link StreamStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #streamStatusAsString}.
*
*
* @return Indicates the current status of the stream:
*
* -
*
* ENABLING - Streams is currently being enabled on the DynamoDB table.
*
*
* -
*
* ENABLED - the stream is enabled.
*
*
* -
*
* DISABLING - Streams is currently being disabled on the DynamoDB table.
*
*
* -
*
* DISABLED - the stream is disabled.
*
*
* @see StreamStatus
*/
public final StreamStatus streamStatus() {
return StreamStatus.fromValue(streamStatus);
}
/**
*
* Indicates the current status of the stream:
*
*
* -
*
* ENABLING - Streams is currently being enabled on the DynamoDB table.
*
*
* -
*
* ENABLED - the stream is enabled.
*
*
* -
*
* DISABLING - Streams is currently being disabled on the DynamoDB table.
*
*
* -
*
* DISABLED - the stream is disabled.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #streamStatus} will
* return {@link StreamStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #streamStatusAsString}.
*
*
* @return Indicates the current status of the stream:
*
* -
*
* ENABLING - Streams is currently being enabled on the DynamoDB table.
*
*
* -
*
* ENABLED - the stream is enabled.
*
*
* -
*
* DISABLING - Streams is currently being disabled on the DynamoDB table.
*
*
* -
*
* DISABLED - the stream is disabled.
*
*
* @see StreamStatus
*/
public final String streamStatusAsString() {
return streamStatus;
}
/**
*
* Indicates the format of the records within this stream:
*
*
* -
*
* KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.
*
*
* -
*
* NEW_IMAGE - entire items from the table, as they appeared after they were modified.
*
*
* -
*
* OLD_IMAGE - entire items from the table, as they appeared before they were modified.
*
*
* -
*
* NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #streamViewType}
* will return {@link StreamViewType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #streamViewTypeAsString}.
*
*
* @return Indicates the format of the records within this stream:
*
* -
*
* KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.
*
*
* -
*
* NEW_IMAGE - entire items from the table, as they appeared after they were modified.
*
*
* -
*
* OLD_IMAGE - entire items from the table, as they appeared before they were modified.
*
*
* -
*
* NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.
*
*
* @see StreamViewType
*/
public final StreamViewType streamViewType() {
return StreamViewType.fromValue(streamViewType);
}
/**
*
* Indicates the format of the records within this stream:
*
*
* -
*
* KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.
*
*
* -
*
* NEW_IMAGE - entire items from the table, as they appeared after they were modified.
*
*
* -
*
* OLD_IMAGE - entire items from the table, as they appeared before they were modified.
*
*
* -
*
* NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #streamViewType}
* will return {@link StreamViewType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #streamViewTypeAsString}.
*
*
* @return Indicates the format of the records within this stream:
*
* -
*
* KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.
*
*
* -
*
* NEW_IMAGE - entire items from the table, as they appeared after they were modified.
*
*
* -
*
* OLD_IMAGE - entire items from the table, as they appeared before they were modified.
*
*
* -
*
* NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.
*
*
* @see StreamViewType
*/
public final String streamViewTypeAsString() {
return streamViewType;
}
/**
*
* The date and time when the request to create this stream was issued.
*
*
* @return The date and time when the request to create this stream was issued.
*/
public final Instant creationRequestDateTime() {
return creationRequestDateTime;
}
/**
*
* The DynamoDB table with which the stream is associated.
*
*
* @return The DynamoDB table with which the stream is associated.
*/
public final String tableName() {
return tableName;
}
/**
* Returns true if the KeySchema 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.
*/
public final boolean hasKeySchema() {
return keySchema != null && !(keySchema instanceof SdkAutoConstructList);
}
/**
*
* The key attribute(s) of the stream's DynamoDB table.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasKeySchema()} to see if a value was sent in this field.
*
*
* @return The key attribute(s) of the stream's DynamoDB table.
*/
public final List keySchema() {
return keySchema;
}
/**
* Returns true if the Shards 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.
*/
public final boolean hasShards() {
return shards != null && !(shards instanceof SdkAutoConstructList);
}
/**
*
* The shards that comprise the stream.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasShards()} to see if a value was sent in this field.
*
*
* @return The shards that comprise the stream.
*/
public final List shards() {
return shards;
}
/**
*
* The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to
* start a new operation, excluding this value in the new request.
*
*
* If LastEvaluatedShardId is empty, then the "last page" of results has been processed and there is
* currently no more data to be retrieved.
*
*
* If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data in the
* result set. The only way to know when you have reached the end of the result set is when
* LastEvaluatedShardId is empty.
*
*
* @return The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this
* value to start a new operation, excluding this value in the new request.
*
* If LastEvaluatedShardId is empty, then the "last page" of results has been processed and
* there is currently no more data to be retrieved.
*
*
* If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data
* in the result set. The only way to know when you have reached the end of the result set is when
* LastEvaluatedShardId is empty.
*/
public final String lastEvaluatedShardId() {
return lastEvaluatedShardId;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(streamArn());
hashCode = 31 * hashCode + Objects.hashCode(streamLabel());
hashCode = 31 * hashCode + Objects.hashCode(streamStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(streamViewTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(creationRequestDateTime());
hashCode = 31 * hashCode + Objects.hashCode(tableName());
hashCode = 31 * hashCode + Objects.hashCode(hasKeySchema() ? keySchema() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasShards() ? shards() : null);
hashCode = 31 * hashCode + Objects.hashCode(lastEvaluatedShardId());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof StreamDescription)) {
return false;
}
StreamDescription other = (StreamDescription) obj;
return Objects.equals(streamArn(), other.streamArn()) && Objects.equals(streamLabel(), other.streamLabel())
&& Objects.equals(streamStatusAsString(), other.streamStatusAsString())
&& Objects.equals(streamViewTypeAsString(), other.streamViewTypeAsString())
&& Objects.equals(creationRequestDateTime(), other.creationRequestDateTime())
&& Objects.equals(tableName(), other.tableName()) && hasKeySchema() == other.hasKeySchema()
&& Objects.equals(keySchema(), other.keySchema()) && hasShards() == other.hasShards()
&& Objects.equals(shards(), other.shards())
&& Objects.equals(lastEvaluatedShardId(), other.lastEvaluatedShardId());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("StreamDescription").add("StreamArn", streamArn()).add("StreamLabel", streamLabel())
.add("StreamStatus", streamStatusAsString()).add("StreamViewType", streamViewTypeAsString())
.add("CreationRequestDateTime", creationRequestDateTime()).add("TableName", tableName())
.add("KeySchema", hasKeySchema() ? keySchema() : null).add("Shards", hasShards() ? shards() : null)
.add("LastEvaluatedShardId", lastEvaluatedShardId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "StreamArn":
return Optional.ofNullable(clazz.cast(streamArn()));
case "StreamLabel":
return Optional.ofNullable(clazz.cast(streamLabel()));
case "StreamStatus":
return Optional.ofNullable(clazz.cast(streamStatusAsString()));
case "StreamViewType":
return Optional.ofNullable(clazz.cast(streamViewTypeAsString()));
case "CreationRequestDateTime":
return Optional.ofNullable(clazz.cast(creationRequestDateTime()));
case "TableName":
return Optional.ofNullable(clazz.cast(tableName()));
case "KeySchema":
return Optional.ofNullable(clazz.cast(keySchema()));
case "Shards":
return Optional.ofNullable(clazz.cast(shards()));
case "LastEvaluatedShardId":
return Optional.ofNullable(clazz.cast(lastEvaluatedShardId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((StreamDescription) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) for the stream.
*
*
* @param streamArn
* The Amazon Resource Name (ARN) for the stream.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder streamArn(String streamArn);
/**
*
* A timestamp, in ISO 8601 format, for this stream.
*
*
* Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible
* that a stream from another table might have the same timestamp. However, the combination of the following
* three elements is guaranteed to be unique:
*
*
* -
*
* the AWS customer ID.
*
*
* -
*
* the table name
*
*
* -
*
* the StreamLabel
*
*
*
*
* @param streamLabel
* A timestamp, in ISO 8601 format, for this stream.
*
* Note that LatestStreamLabel is not a unique identifier for the stream, because it is
* possible that a stream from another table might have the same timestamp. However, the combination of
* the following three elements is guaranteed to be unique:
*
*
* -
*
* the AWS customer ID.
*
*
* -
*
* the table name
*
*
* -
*
* the StreamLabel
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder streamLabel(String streamLabel);
/**
*
* Indicates the current status of the stream:
*
*
* -
*
* ENABLING - Streams is currently being enabled on the DynamoDB table.
*
*
* -
*
* ENABLED - the stream is enabled.
*
*
* -
*
* DISABLING - Streams is currently being disabled on the DynamoDB table.
*
*
* -
*
* DISABLED - the stream is disabled.
*
*
*
*
* @param streamStatus
* Indicates the current status of the stream:
*
* -
*
* ENABLING - Streams is currently being enabled on the DynamoDB table.
*
*
* -
*
* ENABLED - the stream is enabled.
*
*
* -
*
* DISABLING - Streams is currently being disabled on the DynamoDB table.
*
*
* -
*
* DISABLED - the stream is disabled.
*
*
* @see StreamStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see StreamStatus
*/
Builder streamStatus(String streamStatus);
/**
*
* Indicates the current status of the stream:
*
*
* -
*
* ENABLING - Streams is currently being enabled on the DynamoDB table.
*
*
* -
*
* ENABLED - the stream is enabled.
*
*
* -
*
* DISABLING - Streams is currently being disabled on the DynamoDB table.
*
*
* -
*
* DISABLED - the stream is disabled.
*
*
*
*
* @param streamStatus
* Indicates the current status of the stream:
*
* -
*
* ENABLING - Streams is currently being enabled on the DynamoDB table.
*
*
* -
*
* ENABLED - the stream is enabled.
*
*
* -
*
* DISABLING - Streams is currently being disabled on the DynamoDB table.
*
*
* -
*
* DISABLED - the stream is disabled.
*
*
* @see StreamStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see StreamStatus
*/
Builder streamStatus(StreamStatus streamStatus);
/**
*
* Indicates the format of the records within this stream:
*
*
* -
*
* KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.
*
*
* -
*
* NEW_IMAGE - entire items from the table, as they appeared after they were modified.
*
*
* -
*
* OLD_IMAGE - entire items from the table, as they appeared before they were modified.
*
*
* -
*
* NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.
*
*
*
*
* @param streamViewType
* Indicates the format of the records within this stream:
*
* -
*
* KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.
*
*
* -
*
* NEW_IMAGE - entire items from the table, as they appeared after they were modified.
*
*
* -
*
* OLD_IMAGE - entire items from the table, as they appeared before they were modified.
*
*
* -
*
* NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.
*
*
* @see StreamViewType
* @return Returns a reference to this object so that method calls can be chained together.
* @see StreamViewType
*/
Builder streamViewType(String streamViewType);
/**
*
* Indicates the format of the records within this stream:
*
*
* -
*
* KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.
*
*
* -
*
* NEW_IMAGE - entire items from the table, as they appeared after they were modified.
*
*
* -
*
* OLD_IMAGE - entire items from the table, as they appeared before they were modified.
*
*
* -
*
* NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.
*
*
*
*
* @param streamViewType
* Indicates the format of the records within this stream:
*
* -
*
* KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.
*
*
* -
*
* NEW_IMAGE - entire items from the table, as they appeared after they were modified.
*
*
* -
*
* OLD_IMAGE - entire items from the table, as they appeared before they were modified.
*
*
* -
*
* NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.
*
*
* @see StreamViewType
* @return Returns a reference to this object so that method calls can be chained together.
* @see StreamViewType
*/
Builder streamViewType(StreamViewType streamViewType);
/**
*
* The date and time when the request to create this stream was issued.
*
*
* @param creationRequestDateTime
* The date and time when the request to create this stream was issued.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationRequestDateTime(Instant creationRequestDateTime);
/**
*
* The DynamoDB table with which the stream is associated.
*
*
* @param tableName
* The DynamoDB table with which the stream is associated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tableName(String tableName);
/**
*
* The key attribute(s) of the stream's DynamoDB table.
*
*
* @param keySchema
* The key attribute(s) of the stream's DynamoDB table.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keySchema(Collection keySchema);
/**
*
* The key attribute(s) of the stream's DynamoDB table.
*
*
* @param keySchema
* The key attribute(s) of the stream's DynamoDB table.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keySchema(KeySchemaElement... keySchema);
/**
*
* The key attribute(s) of the stream's DynamoDB table.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the
* need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and
* its result is passed to {@link #keySchema(List)}.
*
* @param keySchema
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #keySchema(List)
*/
Builder keySchema(Consumer... keySchema);
/**
*
* The shards that comprise the stream.
*
*
* @param shards
* The shards that comprise the stream.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder shards(Collection shards);
/**
*
* The shards that comprise the stream.
*
*
* @param shards
* The shards that comprise the stream.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder shards(Shard... shards);
/**
*
* The shards that comprise the stream.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create
* one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result
* is passed to {@link #shards(List)}.
*
* @param shards
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #shards(List)
*/
Builder shards(Consumer... shards);
/**
*
* The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to
* start a new operation, excluding this value in the new request.
*
*
* If LastEvaluatedShardId is empty, then the "last page" of results has been processed and there
* is currently no more data to be retrieved.
*
*
* If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data in
* the result set. The only way to know when you have reached the end of the result set is when
* LastEvaluatedShardId is empty.
*
*
* @param lastEvaluatedShardId
* The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this
* value to start a new operation, excluding this value in the new request.
*
* If LastEvaluatedShardId is empty, then the "last page" of results has been processed and
* there is currently no more data to be retrieved.
*
*
* If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more
* data in the result set. The only way to know when you have reached the end of the result set is when
* LastEvaluatedShardId is empty.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastEvaluatedShardId(String lastEvaluatedShardId);
}
static final class BuilderImpl implements Builder {
private String streamArn;
private String streamLabel;
private String streamStatus;
private String streamViewType;
private Instant creationRequestDateTime;
private String tableName;
private List keySchema = DefaultSdkAutoConstructList.getInstance();
private List shards = DefaultSdkAutoConstructList.getInstance();
private String lastEvaluatedShardId;
private BuilderImpl() {
}
private BuilderImpl(StreamDescription model) {
streamArn(model.streamArn);
streamLabel(model.streamLabel);
streamStatus(model.streamStatus);
streamViewType(model.streamViewType);
creationRequestDateTime(model.creationRequestDateTime);
tableName(model.tableName);
keySchema(model.keySchema);
shards(model.shards);
lastEvaluatedShardId(model.lastEvaluatedShardId);
}
public final String getStreamArn() {
return streamArn;
}
@Override
public final Builder streamArn(String streamArn) {
this.streamArn = streamArn;
return this;
}
public final void setStreamArn(String streamArn) {
this.streamArn = streamArn;
}
public final String getStreamLabel() {
return streamLabel;
}
@Override
public final Builder streamLabel(String streamLabel) {
this.streamLabel = streamLabel;
return this;
}
public final void setStreamLabel(String streamLabel) {
this.streamLabel = streamLabel;
}
public final String getStreamStatus() {
return streamStatus;
}
@Override
public final Builder streamStatus(String streamStatus) {
this.streamStatus = streamStatus;
return this;
}
@Override
public final Builder streamStatus(StreamStatus streamStatus) {
this.streamStatus(streamStatus == null ? null : streamStatus.toString());
return this;
}
public final void setStreamStatus(String streamStatus) {
this.streamStatus = streamStatus;
}
public final String getStreamViewType() {
return streamViewType;
}
@Override
public final Builder streamViewType(String streamViewType) {
this.streamViewType = streamViewType;
return this;
}
@Override
public final Builder streamViewType(StreamViewType streamViewType) {
this.streamViewType(streamViewType == null ? null : streamViewType.toString());
return this;
}
public final void setStreamViewType(String streamViewType) {
this.streamViewType = streamViewType;
}
public final Instant getCreationRequestDateTime() {
return creationRequestDateTime;
}
@Override
public final Builder creationRequestDateTime(Instant creationRequestDateTime) {
this.creationRequestDateTime = creationRequestDateTime;
return this;
}
public final void setCreationRequestDateTime(Instant creationRequestDateTime) {
this.creationRequestDateTime = creationRequestDateTime;
}
public final String getTableName() {
return tableName;
}
@Override
public final Builder tableName(String tableName) {
this.tableName = tableName;
return this;
}
public final void setTableName(String tableName) {
this.tableName = tableName;
}
public final List getKeySchema() {
List result = KeySchemaCopier.copyToBuilder(this.keySchema);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
@Override
public final Builder keySchema(Collection keySchema) {
this.keySchema = KeySchemaCopier.copy(keySchema);
return this;
}
@Override
@SafeVarargs
public final Builder keySchema(KeySchemaElement... keySchema) {
keySchema(Arrays.asList(keySchema));
return this;
}
@Override
@SafeVarargs
public final Builder keySchema(Consumer... keySchema) {
keySchema(Stream.of(keySchema).map(c -> KeySchemaElement.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final void setKeySchema(Collection keySchema) {
this.keySchema = KeySchemaCopier.copyFromBuilder(keySchema);
}
public final List getShards() {
List result = ShardDescriptionListCopier.copyToBuilder(this.shards);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
@Override
public final Builder shards(Collection shards) {
this.shards = ShardDescriptionListCopier.copy(shards);
return this;
}
@Override
@SafeVarargs
public final Builder shards(Shard... shards) {
shards(Arrays.asList(shards));
return this;
}
@Override
@SafeVarargs
public final Builder shards(Consumer... shards) {
shards(Stream.of(shards).map(c -> Shard.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setShards(Collection shards) {
this.shards = ShardDescriptionListCopier.copyFromBuilder(shards);
}
public final String getLastEvaluatedShardId() {
return lastEvaluatedShardId;
}
@Override
public final Builder lastEvaluatedShardId(String lastEvaluatedShardId) {
this.lastEvaluatedShardId = lastEvaluatedShardId;
return this;
}
public final void setLastEvaluatedShardId(String lastEvaluatedShardId) {
this.lastEvaluatedShardId = lastEvaluatedShardId;
}
@Override
public StreamDescription build() {
return new StreamDescription(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}