com.amazonaws.services.iot.model.DescribeThingResult Maven / Gradle / Ivy
/*
* Copyright 2015-2020 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 com.amazonaws.services.iot.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* The output from the DescribeThing operation.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeThingResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID.
* Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates,
* or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and
* the Device Shadow service.
*
*
* This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device
* certificate model or shadows.
*
*/
private String defaultClientId;
/**
*
* The name of the thing.
*
*/
private String thingName;
/**
*
* The ID of the thing to describe.
*
*/
private String thingId;
/**
*
* The ARN of the thing to describe.
*
*/
private String thingArn;
/**
*
* The thing type name.
*
*/
private String thingTypeName;
/**
*
* The thing attributes.
*
*/
private java.util.Map attributes;
/**
*
* The current version of the thing record in the registry.
*
*
*
* To avoid unintentional changes to the information in the registry, you can pass the version information in the
* expectedVersion parameter of the UpdateThing and DeleteThing calls.
*
*
*/
private Long version;
/**
*
* The name of the billing group the thing belongs to.
*
*/
private String billingGroupName;
/**
*
* The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID.
* Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates,
* or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and
* the Device Shadow service.
*
*
* This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device
* certificate model or shadows.
*
*
* @param defaultClientId
* The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client
* ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs,
* certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID
* for the registry and the Device Shadow service.
*
* This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device
* certificate model or shadows.
*/
public void setDefaultClientId(String defaultClientId) {
this.defaultClientId = defaultClientId;
}
/**
*
* The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID.
* Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates,
* or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and
* the Device Shadow service.
*
*
* This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device
* certificate model or shadows.
*
*
* @return The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client
* ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs,
* certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID
* for the registry and the Device Shadow service.
*
* This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying
* device certificate model or shadows.
*/
public String getDefaultClientId() {
return this.defaultClientId;
}
/**
*
* The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID.
* Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates,
* or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and
* the Device Shadow service.
*
*
* This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device
* certificate model or shadows.
*
*
* @param defaultClientId
* The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client
* ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs,
* certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID
* for the registry and the Device Shadow service.
*
* This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device
* certificate model or shadows.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeThingResult withDefaultClientId(String defaultClientId) {
setDefaultClientId(defaultClientId);
return this;
}
/**
*
* The name of the thing.
*
*
* @param thingName
* The name of the thing.
*/
public void setThingName(String thingName) {
this.thingName = thingName;
}
/**
*
* The name of the thing.
*
*
* @return The name of the thing.
*/
public String getThingName() {
return this.thingName;
}
/**
*
* The name of the thing.
*
*
* @param thingName
* The name of the thing.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeThingResult withThingName(String thingName) {
setThingName(thingName);
return this;
}
/**
*
* The ID of the thing to describe.
*
*
* @param thingId
* The ID of the thing to describe.
*/
public void setThingId(String thingId) {
this.thingId = thingId;
}
/**
*
* The ID of the thing to describe.
*
*
* @return The ID of the thing to describe.
*/
public String getThingId() {
return this.thingId;
}
/**
*
* The ID of the thing to describe.
*
*
* @param thingId
* The ID of the thing to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeThingResult withThingId(String thingId) {
setThingId(thingId);
return this;
}
/**
*
* The ARN of the thing to describe.
*
*
* @param thingArn
* The ARN of the thing to describe.
*/
public void setThingArn(String thingArn) {
this.thingArn = thingArn;
}
/**
*
* The ARN of the thing to describe.
*
*
* @return The ARN of the thing to describe.
*/
public String getThingArn() {
return this.thingArn;
}
/**
*
* The ARN of the thing to describe.
*
*
* @param thingArn
* The ARN of the thing to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeThingResult withThingArn(String thingArn) {
setThingArn(thingArn);
return this;
}
/**
*
* The thing type name.
*
*
* @param thingTypeName
* The thing type name.
*/
public void setThingTypeName(String thingTypeName) {
this.thingTypeName = thingTypeName;
}
/**
*
* The thing type name.
*
*
* @return The thing type name.
*/
public String getThingTypeName() {
return this.thingTypeName;
}
/**
*
* The thing type name.
*
*
* @param thingTypeName
* The thing type name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeThingResult withThingTypeName(String thingTypeName) {
setThingTypeName(thingTypeName);
return this;
}
/**
*
* The thing attributes.
*
*
* @return The thing attributes.
*/
public java.util.Map getAttributes() {
return attributes;
}
/**
*
* The thing attributes.
*
*
* @param attributes
* The thing attributes.
*/
public void setAttributes(java.util.Map attributes) {
this.attributes = attributes;
}
/**
*
* The thing attributes.
*
*
* @param attributes
* The thing attributes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeThingResult withAttributes(java.util.Map attributes) {
setAttributes(attributes);
return this;
}
/**
* Add a single Attributes entry
*
* @see DescribeThingResult#withAttributes
* @returns a reference to this object so that method calls can be chained together.
*/
public DescribeThingResult addAttributesEntry(String key, String value) {
if (null == this.attributes) {
this.attributes = new java.util.HashMap();
}
if (this.attributes.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.attributes.put(key, value);
return this;
}
/**
* Removes all the entries added into Attributes.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeThingResult clearAttributesEntries() {
this.attributes = null;
return this;
}
/**
*
* The current version of the thing record in the registry.
*
*
*
* To avoid unintentional changes to the information in the registry, you can pass the version information in the
* expectedVersion parameter of the UpdateThing and DeleteThing calls.
*
*
*
* @param version
* The current version of the thing record in the registry.
*
* To avoid unintentional changes to the information in the registry, you can pass the version information in
* the expectedVersion parameter of the UpdateThing and DeleteThing
* calls.
*
*/
public void setVersion(Long version) {
this.version = version;
}
/**
*
* The current version of the thing record in the registry.
*
*
*
* To avoid unintentional changes to the information in the registry, you can pass the version information in the
* expectedVersion parameter of the UpdateThing and DeleteThing calls.
*
*
*
* @return The current version of the thing record in the registry.
*
* To avoid unintentional changes to the information in the registry, you can pass the version information
* in the expectedVersion parameter of the UpdateThing and
* DeleteThing calls.
*
*/
public Long getVersion() {
return this.version;
}
/**
*
* The current version of the thing record in the registry.
*
*
*
* To avoid unintentional changes to the information in the registry, you can pass the version information in the
* expectedVersion parameter of the UpdateThing and DeleteThing calls.
*
*
*
* @param version
* The current version of the thing record in the registry.
*
* To avoid unintentional changes to the information in the registry, you can pass the version information in
* the expectedVersion parameter of the UpdateThing and DeleteThing
* calls.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeThingResult withVersion(Long version) {
setVersion(version);
return this;
}
/**
*
* The name of the billing group the thing belongs to.
*
*
* @param billingGroupName
* The name of the billing group the thing belongs to.
*/
public void setBillingGroupName(String billingGroupName) {
this.billingGroupName = billingGroupName;
}
/**
*
* The name of the billing group the thing belongs to.
*
*
* @return The name of the billing group the thing belongs to.
*/
public String getBillingGroupName() {
return this.billingGroupName;
}
/**
*
* The name of the billing group the thing belongs to.
*
*
* @param billingGroupName
* The name of the billing group the thing belongs to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeThingResult withBillingGroupName(String billingGroupName) {
setBillingGroupName(billingGroupName);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDefaultClientId() != null)
sb.append("DefaultClientId: ").append(getDefaultClientId()).append(",");
if (getThingName() != null)
sb.append("ThingName: ").append(getThingName()).append(",");
if (getThingId() != null)
sb.append("ThingId: ").append(getThingId()).append(",");
if (getThingArn() != null)
sb.append("ThingArn: ").append(getThingArn()).append(",");
if (getThingTypeName() != null)
sb.append("ThingTypeName: ").append(getThingTypeName()).append(",");
if (getAttributes() != null)
sb.append("Attributes: ").append(getAttributes()).append(",");
if (getVersion() != null)
sb.append("Version: ").append(getVersion()).append(",");
if (getBillingGroupName() != null)
sb.append("BillingGroupName: ").append(getBillingGroupName());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeThingResult == false)
return false;
DescribeThingResult other = (DescribeThingResult) obj;
if (other.getDefaultClientId() == null ^ this.getDefaultClientId() == null)
return false;
if (other.getDefaultClientId() != null && other.getDefaultClientId().equals(this.getDefaultClientId()) == false)
return false;
if (other.getThingName() == null ^ this.getThingName() == null)
return false;
if (other.getThingName() != null && other.getThingName().equals(this.getThingName()) == false)
return false;
if (other.getThingId() == null ^ this.getThingId() == null)
return false;
if (other.getThingId() != null && other.getThingId().equals(this.getThingId()) == false)
return false;
if (other.getThingArn() == null ^ this.getThingArn() == null)
return false;
if (other.getThingArn() != null && other.getThingArn().equals(this.getThingArn()) == false)
return false;
if (other.getThingTypeName() == null ^ this.getThingTypeName() == null)
return false;
if (other.getThingTypeName() != null && other.getThingTypeName().equals(this.getThingTypeName()) == false)
return false;
if (other.getAttributes() == null ^ this.getAttributes() == null)
return false;
if (other.getAttributes() != null && other.getAttributes().equals(this.getAttributes()) == false)
return false;
if (other.getVersion() == null ^ this.getVersion() == null)
return false;
if (other.getVersion() != null && other.getVersion().equals(this.getVersion()) == false)
return false;
if (other.getBillingGroupName() == null ^ this.getBillingGroupName() == null)
return false;
if (other.getBillingGroupName() != null && other.getBillingGroupName().equals(this.getBillingGroupName()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDefaultClientId() == null) ? 0 : getDefaultClientId().hashCode());
hashCode = prime * hashCode + ((getThingName() == null) ? 0 : getThingName().hashCode());
hashCode = prime * hashCode + ((getThingId() == null) ? 0 : getThingId().hashCode());
hashCode = prime * hashCode + ((getThingArn() == null) ? 0 : getThingArn().hashCode());
hashCode = prime * hashCode + ((getThingTypeName() == null) ? 0 : getThingTypeName().hashCode());
hashCode = prime * hashCode + ((getAttributes() == null) ? 0 : getAttributes().hashCode());
hashCode = prime * hashCode + ((getVersion() == null) ? 0 : getVersion().hashCode());
hashCode = prime * hashCode + ((getBillingGroupName() == null) ? 0 : getBillingGroupName().hashCode());
return hashCode;
}
@Override
public DescribeThingResult clone() {
try {
return (DescribeThingResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}