software.amazon.awssdk.services.iot.model.CreateCustomMetricRequest Maven / Gradle / Ivy
/*
* 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.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
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.awscore.AwsRequestOverrideConfiguration;
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.DefaultValueTrait;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateCustomMetricRequest extends IotRequest implements
ToCopyableBuilder {
private static final SdkField METRIC_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("metricName").getter(getter(CreateCustomMetricRequest::metricName)).setter(setter(Builder::metricName))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("metricName").build()).build();
private static final SdkField DISPLAY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("displayName").getter(getter(CreateCustomMetricRequest::displayName))
.setter(setter(Builder::displayName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("displayName").build()).build();
private static final SdkField METRIC_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("metricType").getter(getter(CreateCustomMetricRequest::metricTypeAsString))
.setter(setter(Builder::metricType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("metricType").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("tags")
.getter(getter(CreateCustomMetricRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField CLIENT_REQUEST_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("clientRequestToken")
.getter(getter(CreateCustomMetricRequest::clientRequestToken))
.setter(setter(Builder::clientRequestToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("clientRequestToken").build(),
DefaultValueTrait.idempotencyToken()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(METRIC_NAME_FIELD,
DISPLAY_NAME_FIELD, METRIC_TYPE_FIELD, TAGS_FIELD, CLIENT_REQUEST_TOKEN_FIELD));
private final String metricName;
private final String displayName;
private final String metricType;
private final List tags;
private final String clientRequestToken;
private CreateCustomMetricRequest(BuilderImpl builder) {
super(builder);
this.metricName = builder.metricName;
this.displayName = builder.displayName;
this.metricType = builder.metricType;
this.tags = builder.tags;
this.clientRequestToken = builder.clientRequestToken;
}
/**
*
* The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name
* can't begin with aws:. You can't change the name after you define it.
*
*
* @return The name of the custom metric. This will be used in the metric report submitted from the device/thing.
* The name can't begin with aws:. You can't change the name after you define it.
*/
public final String metricName() {
return metricName;
}
/**
*
* The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name
* as the metric identifier in the device metric report. You can update the friendly name after you define it.
*
*
* @return The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use
* this name as the metric identifier in the device metric report. You can update the friendly name after
* you define it.
*/
public final String displayName() {
return displayName;
}
/**
*
* The type of the custom metric.
*
*
*
* The type number only takes a single metric value as an input, but when you submit the metrics value
* in the DeviceMetrics report, you must pass it as an array with a single value.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #metricType} will
* return {@link CustomMetricType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #metricTypeAsString}.
*
*
* @return The type of the custom metric.
*
* The type number only takes a single metric value as an input, but when you submit the
* metrics value in the DeviceMetrics report, you must pass it as an array with a single value.
*
* @see CustomMetricType
*/
public final CustomMetricType metricType() {
return CustomMetricType.fromValue(metricType);
}
/**
*
* The type of the custom metric.
*
*
*
* The type number only takes a single metric value as an input, but when you submit the metrics value
* in the DeviceMetrics report, you must pass it as an array with a single value.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #metricType} will
* return {@link CustomMetricType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #metricTypeAsString}.
*
*
* @return The type of the custom metric.
*
* The type number only takes a single metric value as an input, but when you submit the
* metrics value in the DeviceMetrics report, you must pass it as an array with a single value.
*
* @see CustomMetricType
*/
public final String metricTypeAsString() {
return metricType;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* Metadata that can be used to manage the custom metric.
*
*
* 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 #hasTags} method.
*
*
* @return Metadata that can be used to manage the custom metric.
*/
public final List tags() {
return tags;
}
/**
*
* Each custom metric must have a unique client request token. If you try to create a new custom metric that already
* exists with a different token, an exception occurs. If you omit this value, Amazon Web Services SDKs will
* automatically generate a unique client request.
*
*
* @return Each custom metric must have a unique client request token. If you try to create a new custom metric that
* already exists with a different token, an exception occurs. If you omit this value, Amazon Web Services
* SDKs will automatically generate a unique client request.
*/
public final String clientRequestToken() {
return clientRequestToken;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(metricName());
hashCode = 31 * hashCode + Objects.hashCode(displayName());
hashCode = 31 * hashCode + Objects.hashCode(metricTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(clientRequestToken());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateCustomMetricRequest)) {
return false;
}
CreateCustomMetricRequest other = (CreateCustomMetricRequest) obj;
return Objects.equals(metricName(), other.metricName()) && Objects.equals(displayName(), other.displayName())
&& Objects.equals(metricTypeAsString(), other.metricTypeAsString()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags()) && Objects.equals(clientRequestToken(), other.clientRequestToken());
}
/**
* 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("CreateCustomMetricRequest").add("MetricName", metricName()).add("DisplayName", displayName())
.add("MetricType", metricTypeAsString()).add("Tags", hasTags() ? tags() : null)
.add("ClientRequestToken", clientRequestToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "metricName":
return Optional.ofNullable(clazz.cast(metricName()));
case "displayName":
return Optional.ofNullable(clazz.cast(displayName()));
case "metricType":
return Optional.ofNullable(clazz.cast(metricTypeAsString()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
case "clientRequestToken":
return Optional.ofNullable(clazz.cast(clientRequestToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateCustomMetricRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IotRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the custom metric. This will be used in the metric report submitted from the device/thing. The
* name can't begin with aws:. You can't change the name after you define it.
*
*
* @param metricName
* The name of the custom metric. This will be used in the metric report submitted from the device/thing.
* The name can't begin with aws:. You can't change the name after you define it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metricName(String metricName);
/**
*
* The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this
* name as the metric identifier in the device metric report. You can update the friendly name after you define
* it.
*
*
* @param displayName
* The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use
* this name as the metric identifier in the device metric report. You can update the friendly name after
* you define it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder displayName(String displayName);
/**
*
* The type of the custom metric.
*
*
*
* The type number only takes a single metric value as an input, but when you submit the metrics
* value in the DeviceMetrics report, you must pass it as an array with a single value.
*
*
*
* @param metricType
* The type of the custom metric.
*
* The type number only takes a single metric value as an input, but when you submit the
* metrics value in the DeviceMetrics report, you must pass it as an array with a single value.
*
* @see CustomMetricType
* @return Returns a reference to this object so that method calls can be chained together.
* @see CustomMetricType
*/
Builder metricType(String metricType);
/**
*
* The type of the custom metric.
*
*
*
* The type number only takes a single metric value as an input, but when you submit the metrics
* value in the DeviceMetrics report, you must pass it as an array with a single value.
*
*
*
* @param metricType
* The type of the custom metric.
*
* The type number only takes a single metric value as an input, but when you submit the
* metrics value in the DeviceMetrics report, you must pass it as an array with a single value.
*
* @see CustomMetricType
* @return Returns a reference to this object so that method calls can be chained together.
* @see CustomMetricType
*/
Builder metricType(CustomMetricType metricType);
/**
*
* Metadata that can be used to manage the custom metric.
*
*
* @param tags
* Metadata that can be used to manage the custom metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* Metadata that can be used to manage the custom metric.
*
*
* @param tags
* Metadata that can be used to manage the custom metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* Metadata that can be used to manage the custom metric.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.iot.model.Tag.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.iot.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.iot.model.Tag.Builder#build()} is
* called immediately and its result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link software.amazon.awssdk.services.iot.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
/**
*
* Each custom metric must have a unique client request token. If you try to create a new custom metric that
* already exists with a different token, an exception occurs. If you omit this value, Amazon Web Services SDKs
* will automatically generate a unique client request.
*
*
* @param clientRequestToken
* Each custom metric must have a unique client request token. If you try to create a new custom metric
* that already exists with a different token, an exception occurs. If you omit this value, Amazon Web
* Services SDKs will automatically generate a unique client request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientRequestToken(String clientRequestToken);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends IotRequest.BuilderImpl implements Builder {
private String metricName;
private String displayName;
private String metricType;
private List tags = DefaultSdkAutoConstructList.getInstance();
private String clientRequestToken;
private BuilderImpl() {
}
private BuilderImpl(CreateCustomMetricRequest model) {
super(model);
metricName(model.metricName);
displayName(model.displayName);
metricType(model.metricType);
tags(model.tags);
clientRequestToken(model.clientRequestToken);
}
public final String getMetricName() {
return metricName;
}
public final void setMetricName(String metricName) {
this.metricName = metricName;
}
@Override
public final Builder metricName(String metricName) {
this.metricName = metricName;
return this;
}
public final String getDisplayName() {
return displayName;
}
public final void setDisplayName(String displayName) {
this.displayName = displayName;
}
@Override
public final Builder displayName(String displayName) {
this.displayName = displayName;
return this;
}
public final String getMetricType() {
return metricType;
}
public final void setMetricType(String metricType) {
this.metricType = metricType;
}
@Override
public final Builder metricType(String metricType) {
this.metricType = metricType;
return this;
}
@Override
public final Builder metricType(CustomMetricType metricType) {
this.metricType(metricType == null ? null : metricType.toString());
return this;
}
public final List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getClientRequestToken() {
return clientRequestToken;
}
public final void setClientRequestToken(String clientRequestToken) {
this.clientRequestToken = clientRequestToken;
}
@Override
public final Builder clientRequestToken(String clientRequestToken) {
this.clientRequestToken = clientRequestToken;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateCustomMetricRequest build() {
return new CreateCustomMetricRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}