Package software.amazon.awssdk.services.kinesis.model

Class EnableEnhancedMonitoringRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kinesis.model.KinesisRequest

software.amazon.awssdk.services.kinesis.model.EnableEnhancedMonitoringRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<EnableEnhancedMonitoringRequest.Builder,EnableEnhancedMonitoringRequest>

@Generated("software.amazon.awssdk:codegen")
public final class EnableEnhancedMonitoringRequest
extends KinesisRequest
implements ToCopyableBuilder<EnableEnhancedMonitoringRequest.Builder,EnableEnhancedMonitoringRequest>

Represents the input for EnableEnhancedMonitoring.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EnableEnhancedMonitoringRequest.Builder

Method Summary

Modifier and Type	Method	Description
static EnableEnhancedMonitoringRequest.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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends EnableEnhancedMonitoringRequest.Builder>	serializableBuilderClass()
List<MetricsName>	shardLevelMetrics()	List of shard-level metrics to enable.
List<String>	shardLevelMetricsAsStrings()	List of shard-level metrics to enable.
String	streamARN()	The ARN of the stream.
String	streamName()	The name of the stream for which to enable enhanced monitoring.
EnableEnhancedMonitoringRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

streamName

public final String streamName()

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

Returns:

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

shardLevelMetrics

public final List<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 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 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 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 the isEmpty() 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 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 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 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 Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.

streamARN

public final String streamARN()

The ARN of the stream.

Returns:

The ARN of the stream.

toBuilder

public EnableEnhancedMonitoringRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EnableEnhancedMonitoringRequest.Builder,EnableEnhancedMonitoringRequest>

Specified by:

toBuilder in class KinesisRequest

builder

public static EnableEnhancedMonitoringRequest.Builder builder()

serializableBuilderClass

public static Class<? extends EnableEnhancedMonitoringRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo