Package software.amazon.awssdk.services.kinesis.model

Class CreateStreamRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.kinesis.model.KinesisRequest
software.amazon.awssdk.services.kinesis.model.CreateStreamRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateStreamRequest.Builder,CreateStreamRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateStreamRequest extends KinesisRequest implements ToCopyableBuilder<CreateStreamRequest.Builder,CreateStreamRequest>

Represents the input for CreateStream.

  • Method Details

    • streamName

      public final String streamName()

      A name to identify the stream. The stream name is scoped to the Amazon Web Services account used by the application that creates the stream. It is also scoped by Amazon Web Services Region. That is, two streams in two different Amazon Web Services accounts can have the same name. Two streams in the same Amazon Web Services account but in two different Regions can also have the same name.

      Returns:
      A name to identify the stream. The stream name is scoped to the Amazon Web Services account used by the application that creates the stream. It is also scoped by Amazon Web Services Region. That is, two streams in two different Amazon Web Services accounts can have the same name. Two streams in the same Amazon Web Services account but in two different Regions can also have the same name.

    • shardCount

      public final Integer shardCount()

      The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.

      Returns:
      The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.

    • streamModeDetails

      public final StreamModeDetails streamModeDetails()

      Indicates the capacity mode of the 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.

      Returns:
      Indicates the capacity mode of the 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.

    • 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 Map<String,String> tags()

      A set of up to 50 key-value pairs to use to create the tags. A tag consists of a required key and an optional value.

      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:
      A set of up to 50 key-value pairs to use to create the tags. A tag consists of a required key and an optional value.

    • warmThroughputMiBps

      public final Integer warmThroughputMiBps()

      The target warm throughput in MB/s that the stream should be scaled to handle. This represents the throughput capacity that will be immediately available for write operations.

      Returns:
      The target warm throughput in MB/s that the stream should be scaled to handle. This represents the throughput capacity that will be immediately available for write operations.

    • maxRecordSizeInKiB

      public final Integer maxRecordSizeInKiB()

      The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.

      Returns:
      The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.

    • toBuilder

      public CreateStreamRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateStreamRequest.Builder,CreateStreamRequest>
      Specified by:
      toBuilder in class KinesisRequest

    • builder

      public static CreateStreamRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateStreamRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo