/* * Copyright 2010-2019 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; /** *

* Enables enhanced Kinesis data stream monitoring for shard-level metrics. *

*/ public class EnableEnhancedMonitoringRequest extends AmazonWebServiceRequest implements Serializable { /** *

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

*

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9_.-]+
*/ private String streamName; /** *

* List of shard-level metrics to enable. *

*

* The following are the valid shard-level metrics. The value " * ALL" enables every metric. *

* *

* For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon * CloudWatch in the Amazon Kinesis Data Streams Developer Guide. *

*/ private java.util.List shardLevelMetrics = new java.util.ArrayList(); /** *

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

*

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9_.-]+
* * @return

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

*/ public String getStreamName() { return streamName; } /** *

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

*

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9_.-]+
* * @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. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9_.-]+
* * @param streamName

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

* @return A reference to this updated object so that method calls can be * chained together. */ public EnableEnhancedMonitoringRequest withStreamName(String streamName) { this.streamName = streamName; return this; } /** *

* List of shard-level metrics to enable. *

*

* The following are the valid shard-level metrics. The value " * ALL" enables every metric. *

* *

* For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon * CloudWatch in the Amazon Kinesis Data 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. *

* *

* For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon * CloudWatch in the Amazon Kinesis Data Streams Developer * Guide. *

*/ public java.util.List getShardLevelMetrics() { 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 Data Streams Service with Amazon * CloudWatch in the Amazon Kinesis Data 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 Data Streams Service with * Amazon CloudWatch in the Amazon Kinesis Data Streams * Developer Guide. *

*/ public void setShardLevelMetrics(java.util.Collection shardLevelMetrics) { if (shardLevelMetrics == null) { this.shardLevelMetrics = null; return; } this.shardLevelMetrics = new java.util.ArrayList(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. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @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 Data Streams Service with * Amazon CloudWatch in the Amazon Kinesis Data Streams * Developer Guide. *

* @return A reference to this updated object so that method calls can be * chained together. */ public EnableEnhancedMonitoringRequest withShardLevelMetrics(String... shardLevelMetrics) { if (getShardLevelMetrics() == null) { this.shardLevelMetrics = new java.util.ArrayList(shardLevelMetrics.length); } for (String value : shardLevelMetrics) { this.shardLevelMetrics.add(value); } 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 Data Streams Service with Amazon * CloudWatch in the Amazon Kinesis Data Streams Developer Guide. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @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 Data Streams Service with * Amazon CloudWatch in the Amazon Kinesis Data Streams * Developer Guide. *

* @return A reference to this updated object so that method calls can be * chained together. */ public EnableEnhancedMonitoringRequest withShardLevelMetrics( java.util.Collection shardLevelMetrics) { setShardLevelMetrics(shardLevelMetrics); 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 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 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; } }