software.amazon.awssdk.services.kinesis.model.StreamDescription Maven / Gradle / Ivy
Show all versions of kinesis Show documentation
/*
* 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.kinesis.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 the output for DescribeStream.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class StreamDescription implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField STREAM_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StreamName").getter(getter(StreamDescription::streamName)).setter(setter(Builder::streamName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StreamName").build()).build();
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_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_MODE_DETAILS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("StreamModeDetails")
.getter(getter(StreamDescription::streamModeDetails)).setter(setter(Builder::streamModeDetails))
.constructor(StreamModeDetails::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StreamModeDetails").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 HAS_MORE_SHARDS_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("HasMoreShards").getter(getter(StreamDescription::hasMoreShards)).setter(setter(Builder::hasMoreShards))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HasMoreShards").build()).build();
private static final SdkField RETENTION_PERIOD_HOURS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("RetentionPeriodHours").getter(getter(StreamDescription::retentionPeriodHours))
.setter(setter(Builder::retentionPeriodHours))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RetentionPeriodHours").build())
.build();
private static final SdkField STREAM_CREATION_TIMESTAMP_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("StreamCreationTimestamp").getter(getter(StreamDescription::streamCreationTimestamp))
.setter(setter(Builder::streamCreationTimestamp))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StreamCreationTimestamp").build())
.build();
private static final SdkField> ENHANCED_MONITORING_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("EnhancedMonitoring")
.getter(getter(StreamDescription::enhancedMonitoring))
.setter(setter(Builder::enhancedMonitoring))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EnhancedMonitoring").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(EnhancedMetrics::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField ENCRYPTION_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EncryptionType").getter(getter(StreamDescription::encryptionTypeAsString))
.setter(setter(Builder::encryptionType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EncryptionType").build()).build();
private static final SdkField KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("KeyId")
.getter(getter(StreamDescription::keyId)).setter(setter(Builder::keyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeyId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(STREAM_NAME_FIELD,
STREAM_ARN_FIELD, STREAM_STATUS_FIELD, STREAM_MODE_DETAILS_FIELD, SHARDS_FIELD, HAS_MORE_SHARDS_FIELD,
RETENTION_PERIOD_HOURS_FIELD, STREAM_CREATION_TIMESTAMP_FIELD, ENHANCED_MONITORING_FIELD, ENCRYPTION_TYPE_FIELD,
KEY_ID_FIELD));
private static final long serialVersionUID = 1L;
private final String streamName;
private final String streamARN;
private final String streamStatus;
private final StreamModeDetails streamModeDetails;
private final List shards;
private final Boolean hasMoreShards;
private final Integer retentionPeriodHours;
private final Instant streamCreationTimestamp;
private final List enhancedMonitoring;
private final String encryptionType;
private final String keyId;
private StreamDescription(BuilderImpl builder) {
this.streamName = builder.streamName;
this.streamARN = builder.streamARN;
this.streamStatus = builder.streamStatus;
this.streamModeDetails = builder.streamModeDetails;
this.shards = builder.shards;
this.hasMoreShards = builder.hasMoreShards;
this.retentionPeriodHours = builder.retentionPeriodHours;
this.streamCreationTimestamp = builder.streamCreationTimestamp;
this.enhancedMonitoring = builder.enhancedMonitoring;
this.encryptionType = builder.encryptionType;
this.keyId = builder.keyId;
}
/**
*
* The name of the stream being described.
*
*
* @return The name of the stream being described.
*/
public final String streamName() {
return streamName;
}
/**
*
* The Amazon Resource Name (ARN) for the stream being described.
*
*
* @return The Amazon Resource Name (ARN) for the stream being described.
*/
public final String streamARN() {
return streamARN;
}
/**
*
* The current status of the stream being described. The stream status is one of the following states:
*
*
* -
*
* CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets
* StreamStatus to CREATING.
*
*
* -
*
* DELETING - The stream is being deleted. The specified stream is in the DELETING state
* until Kinesis Data Streams completes the deletion.
*
*
* -
*
* ACTIVE - The stream exists and is ready for read and write operations or deletion. You should
* perform read and write operations only on an ACTIVE stream.
*
*
* -
*
* UPDATING - Shards in the stream are being merged or split. Read and write operations continue to
* work while the stream is in the UPDATING state.
*
*
*
*
* 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 The current status of the stream being described. The stream status is one of the following states:
*
* -
*
* CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets
* StreamStatus to CREATING.
*
*
* -
*
* DELETING - The stream is being deleted. The specified stream is in the DELETING
* state until Kinesis Data Streams completes the deletion.
*
*
* -
*
* ACTIVE - The stream exists and is ready for read and write operations or deletion. You
* should perform read and write operations only on an ACTIVE stream.
*
*
* -
*
* UPDATING - Shards in the stream are being merged or split. Read and write operations
* continue to work while the stream is in the UPDATING state.
*
*
* @see StreamStatus
*/
public final StreamStatus streamStatus() {
return StreamStatus.fromValue(streamStatus);
}
/**
*
* The current status of the stream being described. The stream status is one of the following states:
*
*
* -
*
* CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets
* StreamStatus to CREATING.
*
*
* -
*
* DELETING - The stream is being deleted. The specified stream is in the DELETING state
* until Kinesis Data Streams completes the deletion.
*
*
* -
*
* ACTIVE - The stream exists and is ready for read and write operations or deletion. You should
* perform read and write operations only on an ACTIVE stream.
*
*
* -
*
* UPDATING - Shards in the stream are being merged or split. Read and write operations continue to
* work while the stream is in the UPDATING state.
*
*
*
*
* 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 The current status of the stream being described. The stream status is one of the following states:
*
* -
*
* CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets
* StreamStatus to CREATING.
*
*
* -
*
* DELETING - The stream is being deleted. The specified stream is in the DELETING
* state until Kinesis Data Streams completes the deletion.
*
*
* -
*
* ACTIVE - The stream exists and is ready for read and write operations or deletion. You
* should perform read and write operations only on an ACTIVE stream.
*
*
* -
*
* UPDATING - Shards in the stream are being merged or split. Read and write operations
* continue to work while the stream is in the UPDATING state.
*
*
* @see StreamStatus
*/
public final String streamStatusAsString() {
return streamStatus;
}
/**
*
* Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you
* can choose between an on-demand capacity mode and a provisioned capacity mode for your data
* streams.
*
*
* @return Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data
* Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode
* for your data streams.
*/
public final StreamModeDetails streamModeDetails() {
return streamModeDetails;
}
/**
* For responses, this returns true if the service returned a value for the Shards property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code 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.
*/
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.
*
*
* 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 {@link #hasShards} method.
*
*
* @return The shards that comprise the stream.
*/
public final List shards() {
return shards;
}
/**
*
* If set to true, more shards in the stream are available to describe.
*
*
* @return If set to true, more shards in the stream are available to describe.
*/
public final Boolean hasMoreShards() {
return hasMoreShards;
}
/**
*
* The current retention period, in hours. Minimum value of 24. Maximum value of 168.
*
*
* @return The current retention period, in hours. Minimum value of 24. Maximum value of 168.
*/
public final Integer retentionPeriodHours() {
return retentionPeriodHours;
}
/**
*
* The approximate time that the stream was created.
*
*
* @return The approximate time that the stream was created.
*/
public final Instant streamCreationTimestamp() {
return streamCreationTimestamp;
}
/**
* For responses, this returns true if the service returned a value for the EnhancedMonitoring property. This DOES
* NOT check that the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasEnhancedMonitoring() {
return enhancedMonitoring != null && !(enhancedMonitoring instanceof SdkAutoConstructList);
}
/**
*
* Represents the current enhanced monitoring settings of 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 {@link #hasEnhancedMonitoring} method.
*
*
* @return Represents the current enhanced monitoring settings of the stream.
*/
public final List enhancedMonitoring() {
return enhancedMonitoring;
}
/**
*
* The server-side encryption type used on the stream. This parameter can be one of the following values:
*
*
* -
*
* NONE: Do not encrypt the records in the stream.
*
*
* -
*
* KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web
* Services KMS key.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #encryptionType}
* will return {@link EncryptionType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #encryptionTypeAsString}.
*
*
* @return The server-side encryption type used on the stream. This parameter can be one of the following
* values:
*
* -
*
* NONE: Do not encrypt the records in the stream.
*
*
* -
*
* KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon
* Web Services KMS key.
*
*
* @see EncryptionType
*/
public final EncryptionType encryptionType() {
return EncryptionType.fromValue(encryptionType);
}
/**
*
* The server-side encryption type used on the stream. This parameter can be one of the following values:
*
*
* -
*
* NONE: Do not encrypt the records in the stream.
*
*
* -
*
* KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web
* Services KMS key.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #encryptionType}
* will return {@link EncryptionType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #encryptionTypeAsString}.
*
*
* @return The server-side encryption type used on the stream. This parameter can be one of the following
* values:
*
* -
*
* NONE: Do not encrypt the records in the stream.
*
*
* -
*
* KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon
* Web Services KMS key.
*
*
* @see EncryptionType
*/
public final String encryptionTypeAsString() {
return encryptionType;
}
/**
*
* The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be a globally
* unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You
* can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.
*
*
* -
*
* Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
*
*
* -
*
* Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
*
*
* -
*
* Globally unique key ID example: 12345678-1234-1234-1234-123456789012
*
*
* -
*
* Alias name example: alias/MyAliasName
*
*
* -
*
* Master key owned by Kinesis Data Streams: alias/aws/kinesis
*
*
*
*
* @return The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be a
* globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed
* by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias
* aws/kinesis.
*
* -
*
* Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
*
*
* -
*
* Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
*
*
* -
*
* Globally unique key ID example: 12345678-1234-1234-1234-123456789012
*
*
* -
*
* Alias name example: alias/MyAliasName
*
*
* -
*
* Master key owned by Kinesis Data Streams: alias/aws/kinesis
*
*
*/
public final String keyId() {
return keyId;
}
@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(streamName());
hashCode = 31 * hashCode + Objects.hashCode(streamARN());
hashCode = 31 * hashCode + Objects.hashCode(streamStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(streamModeDetails());
hashCode = 31 * hashCode + Objects.hashCode(hasShards() ? shards() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasMoreShards());
hashCode = 31 * hashCode + Objects.hashCode(retentionPeriodHours());
hashCode = 31 * hashCode + Objects.hashCode(streamCreationTimestamp());
hashCode = 31 * hashCode + Objects.hashCode(hasEnhancedMonitoring() ? enhancedMonitoring() : null);
hashCode = 31 * hashCode + Objects.hashCode(encryptionTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(keyId());
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(streamName(), other.streamName()) && Objects.equals(streamARN(), other.streamARN())
&& Objects.equals(streamStatusAsString(), other.streamStatusAsString())
&& Objects.equals(streamModeDetails(), other.streamModeDetails()) && hasShards() == other.hasShards()
&& Objects.equals(shards(), other.shards()) && Objects.equals(hasMoreShards(), other.hasMoreShards())
&& Objects.equals(retentionPeriodHours(), other.retentionPeriodHours())
&& Objects.equals(streamCreationTimestamp(), other.streamCreationTimestamp())
&& hasEnhancedMonitoring() == other.hasEnhancedMonitoring()
&& Objects.equals(enhancedMonitoring(), other.enhancedMonitoring())
&& Objects.equals(encryptionTypeAsString(), other.encryptionTypeAsString())
&& Objects.equals(keyId(), other.keyId());
}
/**
* 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("StreamName", streamName()).add("StreamARN", streamARN())
.add("StreamStatus", streamStatusAsString()).add("StreamModeDetails", streamModeDetails())
.add("Shards", hasShards() ? shards() : null).add("HasMoreShards", hasMoreShards())
.add("RetentionPeriodHours", retentionPeriodHours()).add("StreamCreationTimestamp", streamCreationTimestamp())
.add("EnhancedMonitoring", hasEnhancedMonitoring() ? enhancedMonitoring() : null)
.add("EncryptionType", encryptionTypeAsString()).add("KeyId", keyId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "StreamName":
return Optional.ofNullable(clazz.cast(streamName()));
case "StreamARN":
return Optional.ofNullable(clazz.cast(streamARN()));
case "StreamStatus":
return Optional.ofNullable(clazz.cast(streamStatusAsString()));
case "StreamModeDetails":
return Optional.ofNullable(clazz.cast(streamModeDetails()));
case "Shards":
return Optional.ofNullable(clazz.cast(shards()));
case "HasMoreShards":
return Optional.ofNullable(clazz.cast(hasMoreShards()));
case "RetentionPeriodHours":
return Optional.ofNullable(clazz.cast(retentionPeriodHours()));
case "StreamCreationTimestamp":
return Optional.ofNullable(clazz.cast(streamCreationTimestamp()));
case "EnhancedMonitoring":
return Optional.ofNullable(clazz.cast(enhancedMonitoring()));
case "EncryptionType":
return Optional.ofNullable(clazz.cast(encryptionTypeAsString()));
case "KeyId":
return Optional.ofNullable(clazz.cast(keyId()));
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 name of the stream being described.
*
*
* @param streamName
* The name of the stream being described.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder streamName(String streamName);
/**
*
* The Amazon Resource Name (ARN) for the stream being described.
*
*
* @param streamARN
* The Amazon Resource Name (ARN) for the stream being described.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder streamARN(String streamARN);
/**
*
* The current status of the stream being described. The stream status is one of the following states:
*
*
* -
*
* CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets
* StreamStatus to CREATING.
*
*
* -
*
* DELETING - The stream is being deleted. The specified stream is in the DELETING
* state until Kinesis Data Streams completes the deletion.
*
*
* -
*
* ACTIVE - The stream exists and is ready for read and write operations or deletion. You should
* perform read and write operations only on an ACTIVE stream.
*
*
* -
*
* UPDATING - Shards in the stream are being merged or split. Read and write operations continue to
* work while the stream is in the UPDATING state.
*
*
*
*
* @param streamStatus
* The current status of the stream being described. The stream status is one of the following
* states:
*
* -
*
* CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets
* StreamStatus to CREATING.
*
*
* -
*
* DELETING - The stream is being deleted. The specified stream is in the
* DELETING state until Kinesis Data Streams completes the deletion.
*
*
* -
*
* ACTIVE - The stream exists and is ready for read and write operations or deletion. You
* should perform read and write operations only on an ACTIVE stream.
*
*
* -
*
* UPDATING - Shards in the stream are being merged or split. Read and write operations
* continue to work while the stream is in the UPDATING state.
*
*
* @see StreamStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see StreamStatus
*/
Builder streamStatus(String streamStatus);
/**
*
* The current status of the stream being described. The stream status is one of the following states:
*
*
* -
*
* CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets
* StreamStatus to CREATING.
*
*
* -
*
* DELETING - The stream is being deleted. The specified stream is in the DELETING
* state until Kinesis Data Streams completes the deletion.
*
*
* -
*
* ACTIVE - The stream exists and is ready for read and write operations or deletion. You should
* perform read and write operations only on an ACTIVE stream.
*
*
* -
*
* UPDATING - Shards in the stream are being merged or split. Read and write operations continue to
* work while the stream is in the UPDATING state.
*
*
*
*
* @param streamStatus
* The current status of the stream being described. The stream status is one of the following
* states:
*
* -
*
* CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets
* StreamStatus to CREATING.
*
*
* -
*
* DELETING - The stream is being deleted. The specified stream is in the
* DELETING state until Kinesis Data Streams completes the deletion.
*
*
* -
*
* ACTIVE - The stream exists and is ready for read and write operations or deletion. You
* should perform read and write operations only on an ACTIVE stream.
*
*
* -
*
* UPDATING - Shards in the stream are being merged or split. Read and write operations
* continue to work while the stream is in the UPDATING state.
*
*
* @see StreamStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see StreamStatus
*/
Builder streamStatus(StreamStatus streamStatus);
/**
*
* Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams,
* you can choose between an on-demand capacity mode and a provisioned capacity mode for your data
* streams.
*
*
* @param streamModeDetails
* Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data
* Streams, you can choose between an on-demand capacity mode and a provisioned capacity
* mode for your data streams.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder streamModeDetails(StreamModeDetails streamModeDetails);
/**
*
* Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams,
* you can choose between an on-demand capacity mode and a provisioned capacity mode for your data
* streams.
*
* This is a convenience method that creates an instance of the {@link StreamModeDetails.Builder} avoiding the
* need to create one manually via {@link StreamModeDetails#builder()}.
*
*
* When the {@link Consumer} completes, {@link StreamModeDetails.Builder#build()} is called immediately and its
* result is passed to {@link #streamModeDetails(StreamModeDetails)}.
*
* @param streamModeDetails
* a consumer that will call methods on {@link StreamModeDetails.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #streamModeDetails(StreamModeDetails)
*/
default Builder streamModeDetails(Consumer streamModeDetails) {
return streamModeDetails(StreamModeDetails.builder().applyMutation(streamModeDetails).build());
}
/**
*
* 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 method that creates an instance of the
* {@link software.amazon.awssdk.services.kinesis.model.Shard.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.kinesis.model.Shard#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.kinesis.model.Shard.Builder#build()} is called immediately and its
* result is passed to {@link #shards(List)}.
*
* @param shards
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.kinesis.model.Shard.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #shards(java.util.Collection)
*/
Builder shards(Consumer... shards);
/**
*
* If set to true, more shards in the stream are available to describe.
*
*
* @param hasMoreShards
* If set to true, more shards in the stream are available to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder hasMoreShards(Boolean hasMoreShards);
/**
*
* The current retention period, in hours. Minimum value of 24. Maximum value of 168.
*
*
* @param retentionPeriodHours
* The current retention period, in hours. Minimum value of 24. Maximum value of 168.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder retentionPeriodHours(Integer retentionPeriodHours);
/**
*
* The approximate time that the stream was created.
*
*
* @param streamCreationTimestamp
* The approximate time that the stream was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder streamCreationTimestamp(Instant streamCreationTimestamp);
/**
*
* Represents the current enhanced monitoring settings of the stream.
*
*
* @param enhancedMonitoring
* Represents the current enhanced monitoring settings of the stream.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder enhancedMonitoring(Collection enhancedMonitoring);
/**
*
* Represents the current enhanced monitoring settings of the stream.
*
*
* @param enhancedMonitoring
* Represents the current enhanced monitoring settings of the stream.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder enhancedMonitoring(EnhancedMetrics... enhancedMonitoring);
/**
*
* Represents the current enhanced monitoring settings of the stream.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.kinesis.model.EnhancedMetrics.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.kinesis.model.EnhancedMetrics#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.kinesis.model.EnhancedMetrics.Builder#build()} is called immediately
* and its result is passed to {@link #enhancedMonitoring(List)}.
*
* @param enhancedMonitoring
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.kinesis.model.EnhancedMetrics.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #enhancedMonitoring(java.util.Collection)
*/
Builder enhancedMonitoring(Consumer... enhancedMonitoring);
/**
*
* The server-side encryption type used on the stream. This parameter can be one of the following values:
*
*
* -
*
* NONE: Do not encrypt the records in the stream.
*
*
* -
*
* KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web
* Services KMS key.
*
*
*
*
* @param encryptionType
* The server-side encryption type used on the stream. This parameter can be one of the following
* values:
*
* -
*
* NONE: Do not encrypt the records in the stream.
*
*
* -
*
* KMS: Use server-side encryption on the records in the stream using a customer-managed
* Amazon Web Services KMS key.
*
*
* @see EncryptionType
* @return Returns a reference to this object so that method calls can be chained together.
* @see EncryptionType
*/
Builder encryptionType(String encryptionType);
/**
*
* The server-side encryption type used on the stream. This parameter can be one of the following values:
*
*
* -
*
* NONE: Do not encrypt the records in the stream.
*
*
* -
*
* KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web
* Services KMS key.
*
*
*
*
* @param encryptionType
* The server-side encryption type used on the stream. This parameter can be one of the following
* values:
*
* -
*
* NONE: Do not encrypt the records in the stream.
*
*
* -
*
* KMS: Use server-side encryption on the records in the stream using a customer-managed
* Amazon Web Services KMS key.
*
*
* @see EncryptionType
* @return Returns a reference to this object so that method calls can be chained together.
* @see EncryptionType
*/
Builder encryptionType(EncryptionType encryptionType);
/**
*
* The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be a
* globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by
* "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias
* aws/kinesis.
*
*
* -
*
* Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
*
*
* -
*
* Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
*
*
* -
*
* Globally unique key ID example: 12345678-1234-1234-1234-123456789012
*
*
* -
*
* Alias name example: alias/MyAliasName
*
*
* -
*
* Master key owned by Kinesis Data Streams: alias/aws/kinesis
*
*
*
*
* @param keyId
* The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be
* a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name
* prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the
* alias aws/kinesis.
*
* -
*
* Key ARN example:
* arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
*
*
* -
*
* Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
*
*
* -
*
* Globally unique key ID example: 12345678-1234-1234-1234-123456789012
*
*
* -
*
* Alias name example: alias/MyAliasName
*
*
* -
*
* Master key owned by Kinesis Data Streams: alias/aws/kinesis
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keyId(String keyId);
}
static final class BuilderImpl implements Builder {
private String streamName;
private String streamARN;
private String streamStatus;
private StreamModeDetails streamModeDetails;
private List shards = DefaultSdkAutoConstructList.getInstance();
private Boolean hasMoreShards;
private Integer retentionPeriodHours;
private Instant streamCreationTimestamp;
private List enhancedMonitoring = DefaultSdkAutoConstructList.getInstance();
private String encryptionType;
private String keyId;
private BuilderImpl() {
}
private BuilderImpl(StreamDescription model) {
streamName(model.streamName);
streamARN(model.streamARN);
streamStatus(model.streamStatus);
streamModeDetails(model.streamModeDetails);
shards(model.shards);
hasMoreShards(model.hasMoreShards);
retentionPeriodHours(model.retentionPeriodHours);
streamCreationTimestamp(model.streamCreationTimestamp);
enhancedMonitoring(model.enhancedMonitoring);
encryptionType(model.encryptionType);
keyId(model.keyId);
}
public final String getStreamName() {
return streamName;
}
public final void setStreamName(String streamName) {
this.streamName = streamName;
}
@Override
public final Builder streamName(String streamName) {
this.streamName = streamName;
return this;
}
public final String getStreamARN() {
return streamARN;
}
public final void setStreamARN(String streamARN) {
this.streamARN = streamARN;
}
@Override
public final Builder streamARN(String streamARN) {
this.streamARN = streamARN;
return this;
}
public final String getStreamStatus() {
return streamStatus;
}
public final void setStreamStatus(String streamStatus) {
this.streamStatus = 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 StreamModeDetails.Builder getStreamModeDetails() {
return streamModeDetails != null ? streamModeDetails.toBuilder() : null;
}
public final void setStreamModeDetails(StreamModeDetails.BuilderImpl streamModeDetails) {
this.streamModeDetails = streamModeDetails != null ? streamModeDetails.build() : null;
}
@Override
public final Builder streamModeDetails(StreamModeDetails streamModeDetails) {
this.streamModeDetails = streamModeDetails;
return this;
}
public final List getShards() {
List result = ShardListCopier.copyToBuilder(this.shards);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setShards(Collection shards) {
this.shards = ShardListCopier.copyFromBuilder(shards);
}
@Override
public final Builder shards(Collection shards) {
this.shards = ShardListCopier.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 Boolean getHasMoreShards() {
return hasMoreShards;
}
public final void setHasMoreShards(Boolean hasMoreShards) {
this.hasMoreShards = hasMoreShards;
}
@Override
public final Builder hasMoreShards(Boolean hasMoreShards) {
this.hasMoreShards = hasMoreShards;
return this;
}
public final Integer getRetentionPeriodHours() {
return retentionPeriodHours;
}
public final void setRetentionPeriodHours(Integer retentionPeriodHours) {
this.retentionPeriodHours = retentionPeriodHours;
}
@Override
public final Builder retentionPeriodHours(Integer retentionPeriodHours) {
this.retentionPeriodHours = retentionPeriodHours;
return this;
}
public final Instant getStreamCreationTimestamp() {
return streamCreationTimestamp;
}
public final void setStreamCreationTimestamp(Instant streamCreationTimestamp) {
this.streamCreationTimestamp = streamCreationTimestamp;
}
@Override
public final Builder streamCreationTimestamp(Instant streamCreationTimestamp) {
this.streamCreationTimestamp = streamCreationTimestamp;
return this;
}
public final List getEnhancedMonitoring() {
List result = EnhancedMonitoringListCopier.copyToBuilder(this.enhancedMonitoring);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setEnhancedMonitoring(Collection enhancedMonitoring) {
this.enhancedMonitoring = EnhancedMonitoringListCopier.copyFromBuilder(enhancedMonitoring);
}
@Override
public final Builder enhancedMonitoring(Collection enhancedMonitoring) {
this.enhancedMonitoring = EnhancedMonitoringListCopier.copy(enhancedMonitoring);
return this;
}
@Override
@SafeVarargs
public final Builder enhancedMonitoring(EnhancedMetrics... enhancedMonitoring) {
enhancedMonitoring(Arrays.asList(enhancedMonitoring));
return this;
}
@Override
@SafeVarargs
public final Builder enhancedMonitoring(Consumer... enhancedMonitoring) {
enhancedMonitoring(Stream.of(enhancedMonitoring).map(c -> EnhancedMetrics.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getEncryptionType() {
return encryptionType;
}
public final void setEncryptionType(String encryptionType) {
this.encryptionType = encryptionType;
}
@Override
public final Builder encryptionType(String encryptionType) {
this.encryptionType = encryptionType;
return this;
}
@Override
public final Builder encryptionType(EncryptionType encryptionType) {
this.encryptionType(encryptionType == null ? null : encryptionType.toString());
return this;
}
public final String getKeyId() {
return keyId;
}
public final void setKeyId(String keyId) {
this.keyId = keyId;
}
@Override
public final Builder keyId(String keyId) {
this.keyId = keyId;
return this;
}
@Override
public StreamDescription build() {
return new StreamDescription(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}