software.amazon.awssdk.services.sns.model.PublishBatchRequest Maven / Gradle / Ivy
Show all versions of sns Show documentation
/*
* 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.sns.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 PublishBatchRequest extends SnsRequest implements
ToCopyableBuilder {
private static final SdkField TOPIC_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TopicArn").getter(getter(PublishBatchRequest::topicArn)).setter(setter(Builder::topicArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TopicArn").build()).build();
private static final SdkField> PUBLISH_BATCH_REQUEST_ENTRIES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("PublishBatchRequestEntries")
.getter(getter(PublishBatchRequest::publishBatchRequestEntries))
.setter(setter(Builder::publishBatchRequestEntries))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PublishBatchRequestEntries").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(PublishBatchRequestEntry::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TOPIC_ARN_FIELD,
PUBLISH_BATCH_REQUEST_ENTRIES_FIELD));
private final String topicArn;
private final List publishBatchRequestEntries;
private PublishBatchRequest(BuilderImpl builder) {
super(builder);
this.topicArn = builder.topicArn;
this.publishBatchRequestEntries = builder.publishBatchRequestEntries;
}
/**
*
* The Amazon resource name (ARN) of the topic you want to batch publish to.
*
*
* @return The Amazon resource name (ARN) of the topic you want to batch publish to.
*/
public final String topicArn() {
return topicArn;
}
/**
* For responses, this returns true if the service returned a value for the PublishBatchRequestEntries property.
* This DOES NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the
* property). This is useful because the SDK will never return a null collection or map, but you may need to
* differentiate between the service returning nothing (or null) and the service returning an empty collection or
* map. For requests, this returns true if a value for the property was specified in the request builder, and false
* if a value was not specified.
*/
public final boolean hasPublishBatchRequestEntries() {
return publishBatchRequestEntries != null && !(publishBatchRequestEntries instanceof SdkAutoConstructList);
}
/**
*
* A list of PublishBatch request entries to be sent to the SNS topic.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasPublishBatchRequestEntries} method.
*
*
* @return A list of PublishBatch request entries to be sent to the SNS topic.
*/
public final List publishBatchRequestEntries() {
return publishBatchRequestEntries;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(topicArn());
hashCode = 31 * hashCode + Objects.hashCode(hasPublishBatchRequestEntries() ? publishBatchRequestEntries() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof PublishBatchRequest)) {
return false;
}
PublishBatchRequest other = (PublishBatchRequest) obj;
return Objects.equals(topicArn(), other.topicArn())
&& hasPublishBatchRequestEntries() == other.hasPublishBatchRequestEntries()
&& Objects.equals(publishBatchRequestEntries(), other.publishBatchRequestEntries());
}
/**
* 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 final String toString() {
return ToString.builder("PublishBatchRequest").add("TopicArn", topicArn())
.add("PublishBatchRequestEntries", hasPublishBatchRequestEntries() ? publishBatchRequestEntries() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "TopicArn":
return Optional.ofNullable(clazz.cast(topicArn()));
case "PublishBatchRequestEntries":
return Optional.ofNullable(clazz.cast(publishBatchRequestEntries()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PublishBatchRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SnsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The Amazon resource name (ARN) of the topic you want to batch publish to.
*
*
* @param topicArn
* The Amazon resource name (ARN) of the topic you want to batch publish to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder topicArn(String topicArn);
/**
*
* A list of PublishBatch request entries to be sent to the SNS topic.
*
*
* @param publishBatchRequestEntries
* A list of PublishBatch request entries to be sent to the SNS topic.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder publishBatchRequestEntries(Collection publishBatchRequestEntries);
/**
*
* A list of PublishBatch request entries to be sent to the SNS topic.
*
*
* @param publishBatchRequestEntries
* A list of PublishBatch request entries to be sent to the SNS topic.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder publishBatchRequestEntries(PublishBatchRequestEntry... publishBatchRequestEntries);
/**
*
* A list of PublishBatch request entries to be sent to the SNS topic.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.sns.model.PublishBatchRequestEntry.Builder} avoiding the need to
* create one manually via {@link software.amazon.awssdk.services.sns.model.PublishBatchRequestEntry#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.sns.model.PublishBatchRequestEntry.Builder#build()} is called
* immediately and its result is passed to {@link #publishBatchRequestEntries(List)}.
*
* @param publishBatchRequestEntries
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.sns.model.PublishBatchRequestEntry.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #publishBatchRequestEntries(java.util.Collection)
*/
Builder publishBatchRequestEntries(Consumer... publishBatchRequestEntries);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SnsRequest.BuilderImpl implements Builder {
private String topicArn;
private List publishBatchRequestEntries = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(PublishBatchRequest model) {
super(model);
topicArn(model.topicArn);
publishBatchRequestEntries(model.publishBatchRequestEntries);
}
public final String getTopicArn() {
return topicArn;
}
public final void setTopicArn(String topicArn) {
this.topicArn = topicArn;
}
@Override
public final Builder topicArn(String topicArn) {
this.topicArn = topicArn;
return this;
}
public final List getPublishBatchRequestEntries() {
List result = PublishBatchRequestEntryListCopier
.copyToBuilder(this.publishBatchRequestEntries);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setPublishBatchRequestEntries(
Collection publishBatchRequestEntries) {
this.publishBatchRequestEntries = PublishBatchRequestEntryListCopier.copyFromBuilder(publishBatchRequestEntries);
}
@Override
public final Builder publishBatchRequestEntries(Collection publishBatchRequestEntries) {
this.publishBatchRequestEntries = PublishBatchRequestEntryListCopier.copy(publishBatchRequestEntries);
return this;
}
@Override
@SafeVarargs
public final Builder publishBatchRequestEntries(PublishBatchRequestEntry... publishBatchRequestEntries) {
publishBatchRequestEntries(Arrays.asList(publishBatchRequestEntries));
return this;
}
@Override
@SafeVarargs
public final Builder publishBatchRequestEntries(Consumer... publishBatchRequestEntries) {
publishBatchRequestEntries(Stream.of(publishBatchRequestEntries)
.map(c -> PublishBatchRequestEntry.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public PublishBatchRequest build() {
return new PublishBatchRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}