software.amazon.awssdk.services.kinesis.model

Interface StreamDescriptionSummary.Builder

All Superinterfaces:

Buildable, CopyableBuilder<StreamDescriptionSummary.Builder,StreamDescriptionSummary>, SdkBuilder<StreamDescriptionSummary.Builder,StreamDescriptionSummary>, SdkPojo

Enclosing class:

StreamDescriptionSummary

public static interface StreamDescriptionSummary.Builder
extends SdkPojo, CopyableBuilder<StreamDescriptionSummary.Builder,StreamDescriptionSummary>

Method Summary

Modifier and Type	Method and Description
StreamDescriptionSummary.Builder	consumerCount(Integer consumerCount) The number of enhanced fan-out consumers registered with the stream.
StreamDescriptionSummary.Builder	encryptionType(EncryptionType encryptionType) The encryption type used.
StreamDescriptionSummary.Builder	encryptionType(String encryptionType) The encryption type used.
StreamDescriptionSummary.Builder	enhancedMonitoring(Collection<EnhancedMetrics> enhancedMonitoring) Represents the current enhanced monitoring settings of the stream.
StreamDescriptionSummary.Builder	enhancedMonitoring(Consumer<EnhancedMetrics.Builder>... enhancedMonitoring) Represents the current enhanced monitoring settings of the stream.
StreamDescriptionSummary.Builder	enhancedMonitoring(EnhancedMetrics... enhancedMonitoring) Represents the current enhanced monitoring settings of the stream.
StreamDescriptionSummary.Builder	keyId(String keyId) The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
StreamDescriptionSummary.Builder	openShardCount(Integer openShardCount) The number of open shards in the stream.
StreamDescriptionSummary.Builder	retentionPeriodHours(Integer retentionPeriodHours) The current retention period, in hours.
StreamDescriptionSummary.Builder	streamARN(String streamARN) The Amazon Resource Name (ARN) for the stream being described.
StreamDescriptionSummary.Builder	streamCreationTimestamp(Instant streamCreationTimestamp) The approximate time that the stream was created.
default StreamDescriptionSummary.Builder	streamModeDetails(Consumer<StreamModeDetails.Builder> streamModeDetails) Specifies the capacity mode to which you want to set your data stream.
StreamDescriptionSummary.Builder	streamModeDetails(StreamModeDetails streamModeDetails) Specifies the capacity mode to which you want to set your data stream.
StreamDescriptionSummary.Builder	streamName(String streamName) The name of the stream being described.
StreamDescriptionSummary.Builder	streamStatus(StreamStatus streamStatus) The current status of the stream being described.
StreamDescriptionSummary.Builder	streamStatus(String streamStatus) The current status of the stream being described.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

streamName

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

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

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

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

StreamDescriptionSummary.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 ycapacity 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 ycapacity 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.

streamModeDetails

default StreamDescriptionSummary.Builder streamModeDetails(Consumer<StreamModeDetails.Builder> 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 ycapacity mode and a provisioned capacity mode for your data streams.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to streamModeDetails(StreamModeDetails).

Parameters:

streamModeDetails - a consumer that will call methods on StreamModeDetails.Builder

Returns:

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

See Also:

streamModeDetails(StreamModeDetails)

retentionPeriodHours

StreamDescriptionSummary.Builder retentionPeriodHours(Integer retentionPeriodHours)

The current retention period, in hours.

Parameters:

retentionPeriodHours - The current retention period, in hours.

Returns:

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

streamCreationTimestamp

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

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

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

enhancedMonitoring

StreamDescriptionSummary.Builder enhancedMonitoring(Consumer<EnhancedMetrics.Builder>... enhancedMonitoring)

Represents the current enhanced monitoring settings of the stream.

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

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

Parameters:

enhancedMonitoring - a consumer that will call methods on EnhancedMetrics.Builder

Returns:

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

See Also:

#enhancedMonitoring(java.util.Collection)

encryptionType

StreamDescriptionSummary.Builder encryptionType(String encryptionType)

The encryption type used. This value is one of the following:

• KMS

• NONE

Parameters:

encryptionType - The encryption type used. This value is one of the following:

• KMS

• NONE

Returns:

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

See Also:

EncryptionType, EncryptionType

encryptionType

StreamDescriptionSummary.Builder encryptionType(EncryptionType encryptionType)

The encryption type used. This value is one of the following:

• KMS

• NONE

Parameters:

encryptionType - The encryption type used. This value is one of the following:

• KMS

• NONE

Returns:

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

See Also:

EncryptionType, EncryptionType

keyId

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

openShardCount

StreamDescriptionSummary.Builder openShardCount(Integer openShardCount)

The number of open shards in the stream.

Parameters:

openShardCount - The number of open shards in the stream.

Returns:

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

consumerCount

StreamDescriptionSummary.Builder consumerCount(Integer consumerCount)

The number of enhanced fan-out consumers registered with the stream.

Parameters:

consumerCount - The number of enhanced fan-out consumers registered with the stream.

Returns:

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