com.amazonaws.services.iotanalytics.model

Class BatchPutMessageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iotanalytics.model.BatchPutMessageRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BatchPutMessageRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
BatchPutMessageRequest()

Method Summary

Modifier and Type	Method and Description
BatchPutMessageRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getChannelName() The name of the channel where the messages are sent.
List<Message>	getMessages() The list of messages to be sent.
int	hashCode()
void	setChannelName(String channelName) The name of the channel where the messages are sent.
void	setMessages(Collection<Message> messages) The list of messages to be sent.
String	toString() Returns a string representation of this object.
BatchPutMessageRequest	withChannelName(String channelName) The name of the channel where the messages are sent.
BatchPutMessageRequest	withMessages(Collection<Message> messages) The list of messages to be sent.
BatchPutMessageRequest	withMessages(Message... messages) The list of messages to be sent.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BatchPutMessageRequest

public BatchPutMessageRequest()

Method Detail

setChannelName

public void setChannelName(String channelName)

The name of the channel where the messages are sent.

Parameters:

channelName - The name of the channel where the messages are sent.

getChannelName

public String getChannelName()

The name of the channel where the messages are sent.

Returns:

The name of the channel where the messages are sent.

withChannelName

public BatchPutMessageRequest withChannelName(String channelName)

The name of the channel where the messages are sent.

Parameters:

channelName - The name of the channel where the messages are sent.

Returns:

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

getMessages

public List<Message> getMessages()

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.

Returns:

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.

setMessages

public void setMessages(Collection<Message> 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.

Parameters:

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.

withMessages

public BatchPutMessageRequest withMessages(Message... 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 setMessages(java.util.Collection) or withMessages(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

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

withMessages

public BatchPutMessageRequest withMessages(Collection<Message> 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.

Parameters:

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.

Returns:

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

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public BatchPutMessageRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()