software.amazon.awssdk.services.iotanalytics.model.BatchPutMessageRequest Maven / Gradle / Ivy
/*
* Copyright 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 software.amazon.awssdk.services.iotanalytics.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class BatchPutMessageRequest extends IoTAnalyticsRequest implements
ToCopyableBuilder {
private static final SdkField CHANNEL_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(BatchPutMessageRequest::channelName)).setter(setter(Builder::channelName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("channelName").build()).build();
private static final SdkField> MESSAGES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(BatchPutMessageRequest::messages))
.setter(setter(Builder::messages))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("messages").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Message::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CHANNEL_NAME_FIELD,
MESSAGES_FIELD));
private final String channelName;
private final List messages;
private BatchPutMessageRequest(BuilderImpl builder) {
super(builder);
this.channelName = builder.channelName;
this.messages = builder.messages;
}
/**
*
* The name of the channel where the messages are sent.
*
*
* @return The name of the channel where the messages are sent.
*/
public String channelName() {
return channelName;
}
/**
* Returns true if the Messages property was specified by the sender (it may be empty), or false if the sender did
* not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public boolean hasMessages() {
return messages != null && !(messages instanceof SdkAutoConstructList);
}
/**
*
* The list of messages to be sent. Each message has format: '{ "messageId": "string", "payload": "string"}'.
*
*
* Note that the field names of message payloads (data) that you send to AWS 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 greater 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.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasMessages()} to see if a value was sent in this field.
*
*
* @return The list of messages to be sent. Each message has format: '{ "messageId": "string", "payload":
* "string"}'.
*
* Note that the field names of message payloads (data) that you send to AWS 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 greater 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 List messages() {
return messages;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(channelName());
hashCode = 31 * hashCode + Objects.hashCode(messages());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof BatchPutMessageRequest)) {
return false;
}
BatchPutMessageRequest other = (BatchPutMessageRequest) obj;
return Objects.equals(channelName(), other.channelName()) && Objects.equals(messages(), other.messages());
}
/**
* 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.
*/
@Override
public String toString() {
return ToString.builder("BatchPutMessageRequest").add("ChannelName", channelName()).add("Messages", messages()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "channelName":
return Optional.ofNullable(clazz.cast(channelName()));
case "messages":
return Optional.ofNullable(clazz.cast(messages()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((BatchPutMessageRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IoTAnalyticsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* 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.
*/
Builder channelName(String channelName);
/**
*
* The list of messages to be sent. Each message has format: '{ "messageId": "string", "payload": "string"}'.
*
*
* Note that the field names of message payloads (data) that you send to AWS 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 greater 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 format: '{ "messageId": "string", "payload":
* "string"}'.
*
* Note that the field names of message payloads (data) that you send to AWS 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 greater 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.
*/
Builder messages(Collection messages);
/**
*
* The list of messages to be sent. Each message has format: '{ "messageId": "string", "payload": "string"}'.
*
*
* Note that the field names of message payloads (data) that you send to AWS 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 greater 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 format: '{ "messageId": "string", "payload":
* "string"}'.
*
* Note that the field names of message payloads (data) that you send to AWS 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 greater 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.
*/
Builder messages(Message... messages);
/**
*
* The list of messages to be sent. Each message has format: '{ "messageId": "string", "payload": "string"}'.
*
*
* Note that the field names of message payloads (data) that you send to AWS 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 greater 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.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to
* create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its
* result is passed to {@link #messages(List)}.
*
* @param messages
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #messages(List)
*/
Builder messages(Consumer... messages);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends IoTAnalyticsRequest.BuilderImpl implements Builder {
private String channelName;
private List messages = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(BatchPutMessageRequest model) {
super(model);
channelName(model.channelName);
messages(model.messages);
}
public final String getChannelName() {
return channelName;
}
@Override
public final Builder channelName(String channelName) {
this.channelName = channelName;
return this;
}
public final void setChannelName(String channelName) {
this.channelName = channelName;
}
public final Collection getMessages() {
return messages != null ? messages.stream().map(Message::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder messages(Collection messages) {
this.messages = MessagesCopier.copy(messages);
return this;
}
@Override
@SafeVarargs
public final Builder messages(Message... messages) {
messages(Arrays.asList(messages));
return this;
}
@Override
@SafeVarargs
public final Builder messages(Consumer... messages) {
messages(Stream.of(messages).map(c -> Message.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setMessages(Collection messages) {
this.messages = MessagesCopier.copyFromBuilder(messages);
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public BatchPutMessageRequest build() {
return new BatchPutMessageRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}