com.amazonaws.services.iotanalytics.model.BatchPutMessageRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-iotanalytics Show documentation
/*
* Copyright 2019-2024 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.iotanalytics.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class BatchPutMessageRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the channel where the messages are sent.
*
*/
private String channelName;
/**
*
* The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.
*
*
* The field names of message payloads (data) that you send to IoT Analytics:
*
*
* -
*
* Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.
*
*
* -
*
* Must begin with an alphabetic character or single underscore (_).
*
*
* -
*
* Cannot contain hyphens (-).
*
*
* -
*
* In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".
*
*
* -
*
* Cannot be more than 255 characters.
*
*
* -
*
* Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)
*
*
*
*
* For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01":
* 29} are invalid in message payloads.
*
*/
private java.util.List messages;
/**
*
* The name of the channel where the messages are sent.
*
*
* @param channelName
* The name of the channel where the messages are sent.
*/
public void setChannelName(String channelName) {
this.channelName = channelName;
}
/**
*
* The name of the channel where the messages are sent.
*
*
* @return The name of the channel where the messages are sent.
*/
public String getChannelName() {
return this.channelName;
}
/**
*
* The name of the channel where the messages are sent.
*
*
* @param channelName
* The name of the channel where the messages are sent.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchPutMessageRequest withChannelName(String channelName) {
setChannelName(channelName);
return this;
}
/**
*
* The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.
*
*
* The field names of message payloads (data) that you send to IoT Analytics:
*
*
* -
*
* Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.
*
*
* -
*
* Must begin with an alphabetic character or single underscore (_).
*
*
* -
*
* Cannot contain hyphens (-).
*
*
* -
*
* In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".
*
*
* -
*
* Cannot be more than 255 characters.
*
*
* -
*
* Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)
*
*
*
*
* For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01":
* 29} are invalid in message payloads.
*
*
* @return The list of messages to be sent. Each message has the format: { "messageId": "string", "payload":
* "string"}.
*
* The field names of message payloads (data) that you send to IoT Analytics:
*
*
* -
*
* Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.
*
*
* -
*
* Must begin with an alphabetic character or single underscore (_).
*
*
* -
*
* Cannot contain hyphens (-).
*
*
* -
*
* In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".
*
*
* -
*
* Cannot be more than 255 characters.
*
*
* -
*
* Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)
*
*
*
*
* For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or
* {"__temp_01": 29} are invalid in message payloads.
*/
public java.util.List getMessages() {
return messages;
}
/**
*
* The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.
*
*
* The field names of message payloads (data) that you send to IoT Analytics:
*
*
* -
*
* Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.
*
*
* -
*
* Must begin with an alphabetic character or single underscore (_).
*
*
* -
*
* Cannot contain hyphens (-).
*
*
* -
*
* In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".
*
*
* -
*
* Cannot be more than 255 characters.
*
*
* -
*
* Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)
*
*
*
*
* For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01":
* 29} are invalid in message payloads.
*
*
* @param messages
* The list of messages to be sent. Each message has the format: { "messageId": "string", "payload":
* "string"}.
*
* The field names of message payloads (data) that you send to IoT Analytics:
*
*
* -
*
* Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.
*
*
* -
*
* Must begin with an alphabetic character or single underscore (_).
*
*
* -
*
* Cannot contain hyphens (-).
*
*
* -
*
* In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".
*
*
* -
*
* Cannot be more than 255 characters.
*
*
* -
*
* Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)
*
*
*
*
* For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or
* {"__temp_01": 29} are invalid in message payloads.
*/
public void setMessages(java.util.Collection messages) {
if (messages == null) {
this.messages = null;
return;
}
this.messages = new java.util.ArrayList(messages);
}
/**
*
* The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.
*
*
* The field names of message payloads (data) that you send to IoT Analytics:
*
*
* -
*
* Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.
*
*
* -
*
* Must begin with an alphabetic character or single underscore (_).
*
*
* -
*
* Cannot contain hyphens (-).
*
*
* -
*
* In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".
*
*
* -
*
* Cannot be more than 255 characters.
*
*
* -
*
* Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)
*
*
*
*
* For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01":
* 29} are invalid in message payloads.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setMessages(java.util.Collection)} or {@link #withMessages(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param messages
* The list of messages to be sent. Each message has the format: { "messageId": "string", "payload":
* "string"}.
*
* The field names of message payloads (data) that you send to IoT Analytics:
*
*
* -
*
* Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.
*
*
* -
*
* Must begin with an alphabetic character or single underscore (_).
*
*
* -
*
* Cannot contain hyphens (-).
*
*
* -
*
* In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".
*
*
* -
*
* Cannot be more than 255 characters.
*
*
* -
*
* Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)
*
*
*
*
* For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or
* {"__temp_01": 29} are invalid in message payloads.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchPutMessageRequest withMessages(Message... messages) {
if (this.messages == null) {
setMessages(new java.util.ArrayList(messages.length));
}
for (Message ele : messages) {
this.messages.add(ele);
}
return this;
}
/**
*
* The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.
*
*
* The field names of message payloads (data) that you send to IoT Analytics:
*
*
* -
*
* Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.
*
*
* -
*
* Must begin with an alphabetic character or single underscore (_).
*
*
* -
*
* Cannot contain hyphens (-).
*
*
* -
*
* In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".
*
*
* -
*
* Cannot be more than 255 characters.
*
*
* -
*
* Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)
*
*
*
*
* For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01":
* 29} are invalid in message payloads.
*
*
* @param messages
* The list of messages to be sent. Each message has the format: { "messageId": "string", "payload":
* "string"}.
*
* The field names of message payloads (data) that you send to IoT Analytics:
*
*
* -
*
* Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.
*
*
* -
*
* Must begin with an alphabetic character or single underscore (_).
*
*
* -
*
* Cannot contain hyphens (-).
*
*
* -
*
* In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".
*
*
* -
*
* Cannot be more than 255 characters.
*
*
* -
*
* Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)
*
*
*
*
* For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or
* {"__temp_01": 29} are invalid in message payloads.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BatchPutMessageRequest withMessages(java.util.Collection messages) {
setMessages(messages);
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 (getChannelName() != null)
sb.append("ChannelName: ").append(getChannelName()).append(",");
if (getMessages() != null)
sb.append("Messages: ").append(getMessages());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof BatchPutMessageRequest == false)
return false;
BatchPutMessageRequest other = (BatchPutMessageRequest) obj;
if (other.getChannelName() == null ^ this.getChannelName() == null)
return false;
if (other.getChannelName() != null && other.getChannelName().equals(this.getChannelName()) == false)
return false;
if (other.getMessages() == null ^ this.getMessages() == null)
return false;
if (other.getMessages() != null && other.getMessages().equals(this.getMessages()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getChannelName() == null) ? 0 : getChannelName().hashCode());
hashCode = prime * hashCode + ((getMessages() == null) ? 0 : getMessages().hashCode());
return hashCode;
}
@Override
public BatchPutMessageRequest clone() {
return (BatchPutMessageRequest) super.clone();
}
}