/* * Copyright 2018-2023 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; import com.amazonaws.AmazonWebServiceRequest; /** *
* The input for the UpdateThing operation. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class UpdateThingRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** ** The name of the thing to update. *
** You can't change a thing's name. To change a thing's name, you must create a new thing, give it the new name, and * then delete the old thing. *
*/ private String thingName; /** ** The name of the thing type. *
*/ private String thingTypeName; /** ** A list of thing attributes, a JSON string containing name-value pairs. For example: *
*
* {\"attributes\":{\"name1\":\"value2\"}}
*
* This data is used to add new attributes or update existing attributes. *
*/ private AttributePayload attributePayload; /** *
* The expected version of the thing record in the registry. If the version of the record in the registry does not
* match the expected version specified in the request, the UpdateThing
request is rejected with a
* VersionConflictException
.
*
* Remove a thing type association. If true, the association is removed. *
*/ private Boolean removeThingType; /** ** The name of the thing to update. *
** You can't change a thing's name. To change a thing's name, you must create a new thing, give it the new name, and * then delete the old thing. *
* * @param thingName * The name of the thing to update. ** You can't change a thing's name. To change a thing's name, you must create a new thing, give it the new * name, and then delete the old thing. */ public void setThingName(String thingName) { this.thingName = thingName; } /** *
* The name of the thing to update. *
** You can't change a thing's name. To change a thing's name, you must create a new thing, give it the new name, and * then delete the old thing. *
* * @return The name of the thing to update. ** You can't change a thing's name. To change a thing's name, you must create a new thing, give it the new * name, and then delete the old thing. */ public String getThingName() { return this.thingName; } /** *
* The name of the thing to update. *
** You can't change a thing's name. To change a thing's name, you must create a new thing, give it the new name, and * then delete the old thing. *
* * @param thingName * The name of the thing to update. ** You can't change a thing's name. To change a thing's name, you must create a new thing, give it the new * name, and then delete the old thing. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateThingRequest withThingName(String thingName) { setThingName(thingName); return this; } /** *
* The name of the thing type. *
* * @param thingTypeName * The name of the thing type. */ public void setThingTypeName(String thingTypeName) { this.thingTypeName = thingTypeName; } /** ** The name of the thing type. *
* * @return The name of the thing type. */ public String getThingTypeName() { return this.thingTypeName; } /** ** The name of the thing type. *
* * @param thingTypeName * The name of the thing type. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateThingRequest withThingTypeName(String thingTypeName) { setThingTypeName(thingTypeName); return this; } /** ** A list of thing attributes, a JSON string containing name-value pairs. For example: *
*
* {\"attributes\":{\"name1\":\"value2\"}}
*
* This data is used to add new attributes or update existing attributes. *
* * @param attributePayload * A list of thing attributes, a JSON string containing name-value pairs. For example: *
* {\"attributes\":{\"name1\":\"value2\"}}
*
* This data is used to add new attributes or update existing attributes. */ public void setAttributePayload(AttributePayload attributePayload) { this.attributePayload = attributePayload; } /** *
* A list of thing attributes, a JSON string containing name-value pairs. For example: *
*
* {\"attributes\":{\"name1\":\"value2\"}}
*
* This data is used to add new attributes or update existing attributes. *
* * @return A list of thing attributes, a JSON string containing name-value pairs. For example: *
* {\"attributes\":{\"name1\":\"value2\"}}
*
* This data is used to add new attributes or update existing attributes. */ public AttributePayload getAttributePayload() { return this.attributePayload; } /** *
* A list of thing attributes, a JSON string containing name-value pairs. For example: *
*
* {\"attributes\":{\"name1\":\"value2\"}}
*
* This data is used to add new attributes or update existing attributes. *
* * @param attributePayload * A list of thing attributes, a JSON string containing name-value pairs. For example: *
* {\"attributes\":{\"name1\":\"value2\"}}
*
* This data is used to add new attributes or update existing attributes. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateThingRequest withAttributePayload(AttributePayload attributePayload) { setAttributePayload(attributePayload); return this; } /** *
* The expected version of the thing record in the registry. If the version of the record in the registry does not
* match the expected version specified in the request, the UpdateThing
request is rejected with a
* VersionConflictException
.
*
UpdateThing
request is
* rejected with a VersionConflictException
.
*/
public void setExpectedVersion(Long expectedVersion) {
this.expectedVersion = expectedVersion;
}
/**
*
* The expected version of the thing record in the registry. If the version of the record in the registry does not
* match the expected version specified in the request, the UpdateThing
request is rejected with a
* VersionConflictException
.
*
UpdateThing
request is
* rejected with a VersionConflictException
.
*/
public Long getExpectedVersion() {
return this.expectedVersion;
}
/**
*
* The expected version of the thing record in the registry. If the version of the record in the registry does not
* match the expected version specified in the request, the UpdateThing
request is rejected with a
* VersionConflictException
.
*
UpdateThing
request is
* rejected with a VersionConflictException
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateThingRequest withExpectedVersion(Long expectedVersion) {
setExpectedVersion(expectedVersion);
return this;
}
/**
* * Remove a thing type association. If true, the association is removed. *
* * @param removeThingType * Remove a thing type association. If true, the association is removed. */ public void setRemoveThingType(Boolean removeThingType) { this.removeThingType = removeThingType; } /** ** Remove a thing type association. If true, the association is removed. *
* * @return Remove a thing type association. If true, the association is removed. */ public Boolean getRemoveThingType() { return this.removeThingType; } /** ** Remove a thing type association. If true, the association is removed. *
* * @param removeThingType * Remove a thing type association. If true, the association is removed. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateThingRequest withRemoveThingType(Boolean removeThingType) { setRemoveThingType(removeThingType); return this; } /** ** Remove a thing type association. If true, the association is removed. *
* * @return Remove a thing type association. If true, the association is removed. */ public Boolean isRemoveThingType() { return this.removeThingType; } /** * 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 (getThingName() != null) sb.append("ThingName: ").append(getThingName()).append(","); if (getThingTypeName() != null) sb.append("ThingTypeName: ").append(getThingTypeName()).append(","); if (getAttributePayload() != null) sb.append("AttributePayload: ").append(getAttributePayload()).append(","); if (getExpectedVersion() != null) sb.append("ExpectedVersion: ").append(getExpectedVersion()).append(","); if (getRemoveThingType() != null) sb.append("RemoveThingType: ").append(getRemoveThingType()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof UpdateThingRequest == false) return false; UpdateThingRequest other = (UpdateThingRequest) obj; if (other.getThingName() == null ^ this.getThingName() == null) return false; if (other.getThingName() != null && other.getThingName().equals(this.getThingName()) == 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.getAttributePayload() == null ^ this.getAttributePayload() == null) return false; if (other.getAttributePayload() != null && other.getAttributePayload().equals(this.getAttributePayload()) == false) return false; if (other.getExpectedVersion() == null ^ this.getExpectedVersion() == null) return false; if (other.getExpectedVersion() != null && other.getExpectedVersion().equals(this.getExpectedVersion()) == false) return false; if (other.getRemoveThingType() == null ^ this.getRemoveThingType() == null) return false; if (other.getRemoveThingType() != null && other.getRemoveThingType().equals(this.getRemoveThingType()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getThingName() == null) ? 0 : getThingName().hashCode()); hashCode = prime * hashCode + ((getThingTypeName() == null) ? 0 : getThingTypeName().hashCode()); hashCode = prime * hashCode + ((getAttributePayload() == null) ? 0 : getAttributePayload().hashCode()); hashCode = prime * hashCode + ((getExpectedVersion() == null) ? 0 : getExpectedVersion().hashCode()); hashCode = prime * hashCode + ((getRemoveThingType() == null) ? 0 : getRemoveThingType().hashCode()); return hashCode; } @Override public UpdateThingRequest clone() { return (UpdateThingRequest) super.clone(); } }