Package com.amazonaws.services.kinesis.model

Class EnableEnhancedMonitoringRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesis.model.EnableEnhancedMonitoringRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class EnableEnhancedMonitoringRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input for EnableEnhancedMonitoring.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
EnableEnhancedMonitoringRequest()

Method Summary

Modifier and Type	Method	Description
EnableEnhancedMonitoringRequest	clone()	Creates a shallow clone of this request.
boolean	equals(Object obj)
List<String>	getShardLevelMetrics()	List of shard-level metrics to enable.
String	getStreamName()	The name of the stream for which to enable enhanced monitoring.
int	hashCode()
void	setShardLevelMetrics(Collection<String> shardLevelMetrics)	List of shard-level metrics to enable.
void	setStreamName(String streamName)	The name of the stream for which to enable enhanced monitoring.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
EnableEnhancedMonitoringRequest	withShardLevelMetrics(MetricsName... shardLevelMetrics)	List of shard-level metrics to enable.
EnableEnhancedMonitoringRequest	withShardLevelMetrics(String... shardLevelMetrics)	List of shard-level metrics to enable.
EnableEnhancedMonitoringRequest	withShardLevelMetrics(Collection<String> shardLevelMetrics)	List of shard-level metrics to enable.
EnableEnhancedMonitoringRequest	withStreamName(String streamName)	The name of the stream for which to enable enhanced monitoring.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

EnableEnhancedMonitoringRequest

public EnableEnhancedMonitoringRequest()

Method Detail

setStreamName

public void setStreamName(String streamName)

The name of the stream for which to enable enhanced monitoring.

Parameters:

streamName - The name of the stream for which to enable enhanced monitoring.

getStreamName

public String getStreamName()

The name of the stream for which to enable enhanced monitoring.

Returns:

The name of the stream for which to enable enhanced monitoring.

withStreamName

public EnableEnhancedMonitoringRequest withStreamName(String streamName)

The name of the stream for which to enable enhanced monitoring.

Parameters:

streamName - The name of the stream for which to enable enhanced monitoring.

Returns:

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

getShardLevelMetrics

public List<String> getShardLevelMetrics()

List of shard-level metrics to enable.

The following are the valid shard-level metrics. The value " ALL" enables 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 to enable.

The following are the valid shard-level metrics. The value " ALL" enables 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 to enable.

The following are the valid shard-level metrics. The value " ALL" enables 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 to enable.

The following are the valid shard-level metrics. The value " ALL" enables 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 EnableEnhancedMonitoringRequest withShardLevelMetrics(String... shardLevelMetrics)

List of shard-level metrics to enable.

The following are the valid shard-level metrics. The value " ALL" enables 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 to enable.

The following are the valid shard-level metrics. The value " ALL" enables 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 EnableEnhancedMonitoringRequest withShardLevelMetrics(Collection<String> shardLevelMetrics)

List of shard-level metrics to enable.

The following are the valid shard-level metrics. The value " ALL" enables 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 to enable.

The following are the valid shard-level metrics. The value " ALL" enables 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 EnableEnhancedMonitoringRequest withShardLevelMetrics(MetricsName... shardLevelMetrics)

List of shard-level metrics to enable.

The following are the valid shard-level metrics. The value " ALL" enables 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 to enable.

The following are the valid shard-level metrics. The value " ALL" enables 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 EnableEnhancedMonitoringRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()