software.amazon.awssdk.services.iot.model.MetricToRetain Maven / Gradle / Ivy
Show all versions of iot 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.iot.model;
import java.io.Serializable;
import java.util.Arrays;
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 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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The metric you want to retain. Dimensions are optional.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class MetricToRetain implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField METRIC_FIELD = SdkField. builder(MarshallingType.STRING).memberName("metric")
.getter(getter(MetricToRetain::metric)).setter(setter(Builder::metric))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("metric").build()).build();
private static final SdkField METRIC_DIMENSION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("metricDimension")
.getter(getter(MetricToRetain::metricDimension)).setter(setter(Builder::metricDimension))
.constructor(MetricDimension::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("metricDimension").build()).build();
private static final SdkField EXPORT_METRIC_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("exportMetric").getter(getter(MetricToRetain::exportMetric)).setter(setter(Builder::exportMetric))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("exportMetric").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(METRIC_FIELD,
METRIC_DIMENSION_FIELD, EXPORT_METRIC_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final String metric;
private final MetricDimension metricDimension;
private final Boolean exportMetric;
private MetricToRetain(BuilderImpl builder) {
this.metric = builder.metric;
this.metricDimension = builder.metricDimension;
this.exportMetric = builder.exportMetric;
}
/**
*
* What is measured by the behavior.
*
*
* @return What is measured by the behavior.
*/
public final String metric() {
return metric;
}
/**
*
* The dimension of a metric. This can't be used with custom metrics.
*
*
* @return The dimension of a metric. This can't be used with custom metrics.
*/
public final MetricDimension metricDimension() {
return metricDimension;
}
/**
*
* The value indicates exporting metrics related to the MetricToRetain when it's true.
*
*
* @return The value indicates exporting metrics related to the MetricToRetain when it's true.
*/
public final Boolean exportMetric() {
return exportMetric;
}
@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(metric());
hashCode = 31 * hashCode + Objects.hashCode(metricDimension());
hashCode = 31 * hashCode + Objects.hashCode(exportMetric());
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 MetricToRetain)) {
return false;
}
MetricToRetain other = (MetricToRetain) obj;
return Objects.equals(metric(), other.metric()) && Objects.equals(metricDimension(), other.metricDimension())
&& Objects.equals(exportMetric(), other.exportMetric());
}
/**
* 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("MetricToRetain").add("Metric", metric()).add("MetricDimension", metricDimension())
.add("ExportMetric", exportMetric()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "metric":
return Optional.ofNullable(clazz.cast(metric()));
case "metricDimension":
return Optional.ofNullable(clazz.cast(metricDimension()));
case "exportMetric":
return Optional.ofNullable(clazz.cast(exportMetric()));
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("metric", METRIC_FIELD);
map.put("metricDimension", METRIC_DIMENSION_FIELD);
map.put("exportMetric", EXPORT_METRIC_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((MetricToRetain) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* What is measured by the behavior.
*
*
* @param metric
* What is measured by the behavior.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metric(String metric);
/**
*
* The dimension of a metric. This can't be used with custom metrics.
*
*
* @param metricDimension
* The dimension of a metric. This can't be used with custom metrics.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metricDimension(MetricDimension metricDimension);
/**
*
* The dimension of a metric. This can't be used with custom metrics.
*
* This is a convenience method that creates an instance of the {@link MetricDimension.Builder} avoiding the
* need to create one manually via {@link MetricDimension#builder()}.
*
*
* When the {@link Consumer} completes, {@link MetricDimension.Builder#build()} is called immediately and its
* result is passed to {@link #metricDimension(MetricDimension)}.
*
* @param metricDimension
* a consumer that will call methods on {@link MetricDimension.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #metricDimension(MetricDimension)
*/
default Builder metricDimension(Consumer metricDimension) {
return metricDimension(MetricDimension.builder().applyMutation(metricDimension).build());
}
/**
*
* The value indicates exporting metrics related to the MetricToRetain when it's true.
*
*
* @param exportMetric
* The value indicates exporting metrics related to the MetricToRetain when it's true.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder exportMetric(Boolean exportMetric);
}
static final class BuilderImpl implements Builder {
private String metric;
private MetricDimension metricDimension;
private Boolean exportMetric;
private BuilderImpl() {
}
private BuilderImpl(MetricToRetain model) {
metric(model.metric);
metricDimension(model.metricDimension);
exportMetric(model.exportMetric);
}
public final String getMetric() {
return metric;
}
public final void setMetric(String metric) {
this.metric = metric;
}
@Override
public final Builder metric(String metric) {
this.metric = metric;
return this;
}
public final MetricDimension.Builder getMetricDimension() {
return metricDimension != null ? metricDimension.toBuilder() : null;
}
public final void setMetricDimension(MetricDimension.BuilderImpl metricDimension) {
this.metricDimension = metricDimension != null ? metricDimension.build() : null;
}
@Override
public final Builder metricDimension(MetricDimension metricDimension) {
this.metricDimension = metricDimension;
return this;
}
public final Boolean getExportMetric() {
return exportMetric;
}
public final void setExportMetric(Boolean exportMetric) {
this.exportMetric = exportMetric;
}
@Override
public final Builder exportMetric(Boolean exportMetric) {
this.exportMetric = exportMetric;
return this;
}
@Override
public MetricToRetain build() {
return new MetricToRetain(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}