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

Interface StreamDescription.Builder

    • Method Detail

      • streamName

        StreamDescription.Builder streamName​(String streamName)

        The name of the stream being described.

        Parameters:
        streamName - The name of the stream being described.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • streamARN

        StreamDescription.Builder streamARN​(String streamARN)

        The Amazon Resource Name (ARN) for the stream being described.

        Parameters:
        streamARN - The Amazon Resource Name (ARN) for the stream being described.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • streamStatus

        StreamDescription.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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StreamStatus, StreamStatus

      • streamStatus

        StreamDescription.Builder streamStatus​(StreamStatus 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StreamStatus, StreamStatus

      • streamModeDetails

        StreamDescription.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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • shards

        StreamDescription.Builder shards​(Collection<Shard> shards)

        The shards that comprise the stream.

        Parameters:
        shards - The shards that comprise the stream.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • shards

        StreamDescription.Builder shards​(Shard... shards)

        The shards that comprise the stream.

        Parameters:
        shards - The shards that comprise the stream.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • shards

        StreamDescription.Builder shards​(Consumer<Shard.Builder>... shards)

        The shards that comprise the stream.

        This is a convenience method that creates an instance of the Shard.Builder avoiding the need to create one manually via Shard.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #shards(List).

        Parameters:
        shards - a consumer that will call methods on Shard.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #shards(java.util.Collection)

      • hasMoreShards

        StreamDescription.Builder hasMoreShards​(Boolean hasMoreShards)

        If set to true, more shards in the stream are available to describe.

        Parameters:
        hasMoreShards - If set to true, more shards in the stream are available to describe.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • retentionPeriodHours

        StreamDescription.Builder retentionPeriodHours​(Integer retentionPeriodHours)

        The current retention period, in hours. Minimum value of 24. Maximum value of 168.

        Parameters:
        retentionPeriodHours - The current retention period, in hours. Minimum value of 24. Maximum value of 168.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • streamCreationTimestamp

        StreamDescription.Builder streamCreationTimestamp​(Instant streamCreationTimestamp)

        The approximate time that the stream was created.

        Parameters:
        streamCreationTimestamp - The approximate time that the stream was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enhancedMonitoring

        StreamDescription.Builder enhancedMonitoring​(Collection<EnhancedMetrics> enhancedMonitoring)

        Represents the current enhanced monitoring settings of the stream.

        Parameters:
        enhancedMonitoring - Represents the current enhanced monitoring settings of the stream.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enhancedMonitoring

        StreamDescription.Builder enhancedMonitoring​(EnhancedMetrics... enhancedMonitoring)

        Represents the current enhanced monitoring settings of the stream.

        Parameters:
        enhancedMonitoring - Represents the current enhanced monitoring settings of the stream.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • encryptionType

        StreamDescription.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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EncryptionType, EncryptionType

      • encryptionType

        StreamDescription.Builder encryptionType​(EncryptionType 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EncryptionType, EncryptionType

      • keyId

        StreamDescription.Builder keyId​(String 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

        Parameters:
        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

        Returns:
        Returns a reference to this object so that method calls can be chained together.