software.amazon.awssdk.services.cloudwatch.model.MetricStreamStatisticsConfiguration Maven / Gradle / Ivy
Show all versions of cloudwatch Show documentation
/*
* Copyright 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.cloudwatch.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* By default, a metric stream always sends the MAX, MIN, SUM, and
* SAMPLECOUNT statistics for each metric that is streamed. This structure contains information for one
* metric that includes additional statistics in the stream. For more information about statistics, see CloudWatch,
* listed in
* CloudWatch statistics definitions.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class MetricStreamStatisticsConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> INCLUDE_METRICS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("IncludeMetrics")
.getter(getter(MetricStreamStatisticsConfiguration::includeMetrics))
.setter(setter(Builder::includeMetrics))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IncludeMetrics").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(MetricStreamStatisticsMetric::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> ADDITIONAL_STATISTICS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("AdditionalStatistics")
.getter(getter(MetricStreamStatisticsConfiguration::additionalStatistics))
.setter(setter(Builder::additionalStatistics))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AdditionalStatistics").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(INCLUDE_METRICS_FIELD,
ADDITIONAL_STATISTICS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final List includeMetrics;
private final List additionalStatistics;
private MetricStreamStatisticsConfiguration(BuilderImpl builder) {
this.includeMetrics = builder.includeMetrics;
this.additionalStatistics = builder.additionalStatistics;
}
/**
* For responses, this returns true if the service returned a value for the IncludeMetrics property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasIncludeMetrics() {
return includeMetrics != null && !(includeMetrics instanceof SdkAutoConstructList);
}
/**
*
* An array of metric name and namespace pairs that stream the additional statistics listed in the value of the
* AdditionalStatistics parameter. There can be as many as 100 pairs in the array.
*
*
* All metrics that match the combination of metric name and namespace will be streamed with the additional
* statistics, no matter their dimensions.
*
*
* 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 {@link #hasIncludeMetrics} method.
*
*
* @return An array of metric name and namespace pairs that stream the additional statistics listed in the value of
* the AdditionalStatistics parameter. There can be as many as 100 pairs in the array.
*
* All metrics that match the combination of metric name and namespace will be streamed with the additional
* statistics, no matter their dimensions.
*/
public final List includeMetrics() {
return includeMetrics;
}
/**
* For responses, this returns true if the service returned a value for the AdditionalStatistics property. This DOES
* NOT check that the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasAdditionalStatistics() {
return additionalStatistics != null && !(additionalStatistics instanceof SdkAutoConstructList);
}
/**
*
* The list of additional statistics that are to be streamed for the metrics listed in the
* IncludeMetrics array in this structure. This list can include as many as 20 statistics.
*
*
* If the OutputFormat for the stream is opentelemetry1.0 or opentelemetry0.7
* , the only valid values are p?? percentile statistics such as p90,
* p99 and so on.
*
*
* If the OutputFormat for the stream is json, the valid values include the abbreviations
* for all of the statistics listed in
* CloudWatch statistics definitions. For example, this includes tm98, wm90,
* PR(:300), and so on.
*
*
* 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 {@link #hasAdditionalStatistics} method.
*
*
* @return The list of additional statistics that are to be streamed for the metrics listed in the
* IncludeMetrics array in this structure. This list can include as many as 20 statistics.
*
* If the OutputFormat for the stream is opentelemetry1.0 or
* opentelemetry0.7, the only valid values are p?? percentile statistics
* such as p90, p99 and so on.
*
*
* If the OutputFormat for the stream is json, the valid values include the
* abbreviations for all of the statistics listed in
* CloudWatch statistics definitions. For example, this includes tm98, wm90,
* PR(:300), and so on.
*/
public final List additionalStatistics() {
return additionalStatistics;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(hasIncludeMetrics() ? includeMetrics() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasAdditionalStatistics() ? additionalStatistics() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof MetricStreamStatisticsConfiguration)) {
return false;
}
MetricStreamStatisticsConfiguration other = (MetricStreamStatisticsConfiguration) obj;
return hasIncludeMetrics() == other.hasIncludeMetrics() && Objects.equals(includeMetrics(), other.includeMetrics())
&& hasAdditionalStatistics() == other.hasAdditionalStatistics()
&& Objects.equals(additionalStatistics(), other.additionalStatistics());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("MetricStreamStatisticsConfiguration")
.add("IncludeMetrics", hasIncludeMetrics() ? includeMetrics() : null)
.add("AdditionalStatistics", hasAdditionalStatistics() ? additionalStatistics() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "IncludeMetrics":
return Optional.ofNullable(clazz.cast(includeMetrics()));
case "AdditionalStatistics":
return Optional.ofNullable(clazz.cast(additionalStatistics()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("IncludeMetrics", INCLUDE_METRICS_FIELD);
map.put("AdditionalStatistics", ADDITIONAL_STATISTICS_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((MetricStreamStatisticsConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* An array of metric name and namespace pairs that stream the additional statistics listed in the value of the
* AdditionalStatistics parameter. There can be as many as 100 pairs in the array.
*
*
* All metrics that match the combination of metric name and namespace will be streamed with the additional
* statistics, no matter their dimensions.
*
*
* @param includeMetrics
* An array of metric name and namespace pairs that stream the additional statistics listed in the value
* of the AdditionalStatistics parameter. There can be as many as 100 pairs in the
* array.
*
* All metrics that match the combination of metric name and namespace will be streamed with the
* additional statistics, no matter their dimensions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder includeMetrics(Collection includeMetrics);
/**
*
* An array of metric name and namespace pairs that stream the additional statistics listed in the value of the
* AdditionalStatistics parameter. There can be as many as 100 pairs in the array.
*
*
* All metrics that match the combination of metric name and namespace will be streamed with the additional
* statistics, no matter their dimensions.
*
*
* @param includeMetrics
* An array of metric name and namespace pairs that stream the additional statistics listed in the value
* of the AdditionalStatistics parameter. There can be as many as 100 pairs in the
* array.
*
* All metrics that match the combination of metric name and namespace will be streamed with the
* additional statistics, no matter their dimensions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder includeMetrics(MetricStreamStatisticsMetric... includeMetrics);
/**
*
* An array of metric name and namespace pairs that stream the additional statistics listed in the value of the
* AdditionalStatistics parameter. There can be as many as 100 pairs in the array.
*
*
* All metrics that match the combination of metric name and namespace will be streamed with the additional
* statistics, no matter their dimensions.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.cloudwatch.model.MetricStreamStatisticsMetric.Builder} avoiding the
* need to create one manually via
* {@link software.amazon.awssdk.services.cloudwatch.model.MetricStreamStatisticsMetric#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.cloudwatch.model.MetricStreamStatisticsMetric.Builder#build()} is
* called immediately and its result is passed to {@link #includeMetrics(List)}.
*
* @param includeMetrics
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.cloudwatch.model.MetricStreamStatisticsMetric.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #includeMetrics(java.util.Collection)
*/
Builder includeMetrics(Consumer... includeMetrics);
/**
*
* The list of additional statistics that are to be streamed for the metrics listed in the
* IncludeMetrics array in this structure. This list can include as many as 20 statistics.
*
*
* If the OutputFormat for the stream is opentelemetry1.0 or
* opentelemetry0.7, the only valid values are p?? percentile statistics such
* as p90, p99 and so on.
*
*
* If the OutputFormat for the stream is json, the valid values include the
* abbreviations for all of the statistics listed in
* CloudWatch statistics definitions. For example, this includes tm98, wm90,
* PR(:300), and so on.
*
*
* @param additionalStatistics
* The list of additional statistics that are to be streamed for the metrics listed in the
* IncludeMetrics array in this structure. This list can include as many as 20
* statistics.
*
* If the OutputFormat for the stream is opentelemetry1.0 or
* opentelemetry0.7, the only valid values are p?? percentile
* statistics such as p90, p99 and so on.
*
*
* If the OutputFormat for the stream is json, the valid values include the
* abbreviations for all of the statistics listed in
* CloudWatch statistics definitions. For example, this includes tm98,
* wm90, PR(:300), and so on.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder additionalStatistics(Collection additionalStatistics);
/**
*
* The list of additional statistics that are to be streamed for the metrics listed in the
* IncludeMetrics array in this structure. This list can include as many as 20 statistics.
*
*
* If the OutputFormat for the stream is opentelemetry1.0 or
* opentelemetry0.7, the only valid values are p?? percentile statistics such
* as p90, p99 and so on.
*
*
* If the OutputFormat for the stream is json, the valid values include the
* abbreviations for all of the statistics listed in
* CloudWatch statistics definitions. For example, this includes tm98, wm90,
* PR(:300), and so on.
*
*
* @param additionalStatistics
* The list of additional statistics that are to be streamed for the metrics listed in the
* IncludeMetrics array in this structure. This list can include as many as 20
* statistics.
*
* If the OutputFormat for the stream is opentelemetry1.0 or
* opentelemetry0.7, the only valid values are p?? percentile
* statistics such as p90, p99 and so on.
*
*
* If the OutputFormat for the stream is json, the valid values include the
* abbreviations for all of the statistics listed in
* CloudWatch statistics definitions. For example, this includes tm98,
* wm90, PR(:300), and so on.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder additionalStatistics(String... additionalStatistics);
}
static final class BuilderImpl implements Builder {
private List includeMetrics = DefaultSdkAutoConstructList.getInstance();
private List additionalStatistics = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(MetricStreamStatisticsConfiguration model) {
includeMetrics(model.includeMetrics);
additionalStatistics(model.additionalStatistics);
}
public final List getIncludeMetrics() {
List result = MetricStreamStatisticsIncludeMetricsCopier
.copyToBuilder(this.includeMetrics);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setIncludeMetrics(Collection includeMetrics) {
this.includeMetrics = MetricStreamStatisticsIncludeMetricsCopier.copyFromBuilder(includeMetrics);
}
@Override
public final Builder includeMetrics(Collection includeMetrics) {
this.includeMetrics = MetricStreamStatisticsIncludeMetricsCopier.copy(includeMetrics);
return this;
}
@Override
@SafeVarargs
public final Builder includeMetrics(MetricStreamStatisticsMetric... includeMetrics) {
includeMetrics(Arrays.asList(includeMetrics));
return this;
}
@Override
@SafeVarargs
public final Builder includeMetrics(Consumer... includeMetrics) {
includeMetrics(Stream.of(includeMetrics).map(c -> MetricStreamStatisticsMetric.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final Collection getAdditionalStatistics() {
if (additionalStatistics instanceof SdkAutoConstructList) {
return null;
}
return additionalStatistics;
}
public final void setAdditionalStatistics(Collection additionalStatistics) {
this.additionalStatistics = MetricStreamStatisticsAdditionalStatisticsCopier.copy(additionalStatistics);
}
@Override
public final Builder additionalStatistics(Collection additionalStatistics) {
this.additionalStatistics = MetricStreamStatisticsAdditionalStatisticsCopier.copy(additionalStatistics);
return this;
}
@Override
@SafeVarargs
public final Builder additionalStatistics(String... additionalStatistics) {
additionalStatistics(Arrays.asList(additionalStatistics));
return this;
}
@Override
public MetricStreamStatisticsConfiguration build() {
return new MetricStreamStatisticsConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}