software.amazon.awssdk.services.kinesis.model.EnhancedMetrics Maven / Gradle / Ivy
/*
* Copyright 2013-2018 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 software.amazon.awssdk.services.kinesis.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.core.protocol.ProtocolMarshaller;
import software.amazon.awssdk.core.protocol.StructuredPojo;
import software.amazon.awssdk.core.runtime.TypeConverter;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.services.kinesis.transform.EnhancedMetricsMarshaller;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Represents enhanced metrics types.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class EnhancedMetrics implements StructuredPojo, ToCopyableBuilder {
private final List shardLevelMetrics;
private EnhancedMetrics(BuilderImpl builder) {
this.shardLevelMetrics = builder.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.
*
*
* @return 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.
*/
public List shardLevelMetrics() {
return TypeConverter.convert(shardLevelMetrics, MetricsName::fromValue);
}
/**
*
* 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.
*
*
* @return 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.
*/
public List shardLevelMetricsAsStrings() {
return shardLevelMetrics;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(shardLevelMetricsAsStrings());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof EnhancedMetrics)) {
return false;
}
EnhancedMetrics other = (EnhancedMetrics) obj;
return Objects.equals(shardLevelMetricsAsStrings(), other.shardLevelMetricsAsStrings());
}
@Override
public String toString() {
return ToString.builder("EnhancedMetrics").add("ShardLevelMetrics", shardLevelMetricsAsStrings()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ShardLevelMetrics":
return Optional.ofNullable(clazz.cast(shardLevelMetricsAsStrings()));
default:
return Optional.empty();
}
}
@SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
EnhancedMetricsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
public interface Builder extends CopyableBuilder {
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder shardLevelMetricsWithStrings(Collection 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder shardLevelMetricsWithStrings(String... 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder shardLevelMetrics(Collection 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder shardLevelMetrics(MetricsName... shardLevelMetrics);
}
static final class BuilderImpl implements Builder {
private List shardLevelMetrics = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(EnhancedMetrics model) {
shardLevelMetricsWithStrings(model.shardLevelMetrics);
}
public final Collection getShardLevelMetrics() {
return shardLevelMetrics;
}
@Override
public final Builder shardLevelMetricsWithStrings(Collection shardLevelMetrics) {
this.shardLevelMetrics = MetricsNameListCopier.copy(shardLevelMetrics);
return this;
}
@Override
@SafeVarargs
public final Builder shardLevelMetricsWithStrings(String... shardLevelMetrics) {
shardLevelMetricsWithStrings(Arrays.asList(shardLevelMetrics));
return this;
}
@Override
public final Builder shardLevelMetrics(Collection shardLevelMetrics) {
this.shardLevelMetrics = MetricsNameListCopier.copyEnumToString(shardLevelMetrics);
return this;
}
@Override
@SafeVarargs
public final Builder shardLevelMetrics(MetricsName... shardLevelMetrics) {
shardLevelMetrics(Arrays.asList(shardLevelMetrics));
return this;
}
public final void setShardLevelMetrics(Collection shardLevelMetrics) {
this.shardLevelMetrics = MetricsNameListCopier.copy(shardLevelMetrics);
}
@Override
public EnhancedMetrics build() {
return new EnhancedMetrics(this);
}
}
}