/* * Copyright 2010-2021 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.iotdata.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Publishes an MQTT message. *

*

* Requires permission to access the Publish action. *

*

* For more information about MQTT messages, see MQTT * Protocol in the IoT Developer Guide. *

*

* For more information about messaging costs, see IoT Core pricing - * Messaging. *

*/ public class PublishRequest extends AmazonWebServiceRequest implements Serializable { /** *

* The name of the MQTT topic. *

*/ private String topic; /** *

* The Quality of Service (QoS) level. *

*

* Constraints:
* Range: 0 - 1
*/ private Integer qos; /** *

* A Boolean value that determines whether to set the RETAIN flag when the * message is published. *

*

* Setting the RETAIN flag causes the message to be retained and sent to new * subscribers to the topic. *

*

* Valid values: true | false *

*

* Default value: false *

*/ private Boolean retain; /** *

* The message body. MQTT accepts text, binary, and empty (null) message * payloads. *

*

* Publishing an empty (null) payload with retain = true * deletes the retained message identified by topic from IoT Core. *

*/ private java.nio.ByteBuffer payload; /** *

* The name of the MQTT topic. *

* * @return

* The name of the MQTT topic. *

*/ public String getTopic() { return topic; } /** *

* The name of the MQTT topic. *

* * @param topic

* The name of the MQTT topic. *

*/ public void setTopic(String topic) { this.topic = topic; } /** *

* The name of the MQTT topic. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param topic

* The name of the MQTT topic. *

* @return A reference to this updated object so that method calls can be * chained together. */ public PublishRequest withTopic(String topic) { this.topic = topic; return this; } /** *

* The Quality of Service (QoS) level. *

*

* Constraints:
* Range: 0 - 1
* * @return

* The Quality of Service (QoS) level. *

*/ public Integer getQos() { return qos; } /** *

* The Quality of Service (QoS) level. *

*

* Constraints:
* Range: 0 - 1
* * @param qos

* The Quality of Service (QoS) level. *

*/ public void setQos(Integer qos) { this.qos = qos; } /** *

* The Quality of Service (QoS) level. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Range: 0 - 1
* * @param qos

* The Quality of Service (QoS) level. *

* @return A reference to this updated object so that method calls can be * chained together. */ public PublishRequest withQos(Integer qos) { this.qos = qos; return this; } /** *

* A Boolean value that determines whether to set the RETAIN flag when the * message is published. *

*

* Setting the RETAIN flag causes the message to be retained and sent to new * subscribers to the topic. *

*

* Valid values: true | false *

*

* Default value: false *

* * @return

* A Boolean value that determines whether to set the RETAIN flag * when the message is published. *

*

* Setting the RETAIN flag causes the message to be retained and * sent to new subscribers to the topic. *

*

* Valid values: true | false *

*

* Default value: false *

*/ public Boolean isRetain() { return retain; } /** *

* A Boolean value that determines whether to set the RETAIN flag when the * message is published. *

*

* Setting the RETAIN flag causes the message to be retained and sent to new * subscribers to the topic. *

*

* Valid values: true | false *

*

* Default value: false *

* * @return

* A Boolean value that determines whether to set the RETAIN flag * when the message is published. *

*

* Setting the RETAIN flag causes the message to be retained and * sent to new subscribers to the topic. *

*

* Valid values: true | false *

*

* Default value: false *

*/ public Boolean getRetain() { return retain; } /** *

* A Boolean value that determines whether to set the RETAIN flag when the * message is published. *

*

* Setting the RETAIN flag causes the message to be retained and sent to new * subscribers to the topic. *

*

* Valid values: true | false *

*

* Default value: false *

* * @param retain

* A Boolean value that determines whether to set the RETAIN flag * when the message is published. *

*

* Setting the RETAIN flag causes the message to be retained and * sent to new subscribers to the topic. *

*

* Valid values: true | false *

*

* Default value: false *

*/ public void setRetain(Boolean retain) { this.retain = retain; } /** *

* A Boolean value that determines whether to set the RETAIN flag when the * message is published. *

*

* Setting the RETAIN flag causes the message to be retained and sent to new * subscribers to the topic. *

*

* Valid values: true | false *

*

* Default value: false *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param retain

* A Boolean value that determines whether to set the RETAIN flag * when the message is published. *

*

* Setting the RETAIN flag causes the message to be retained and * sent to new subscribers to the topic. *

*

* Valid values: true | false *

*

* Default value: false *

* @return A reference to this updated object so that method calls can be * chained together. */ public PublishRequest withRetain(Boolean retain) { this.retain = retain; return this; } /** *

* The message body. MQTT accepts text, binary, and empty (null) message * payloads. *

*

* Publishing an empty (null) payload with retain = true * deletes the retained message identified by topic from IoT Core. *

* * @return

* The message body. MQTT accepts text, binary, and empty (null) * message payloads. *

*

* Publishing an empty (null) payload with retain = * true deletes the retained message identified by * topic from IoT Core. *

*/ public java.nio.ByteBuffer getPayload() { return payload; } /** *

* The message body. MQTT accepts text, binary, and empty (null) message * payloads. *

*

* Publishing an empty (null) payload with retain = true * deletes the retained message identified by topic from IoT Core. *

* * @param payload

* The message body. MQTT accepts text, binary, and empty (null) * message payloads. *

*

* Publishing an empty (null) payload with retain = * true deletes the retained message identified by * topic from IoT Core. *

*/ public void setPayload(java.nio.ByteBuffer payload) { this.payload = payload; } /** *

* The message body. MQTT accepts text, binary, and empty (null) message * payloads. *

*

* Publishing an empty (null) payload with retain = true * deletes the retained message identified by topic from IoT Core. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param payload

* The message body. MQTT accepts text, binary, and empty (null) * message payloads. *

*

* Publishing an empty (null) payload with retain = * true deletes the retained message identified by * topic from IoT Core. *

* @return A reference to this updated object so that method calls can be * chained together. */ public PublishRequest withPayload(java.nio.ByteBuffer payload) { this.payload = payload; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getTopic() != null) sb.append("topic: " + getTopic() + ","); if (getQos() != null) sb.append("qos: " + getQos() + ","); if (getRetain() != null) sb.append("retain: " + getRetain() + ","); if (getPayload() != null) sb.append("payload: " + getPayload()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getTopic() == null) ? 0 : getTopic().hashCode()); hashCode = prime * hashCode + ((getQos() == null) ? 0 : getQos().hashCode()); hashCode = prime * hashCode + ((getRetain() == null) ? 0 : getRetain().hashCode()); hashCode = prime * hashCode + ((getPayload() == null) ? 0 : getPayload().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof PublishRequest == false) return false; PublishRequest other = (PublishRequest) obj; if (other.getTopic() == null ^ this.getTopic() == null) return false; if (other.getTopic() != null && other.getTopic().equals(this.getTopic()) == false) return false; if (other.getQos() == null ^ this.getQos() == null) return false; if (other.getQos() != null && other.getQos().equals(this.getQos()) == false) return false; if (other.getRetain() == null ^ this.getRetain() == null) return false; if (other.getRetain() != null && other.getRetain().equals(this.getRetain()) == false) return false; if (other.getPayload() == null ^ this.getPayload() == null) return false; if (other.getPayload() != null && other.getPayload().equals(this.getPayload()) == false) return false; return true; } }