Package software.amazon.awssdk.services.sns.model

Class PublishBatchRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sns.model.SnsRequest

software.amazon.awssdk.services.sns.model.PublishBatchRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PublishBatchRequest.Builder,PublishBatchRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PublishBatchRequest
extends SnsRequest
implements ToCopyableBuilder<PublishBatchRequest.Builder,PublishBatchRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PublishBatchRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PublishBatchRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPublishBatchRequestEntries()	For responses, this returns true if the service returned a value for the PublishBatchRequestEntries property.
List<PublishBatchRequestEntry>	publishBatchRequestEntries()	A list of PublishBatch request entries to be sent to the SNS topic.
List<SdkField<?>>	sdkFields()
static Class<? extends PublishBatchRequest.Builder>	serializableBuilderClass()
PublishBatchRequest.Builder	toBuilder()
String	topicArn()	The Amazon resource name (ARN) of the topic you want to batch publish to.
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

topicArn

public final String topicArn()

The Amazon resource name (ARN) of the topic you want to batch publish to.

Returns:

The Amazon resource name (ARN) of the topic you want to batch publish to.

hasPublishBatchRequestEntries

public final boolean hasPublishBatchRequestEntries()

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 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.

publishBatchRequestEntries

public final List<PublishBatchRequestEntry> publishBatchRequestEntries()

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 hasPublishBatchRequestEntries() method.

Returns:

A list of PublishBatch request entries to be sent to the SNS topic.

toBuilder

public PublishBatchRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PublishBatchRequest.Builder,PublishBatchRequest>

Specified by:

toBuilder in class SnsRequest

builder

public static PublishBatchRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PublishBatchRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo