public class StreamDescription
extends java.lang.Object
implements java.io.Serializable
Represents the output for DescribeStream.
Constructor and Description |
---|
StreamDescription() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getEncryptionType()
The server-side encryption type used on the stream.
|
java.util.List<EnhancedMetrics> |
getEnhancedMonitoring()
Represents the current enhanced monitoring settings of the stream.
|
java.lang.Boolean |
getHasMoreShards()
If set to
true , more shards in the stream are available to
describe. |
java.lang.String |
getKeyId()
The GUID for the customer-managed AWS KMS key to use for encryption.
|
java.lang.Integer |
getRetentionPeriodHours()
The current retention period, in hours.
|
java.util.List<Shard> |
getShards()
The shards that comprise the stream.
|
java.lang.String |
getStreamARN()
The Amazon Resource Name (ARN) for the stream being described.
|
java.util.Date |
getStreamCreationTimestamp()
The approximate time that the stream was created.
|
java.lang.String |
getStreamName()
The name of the stream being described.
|
java.lang.String |
getStreamStatus()
The current status of the stream being described.
|
int |
hashCode() |
java.lang.Boolean |
isHasMoreShards()
If set to
true , more shards in the stream are available to
describe. |
void |
setEncryptionType(EncryptionType encryptionType)
The server-side encryption type used on the stream.
|
void |
setEncryptionType(java.lang.String encryptionType)
The server-side encryption type used on the stream.
|
void |
setEnhancedMonitoring(java.util.Collection<EnhancedMetrics> enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
|
void |
setHasMoreShards(java.lang.Boolean hasMoreShards)
If set to
true , more shards in the stream are available to
describe. |
void |
setKeyId(java.lang.String keyId)
The GUID for the customer-managed AWS KMS key to use for encryption.
|
void |
setRetentionPeriodHours(java.lang.Integer retentionPeriodHours)
The current retention period, in hours.
|
void |
setShards(java.util.Collection<Shard> shards)
The shards that comprise the stream.
|
void |
setStreamARN(java.lang.String streamARN)
The Amazon Resource Name (ARN) for the stream being described.
|
void |
setStreamCreationTimestamp(java.util.Date streamCreationTimestamp)
The approximate time that the stream was created.
|
void |
setStreamName(java.lang.String streamName)
The name of the stream being described.
|
void |
setStreamStatus(StreamStatus streamStatus)
The current status of the stream being described.
|
void |
setStreamStatus(java.lang.String streamStatus)
The current status of the stream being described.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
StreamDescription |
withEncryptionType(EncryptionType encryptionType)
The server-side encryption type used on the stream.
|
StreamDescription |
withEncryptionType(java.lang.String encryptionType)
The server-side encryption type used on the stream.
|
StreamDescription |
withEnhancedMonitoring(java.util.Collection<EnhancedMetrics> enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
|
StreamDescription |
withEnhancedMonitoring(EnhancedMetrics... enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
|
StreamDescription |
withHasMoreShards(java.lang.Boolean hasMoreShards)
If set to
true , more shards in the stream are available to
describe. |
StreamDescription |
withKeyId(java.lang.String keyId)
The GUID for the customer-managed AWS KMS key to use for encryption.
|
StreamDescription |
withRetentionPeriodHours(java.lang.Integer retentionPeriodHours)
The current retention period, in hours.
|
StreamDescription |
withShards(java.util.Collection<Shard> shards)
The shards that comprise the stream.
|
StreamDescription |
withShards(Shard... shards)
The shards that comprise the stream.
|
StreamDescription |
withStreamARN(java.lang.String streamARN)
The Amazon Resource Name (ARN) for the stream being described.
|
StreamDescription |
withStreamCreationTimestamp(java.util.Date streamCreationTimestamp)
The approximate time that the stream was created.
|
StreamDescription |
withStreamName(java.lang.String streamName)
The name of the stream being described.
|
StreamDescription |
withStreamStatus(StreamStatus streamStatus)
The current status of the stream being described.
|
StreamDescription |
withStreamStatus(java.lang.String streamStatus)
The current status of the stream being described.
|
public java.lang.String getStreamName()
The name of the stream being described.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
The name of the stream being described.
public void setStreamName(java.lang.String streamName)
The name of the stream being described.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
streamName
- The name of the stream being described.
public StreamDescription withStreamName(java.lang.String streamName)
The name of the stream being described.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
streamName
- The name of the stream being described.
public java.lang.String getStreamARN()
The Amazon Resource Name (ARN) for the stream being described.
The Amazon Resource Name (ARN) for the stream being described.
public void setStreamARN(java.lang.String streamARN)
The Amazon Resource Name (ARN) for the stream being described.
streamARN
- The Amazon Resource Name (ARN) for the stream being described.
public StreamDescription withStreamARN(java.lang.String streamARN)
The Amazon Resource Name (ARN) for the stream being described.
Returns a reference to this object so that method calls can be chained together.
streamARN
- The Amazon Resource Name (ARN) for the stream being described.
public java.lang.String getStreamStatus()
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.
Constraints:
Allowed Values: CREATING, DELETING, ACTIVE, UPDATING
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.
StreamStatus
public void setStreamStatus(java.lang.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.
Constraints:
Allowed Values: CREATING, DELETING, ACTIVE, UPDATING
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.
StreamStatus
public StreamDescription withStreamStatus(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CREATING, DELETING, ACTIVE, UPDATING
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.
StreamStatus
public void setStreamStatus(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.
Constraints:
Allowed Values: CREATING, DELETING, ACTIVE, UPDATING
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.
StreamStatus
public StreamDescription withStreamStatus(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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: CREATING, DELETING, ACTIVE, UPDATING
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.
StreamStatus
public java.util.List<Shard> getShards()
The shards that comprise the stream.
The shards that comprise the stream.
public void setShards(java.util.Collection<Shard> shards)
The shards that comprise the stream.
shards
- The shards that comprise the stream.
public StreamDescription withShards(Shard... shards)
The shards that comprise the stream.
Returns a reference to this object so that method calls can be chained together.
shards
- The shards that comprise the stream.
public StreamDescription withShards(java.util.Collection<Shard> shards)
The shards that comprise the stream.
Returns a reference to this object so that method calls can be chained together.
shards
- The shards that comprise the stream.
public java.lang.Boolean isHasMoreShards()
If set to true
, more shards in the stream are available to
describe.
If set to true
, more shards in the stream are
available to describe.
public java.lang.Boolean getHasMoreShards()
If set to true
, more shards in the stream are available to
describe.
If set to true
, more shards in the stream are
available to describe.
public void setHasMoreShards(java.lang.Boolean hasMoreShards)
If set to true
, more shards in the stream are available to
describe.
hasMoreShards
-
If set to true
, more shards in the stream are
available to describe.
public StreamDescription withHasMoreShards(java.lang.Boolean hasMoreShards)
If set to true
, more shards in the stream are available to
describe.
Returns a reference to this object so that method calls can be chained together.
hasMoreShards
-
If set to true
, more shards in the stream are
available to describe.
public java.lang.Integer getRetentionPeriodHours()
The current retention period, in hours.
Constraints:
Range: 1 - 168
The current retention period, in hours.
public void setRetentionPeriodHours(java.lang.Integer retentionPeriodHours)
The current retention period, in hours.
Constraints:
Range: 1 - 168
retentionPeriodHours
- The current retention period, in hours.
public StreamDescription withRetentionPeriodHours(java.lang.Integer retentionPeriodHours)
The current retention period, in hours.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 - 168
retentionPeriodHours
- The current retention period, in hours.
public java.util.Date getStreamCreationTimestamp()
The approximate time that the stream was created.
The approximate time that the stream was created.
public void setStreamCreationTimestamp(java.util.Date streamCreationTimestamp)
The approximate time that the stream was created.
streamCreationTimestamp
- The approximate time that the stream was created.
public StreamDescription withStreamCreationTimestamp(java.util.Date streamCreationTimestamp)
The approximate time that the stream was created.
Returns a reference to this object so that method calls can be chained together.
streamCreationTimestamp
- The approximate time that the stream was created.
public java.util.List<EnhancedMetrics> getEnhancedMonitoring()
Represents the current enhanced monitoring settings of the stream.
Represents the current enhanced monitoring settings of the stream.
public void setEnhancedMonitoring(java.util.Collection<EnhancedMetrics> enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
enhancedMonitoring
- Represents the current enhanced monitoring settings of the stream.
public StreamDescription withEnhancedMonitoring(EnhancedMetrics... enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
Returns a reference to this object so that method calls can be chained together.
enhancedMonitoring
- Represents the current enhanced monitoring settings of the stream.
public StreamDescription withEnhancedMonitoring(java.util.Collection<EnhancedMetrics> enhancedMonitoring)
Represents the current enhanced monitoring settings of the stream.
Returns a reference to this object so that method calls can be chained together.
enhancedMonitoring
- Represents the current enhanced monitoring settings of the stream.
public java.lang.String getEncryptionType()
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 AWS KMS key.
Constraints:
Allowed Values: NONE, KMS
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 AWS KMS key.
EncryptionType
public void setEncryptionType(java.lang.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 AWS KMS key.
Constraints:
Allowed Values: NONE, KMS
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 AWS KMS key.
EncryptionType
public StreamDescription withEncryptionType(java.lang.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 AWS KMS key.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: NONE, KMS
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 AWS KMS key.
EncryptionType
public void setEncryptionType(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 AWS KMS key.
Constraints:
Allowed Values: NONE, KMS
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 AWS KMS key.
EncryptionType
public StreamDescription withEncryptionType(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 AWS KMS key.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: NONE, KMS
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 AWS KMS key.
EncryptionType
public java.lang.String getKeyId()
The GUID for the customer-managed AWS 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
Constraints:
Length: 1 - 2048
The GUID for the customer-managed AWS 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 void setKeyId(java.lang.String keyId)
The GUID for the customer-managed AWS 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
Constraints:
Length: 1 - 2048
keyId
-
The GUID for the customer-managed AWS 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 StreamDescription withKeyId(java.lang.String keyId)
The GUID for the customer-managed AWS 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 a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 2048
keyId
-
The GUID for the customer-managed AWS 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 java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.