EnhancedMetrics (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kinesis.model.EnhancedMetrics

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EnhancedMetrics
extends Object
implements Serializable, Cloneable, StructuredPojo

Represents enhanced metrics types.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EnhancedMetrics()

Constructors
Constructor and Description
`EnhancedMetrics()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EnhancedMetrics`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getShardLevelMetrics()` List of shard-level metrics.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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(Collection<String> shardLevelMetrics)` List of shard-level metrics.
`EnhancedMetrics`	`withShardLevelMetrics(MetricsName... shardLevelMetrics)` List of shard-level metrics.
`EnhancedMetrics`	`withShardLevelMetrics(String... shardLevelMetrics)` List of shard-level metrics.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EnhancedMetrics
```
public EnhancedMetrics()
```
- Method Detail
  - 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
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class EnhancedMetrics

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EnhancedMetrics

Method Detail

getShardLevelMetrics

setShardLevelMetrics

withShardLevelMetrics

withShardLevelMetrics

withShardLevelMetrics

toString

equals

hashCode

clone

marshall