software.amazon.awssdk.services.iot1clickdevices.model.DeviceDescription 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.iot1clickdevices.model;
import java.beans.Transient;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
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.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.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
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 DeviceDescription implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Arn")
.getter(getter(DeviceDescription::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("arn").build()).build();
private static final SdkField> ATTRIBUTES_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Attributes")
.getter(getter(DeviceDescription::attributes))
.setter(setter(Builder::attributes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("attributes").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField DEVICE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DeviceId").getter(getter(DeviceDescription::deviceId)).setter(setter(Builder::deviceId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("deviceId").build()).build();
private static final SdkField ENABLED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("Enabled").getter(getter(DeviceDescription::enabled)).setter(setter(Builder::enabled))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("enabled").build()).build();
private static final SdkField REMAINING_LIFE_FIELD = SdkField. builder(MarshallingType.DOUBLE)
.memberName("RemainingLife").getter(getter(DeviceDescription::remainingLife)).setter(setter(Builder::remainingLife))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("remainingLife").build()).build();
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Type")
.getter(getter(DeviceDescription::type)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("type").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Tags")
.getter(getter(DeviceDescription::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ARN_FIELD, ATTRIBUTES_FIELD,
DEVICE_ID_FIELD, ENABLED_FIELD, REMAINING_LIFE_FIELD, TYPE_FIELD, TAGS_FIELD));
private static final long serialVersionUID = 1L;
private final String arn;
private final Map attributes;
private final String deviceId;
private final Boolean enabled;
private final Double remainingLife;
private final String type;
private final Map tags;
private DeviceDescription(BuilderImpl builder) {
this.arn = builder.arn;
this.attributes = builder.attributes;
this.deviceId = builder.deviceId;
this.enabled = builder.enabled;
this.remainingLife = builder.remainingLife;
this.type = builder.type;
this.tags = builder.tags;
}
/**
*
* The ARN of the device.
*
*
* @return The ARN of the device.
*/
public final String arn() {
return arn;
}
/**
* For responses, this returns true if the service returned a value for the Attributes 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 hasAttributes() {
return attributes != null && !(attributes instanceof SdkAutoConstructMap);
}
/**
*
* An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.
*
*
* 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 #hasAttributes} method.
*
*
* @return An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.
*/
public final Map attributes() {
return attributes;
}
/**
*
* The unique identifier of the device.
*
*
* @return The unique identifier of the device.
*/
public final String deviceId() {
return deviceId;
}
/**
*
* A Boolean value indicating whether or not the device is enabled.
*
*
* @return A Boolean value indicating whether or not the device is enabled.
*/
public final Boolean enabled() {
return enabled;
}
/**
*
* A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.
*
*
* @return A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.
*/
public final Double remainingLife() {
return remainingLife;
}
/**
*
* The type of the device, such as "button".
*
*
* @return The type of the device, such as "button".
*/
public final String type() {
return type;
}
/**
* 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 SdkAutoConstructMap);
}
/**
*
* The tags currently associated with the AWS IoT 1-Click device.
*
*
* 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 The tags currently associated with the AWS IoT 1-Click device.
*/
public final Map tags() {
return tags;
}
@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(arn());
hashCode = 31 * hashCode + Objects.hashCode(hasAttributes() ? attributes() : null);
hashCode = 31 * hashCode + Objects.hashCode(deviceId());
hashCode = 31 * hashCode + Objects.hashCode(enabled());
hashCode = 31 * hashCode + Objects.hashCode(remainingLife());
hashCode = 31 * hashCode + Objects.hashCode(type());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : 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 DeviceDescription)) {
return false;
}
DeviceDescription other = (DeviceDescription) obj;
return Objects.equals(arn(), other.arn()) && hasAttributes() == other.hasAttributes()
&& Objects.equals(attributes(), other.attributes()) && Objects.equals(deviceId(), other.deviceId())
&& Objects.equals(enabled(), other.enabled()) && Objects.equals(remainingLife(), other.remainingLife())
&& Objects.equals(type(), other.type()) && hasTags() == other.hasTags() && Objects.equals(tags(), other.tags());
}
/**
* 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("DeviceDescription").add("Arn", arn()).add("Attributes", hasAttributes() ? attributes() : null)
.add("DeviceId", deviceId()).add("Enabled", enabled()).add("RemainingLife", remainingLife()).add("Type", type())
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Arn":
return Optional.ofNullable(clazz.cast(arn()));
case "Attributes":
return Optional.ofNullable(clazz.cast(attributes()));
case "DeviceId":
return Optional.ofNullable(clazz.cast(deviceId()));
case "Enabled":
return Optional.ofNullable(clazz.cast(enabled()));
case "RemainingLife":
return Optional.ofNullable(clazz.cast(remainingLife()));
case "Type":
return Optional.ofNullable(clazz.cast(type()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DeviceDescription) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The ARN of the device.
*
*
* @param arn
* The ARN of the device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.
*
*
* @param attributes
* An array of zero or more elements of DeviceAttribute objects providing user specified device
* attributes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributes(Map attributes);
/**
*
* The unique identifier of the device.
*
*
* @param deviceId
* The unique identifier of the device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deviceId(String deviceId);
/**
*
* A Boolean value indicating whether or not the device is enabled.
*
*
* @param enabled
* A Boolean value indicating whether or not the device is enabled.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder enabled(Boolean enabled);
/**
*
* A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.
*
*
* @param remainingLife
* A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder remainingLife(Double remainingLife);
/**
*
* The type of the device, such as "button".
*
*
* @param type
* The type of the device, such as "button".
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder type(String type);
/**
*
* The tags currently associated with the AWS IoT 1-Click device.
*
*
* @param tags
* The tags currently associated with the AWS IoT 1-Click device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
}
static final class BuilderImpl implements Builder {
private String arn;
private Map attributes = DefaultSdkAutoConstructMap.getInstance();
private String deviceId;
private Boolean enabled;
private Double remainingLife;
private String type;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DeviceDescription model) {
arn(model.arn);
attributes(model.attributes);
deviceId(model.deviceId);
enabled(model.enabled);
remainingLife(model.remainingLife);
type(model.type);
tags(model.tags);
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
@Transient
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final Map getAttributes() {
if (attributes instanceof SdkAutoConstructMap) {
return null;
}
return attributes;
}
public final void setAttributes(Map attributes) {
this.attributes = DeviceAttributesCopier.copy(attributes);
}
@Override
@Transient
public final Builder attributes(Map attributes) {
this.attributes = DeviceAttributesCopier.copy(attributes);
return this;
}
public final String getDeviceId() {
return deviceId;
}
public final void setDeviceId(String deviceId) {
this.deviceId = deviceId;
}
@Override
@Transient
public final Builder deviceId(String deviceId) {
this.deviceId = deviceId;
return this;
}
public final Boolean getEnabled() {
return enabled;
}
public final void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
@Override
@Transient
public final Builder enabled(Boolean enabled) {
this.enabled = enabled;
return this;
}
public final Double getRemainingLife() {
return remainingLife;
}
public final void setRemainingLife(Double remainingLife) {
this.remainingLife = remainingLife;
}
@Override
@Transient
public final Builder remainingLife(Double remainingLife) {
this.remainingLife = remainingLife;
return this;
}
public final String getType() {
return type;
}
public final void setType(String type) {
this.type = type;
}
@Override
@Transient
public final Builder type(String type) {
this.type = type;
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = ___mapOf__stringCopier.copy(tags);
}
@Override
@Transient
public final Builder tags(Map tags) {
this.tags = ___mapOf__stringCopier.copy(tags);
return this;
}
@Override
public DeviceDescription build() {
return new DeviceDescription(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy