Class EnhancedMetrics

java.lang.Object

com.amazonaws.services.kinesis.model.EnhancedMetrics

All Implemented Interfaces:

Serializable, Cloneable

public class EnhancedMetrics
extends Object
implements Serializable, Cloneable

Represents enhanced metrics types.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
EnhancedMetrics()

Method Summary

Modifier and Type	Method	Description
EnhancedMetrics	clone()
boolean	equals(Object obj)
List<String>	getShardLevelMetrics()	List of shard-level metrics.
int	hashCode()
void	setShardLevelMetrics(Collection<String> shardLevelMetrics)	List of shard-level metrics.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
EnhancedMetrics	withShardLevelMetrics(MetricsName... shardLevelMetrics)	List of shard-level metrics.
EnhancedMetrics	withShardLevelMetrics(String... shardLevelMetrics)	List of shard-level metrics.
EnhancedMetrics	withShardLevelMetrics(Collection<String> shardLevelMetrics)	List of shard-level metrics.

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

EnhancedMetrics

public EnhancedMetrics()

Method Details

getShardLevelMetrics

public List<String> getShardLevelMetrics()

List of shard-level metrics.

The following are the valid shard-level metrics. The value " ALL" enhances every metric.

• IncomingBytes
• IncomingRecords
• OutgoingBytes
• OutgoingRecords
• WriteProvisionedThroughputExceeded
• ReadProvisionedThroughputExceeded
• IteratorAgeMilliseconds
• ALL

For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch in the Amazon Kinesis Streams Developer Guide.

Returns:

List of shard-level metrics.

The following are the valid shard-level metrics. The value " ALL" enhances every metric.

• IncomingBytes
• IncomingRecords
• OutgoingBytes
• OutgoingRecords
• WriteProvisionedThroughputExceeded
• ReadProvisionedThroughputExceeded
• IteratorAgeMilliseconds
• ALL

For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch in the Amazon Kinesis Streams Developer Guide.

See Also:

• MetricsName

setShardLevelMetrics

public void setShardLevelMetrics(Collection<String> shardLevelMetrics)

List of shard-level metrics.

The following are the valid shard-level metrics. The value " ALL" enhances every metric.

• IncomingBytes
• IncomingRecords
• OutgoingBytes
• OutgoingRecords
• WriteProvisionedThroughputExceeded
• ReadProvisionedThroughputExceeded
• IteratorAgeMilliseconds
• ALL

For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch in the Amazon Kinesis Streams Developer Guide.

Parameters:

shardLevelMetrics - List of shard-level metrics.

The following are the valid shard-level metrics. The value " ALL" enhances every metric.

• IncomingBytes
• IncomingRecords
• OutgoingBytes
• OutgoingRecords
• WriteProvisionedThroughputExceeded
• ReadProvisionedThroughputExceeded
• IteratorAgeMilliseconds
• ALL

For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch in the Amazon Kinesis Streams Developer Guide.

See Also:

• MetricsName

withShardLevelMetrics

public EnhancedMetrics withShardLevelMetrics(String... shardLevelMetrics)

List of shard-level metrics.

The following are the valid shard-level metrics. The value " ALL" enhances every metric.

• IncomingBytes
• IncomingRecords
• OutgoingBytes
• OutgoingRecords
• WriteProvisionedThroughputExceeded
• ReadProvisionedThroughputExceeded
• IteratorAgeMilliseconds
• ALL

For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch in the Amazon Kinesis Streams Developer Guide.

NOTE: This method appends the values to the existing list (if any). Use setShardLevelMetrics(java.util.Collection) or withShardLevelMetrics(java.util.Collection) if you want to override the existing values.

Parameters:

shardLevelMetrics - List of shard-level metrics.

The following are the valid shard-level metrics. The value " ALL" enhances every metric.

• IncomingBytes
• IncomingRecords
• OutgoingBytes
• OutgoingRecords
• WriteProvisionedThroughputExceeded
• ReadProvisionedThroughputExceeded
• IteratorAgeMilliseconds
• ALL

For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch in the Amazon Kinesis Streams Developer Guide.

Returns:

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

See Also:

• MetricsName

withShardLevelMetrics

public EnhancedMetrics withShardLevelMetrics(Collection<String> shardLevelMetrics)

List of shard-level metrics.

The following are the valid shard-level metrics. The value " ALL" enhances every metric.

• IncomingBytes
• IncomingRecords
• OutgoingBytes
• OutgoingRecords
• WriteProvisionedThroughputExceeded
• ReadProvisionedThroughputExceeded
• IteratorAgeMilliseconds
• ALL

For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch in the Amazon Kinesis Streams Developer Guide.

Parameters:

shardLevelMetrics - List of shard-level metrics.

The following are the valid shard-level metrics. The value " ALL" enhances every metric.

• IncomingBytes
• IncomingRecords
• OutgoingBytes
• OutgoingRecords
• WriteProvisionedThroughputExceeded
• ReadProvisionedThroughputExceeded
• IteratorAgeMilliseconds
• ALL

For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch in the Amazon Kinesis Streams Developer Guide.

Returns:

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

See Also:

• MetricsName

withShardLevelMetrics

public EnhancedMetrics withShardLevelMetrics(MetricsName... shardLevelMetrics)

List of shard-level metrics.

The following are the valid shard-level metrics. The value " ALL" enhances every metric.

• IncomingBytes
• IncomingRecords
• OutgoingBytes
• OutgoingRecords
• WriteProvisionedThroughputExceeded
• ReadProvisionedThroughputExceeded
• IteratorAgeMilliseconds
• ALL

For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch in the Amazon Kinesis Streams Developer Guide.

Parameters:

shardLevelMetrics - List of shard-level metrics.

The following are the valid shard-level metrics. The value " ALL" enhances every metric.

• IncomingBytes
• IncomingRecords
• OutgoingBytes
• OutgoingRecords
• WriteProvisionedThroughputExceeded
• ReadProvisionedThroughputExceeded
• IteratorAgeMilliseconds
• ALL

For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch in the Amazon Kinesis Streams Developer Guide.

Returns:

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

See Also:

• MetricsName

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

• Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public EnhancedMetrics clone()

Overrides:

clone in class Object