Class EnhancedMetrics
- java.lang.Object
-
- software.amazon.awssdk.services.kinesis.model.EnhancedMetrics
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EnhancedMetrics.Builder,EnhancedMetrics>
@Generated("software.amazon.awssdk:codegen") public final class EnhancedMetrics extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EnhancedMetrics.Builder,EnhancedMetrics>
Represents enhanced metrics types.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
EnhancedMetrics.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static EnhancedMetrics.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasShardLevelMetrics()
For responses, this returns true if the service returned a value for the ShardLevelMetrics property.List<SdkField<?>>
sdkFields()
static Class<? extends EnhancedMetrics.Builder>
serializableBuilderClass()
List<MetricsName>
shardLevelMetrics()
List of shard-level metrics.List<String>
shardLevelMetricsAsStrings()
List of shard-level metrics.EnhancedMetrics.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
shardLevelMetrics
public final List<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 Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasShardLevelMetrics()
method.- 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 Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.
-
-
-
hasShardLevelMetrics
public final boolean hasShardLevelMetrics()
For responses, this returns true if the service returned a value for the ShardLevelMetrics property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
shardLevelMetricsAsStrings
public final List<String> shardLevelMetricsAsStrings()
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 Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasShardLevelMetrics()
method.- 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 Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.
-
-
-
toBuilder
public EnhancedMetrics.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<EnhancedMetrics.Builder,EnhancedMetrics>
-
builder
public static EnhancedMetrics.Builder builder()
-
serializableBuilderClass
public static Class<? extends EnhancedMetrics.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-