com.amazonaws.services.iotdata.model.PublishRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-iot Show documentation
/*
* Copyright 2011-2016 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;
/**
*
* The input for the Publish operation.
*
*/
public class PublishRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the MQTT topic.
*
*/
private String topic;
/**
*
* The Quality of Service (QoS) level.
*
*/
private Integer qos;
/**
*
* The state information, in JSON format.
*
*/
private java.nio.ByteBuffer payload;
/**
*
* 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.
*
*
* @return The name of the MQTT topic.
*/
public String getTopic() {
return this.topic;
}
/**
*
* The name of the MQTT topic.
*
*
* @param topic
* The name of the MQTT topic.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PublishRequest withTopic(String topic) {
setTopic(topic);
return this;
}
/**
*
* The Quality of Service (QoS) level.
*
*
* @param qos
* The Quality of Service (QoS) level.
*/
public void setQos(Integer qos) {
this.qos = qos;
}
/**
*
* The Quality of Service (QoS) level.
*
*
* @return The Quality of Service (QoS) level.
*/
public Integer getQos() {
return this.qos;
}
/**
*
* The Quality of Service (QoS) level.
*
*
* @param qos
* The Quality of Service (QoS) level.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PublishRequest withQos(Integer qos) {
setQos(qos);
return this;
}
/**
*
* The state information, in JSON format.
*
*
* AWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will
* be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or
* ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future
* major version of the SDK.
*
*
* @param payload
* The state information, in JSON format.
*/
public void setPayload(java.nio.ByteBuffer payload) {
this.payload = payload;
}
/**
*
* The state information, in JSON format.
*
*
* {@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend
* using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent
* {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}.
* Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the
* {@code position}.
*
*
* @return The state information, in JSON format.
*/
public java.nio.ByteBuffer getPayload() {
return this.payload;
}
/**
*
* The state information, in JSON format.
*
*
* @param payload
* The state information, in JSON format.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PublishRequest withPayload(java.nio.ByteBuffer payload) {
setPayload(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 (getPayload() != null)
sb.append("Payload: " + getPayload());
sb.append("}");
return sb.toString();
}
@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.getPayload() == null ^ this.getPayload() == null)
return false;
if (other.getPayload() != null && other.getPayload().equals(this.getPayload()) == false)
return false;
return true;
}
@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 + ((getPayload() == null) ? 0 : getPayload().hashCode());
return hashCode;
}
@Override
public PublishRequest clone() {
return (PublishRequest) super.clone();
}
}