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(value="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 and Description
static interface	EnableEnhancedMonitoringRequest.Builder

Method Summary

Modifier and Type	Method and 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() Returns true if the ShardLevelMetrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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	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 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 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.

You can use hasShardLevelMetrics() to see if a value was sent in this field.

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 boolean hasShardLevelMetrics()

Returns true if the ShardLevelMetrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

shardLevelMetricsAsStrings

public 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.

You can use hasShardLevelMetrics() to see if a value was sent in this field.

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.

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 int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo