com.amazonaws.services.kinesis.model.EnableEnhancedMonitoringRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
* Copyright 2011-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not
* use this file except in compliance with the License. A copy of the License is
* located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.kinesis.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Represents the input for EnableEnhancedMonitoring.
*
*/
public class EnableEnhancedMonitoringRequest extends AmazonWebServiceRequest
implements Serializable, Cloneable {
/**
*
* The name of the stream for which to enable enhanced monitoring.
*
*/
private String streamName;
/**
*
* 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.
*
*/
private com.amazonaws.internal.SdkInternalList shardLevelMetrics;
/**
*
* The name of the stream for which to enable enhanced monitoring.
*
*
* @param streamName
* The name of the stream for which to enable enhanced monitoring.
*/
public void setStreamName(String streamName) {
this.streamName = streamName;
}
/**
*
* The name of the stream for which to enable enhanced monitoring.
*
*
* @return The name of the stream for which to enable enhanced monitoring.
*/
public String getStreamName() {
return this.streamName;
}
/**
*
* The name of the stream for which to enable enhanced monitoring.
*
*
* @param streamName
* The name of the stream for which to enable enhanced monitoring.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public EnableEnhancedMonitoringRequest withStreamName(String streamName) {
setStreamName(streamName);
return this;
}
/**
*
* 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.
*
*
* @return 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 MetricsName
*/
public java.util.List getShardLevelMetrics() {
if (shardLevelMetrics == null) {
shardLevelMetrics = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
* @param 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 MetricsName
*/
public void setShardLevelMetrics(
java.util.Collection shardLevelMetrics) {
if (shardLevelMetrics == null) {
this.shardLevelMetrics = null;
return;
}
this.shardLevelMetrics = new com.amazonaws.internal.SdkInternalList(
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 {@link #setShardLevelMetrics(java.util.Collection)} or
* {@link #withShardLevelMetrics(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see MetricsName
*/
public EnableEnhancedMonitoringRequest withShardLevelMetrics(
String... shardLevelMetrics) {
if (this.shardLevelMetrics == null) {
setShardLevelMetrics(new com.amazonaws.internal.SdkInternalList(
shardLevelMetrics.length));
}
for (String ele : shardLevelMetrics) {
this.shardLevelMetrics.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see MetricsName
*/
public EnableEnhancedMonitoringRequest withShardLevelMetrics(
java.util.Collection shardLevelMetrics) {
setShardLevelMetrics(shardLevelMetrics);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see MetricsName
*/
public EnableEnhancedMonitoringRequest withShardLevelMetrics(
MetricsName... shardLevelMetrics) {
com.amazonaws.internal.SdkInternalList shardLevelMetricsCopy = new com.amazonaws.internal.SdkInternalList(
shardLevelMetrics.length);
for (MetricsName value : shardLevelMetrics) {
shardLevelMetricsCopy.add(value.toString());
}
if (getShardLevelMetrics() == null) {
setShardLevelMetrics(shardLevelMetricsCopy);
} else {
getShardLevelMetrics().addAll(shardLevelMetricsCopy);
}
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getStreamName() != null)
sb.append("StreamName: " + getStreamName() + ",");
if (getShardLevelMetrics() != null)
sb.append("ShardLevelMetrics: " + getShardLevelMetrics());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof EnableEnhancedMonitoringRequest == false)
return false;
EnableEnhancedMonitoringRequest other = (EnableEnhancedMonitoringRequest) obj;
if (other.getStreamName() == null ^ this.getStreamName() == null)
return false;
if (other.getStreamName() != null
&& other.getStreamName().equals(this.getStreamName()) == false)
return false;
if (other.getShardLevelMetrics() == null
^ this.getShardLevelMetrics() == null)
return false;
if (other.getShardLevelMetrics() != null
&& other.getShardLevelMetrics().equals(
this.getShardLevelMetrics()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode
+ ((getStreamName() == null) ? 0 : getStreamName().hashCode());
hashCode = prime
* hashCode
+ ((getShardLevelMetrics() == null) ? 0
: getShardLevelMetrics().hashCode());
return hashCode;
}
@Override
public EnableEnhancedMonitoringRequest clone() {
return (EnableEnhancedMonitoringRequest) super.clone();
}
}