software.amazon.awssdk.services.sqs.model.DeleteMessageBatchResponse Maven / Gradle / Ivy
Show all versions of sqs 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.sqs.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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.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;
/**
*
* For each message in the batch, the response contains a DeleteMessageBatchResultEntry tag if the
* message is deleted or a BatchResultErrorEntry tag if the message can't be deleted.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DeleteMessageBatchResponse extends SqsResponse implements
ToCopyableBuilder {
private static final SdkField> SUCCESSFUL_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Successful")
.getter(getter(DeleteMessageBatchResponse::successful))
.setter(setter(Builder::successful))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Successful").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(DeleteMessageBatchResultEntry::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).isFlattened(true).build()).build();
private static final SdkField> FAILED_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Failed")
.getter(getter(DeleteMessageBatchResponse::failed))
.setter(setter(Builder::failed))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Failed").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(BatchResultErrorEntry::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).isFlattened(true).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays
.asList(SUCCESSFUL_FIELD, FAILED_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("Successful", SUCCESSFUL_FIELD);
put("Failed", FAILED_FIELD);
}
});
private final List successful;
private final List failed;
private DeleteMessageBatchResponse(BuilderImpl builder) {
super(builder);
this.successful = builder.successful;
this.failed = builder.failed;
}
/**
* For responses, this returns true if the service returned a value for the Successful 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 hasSuccessful() {
return successful != null && !(successful instanceof SdkAutoConstructList);
}
/**
*
* A list of DeleteMessageBatchResultEntry items.
*
*
* 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 #hasSuccessful} method.
*
*
* @return A list of DeleteMessageBatchResultEntry items.
*/
public final List successful() {
return successful;
}
/**
* For responses, this returns true if the service returned a value for the Failed 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 hasFailed() {
return failed != null && !(failed instanceof SdkAutoConstructList);
}
/**
*
* A list of BatchResultErrorEntry items.
*
*
* 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 #hasFailed} method.
*
*
* @return A list of BatchResultErrorEntry items.
*/
public final List failed() {
return failed;
}
@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(hasSuccessful() ? successful() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasFailed() ? failed() : 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 DeleteMessageBatchResponse)) {
return false;
}
DeleteMessageBatchResponse other = (DeleteMessageBatchResponse) obj;
return hasSuccessful() == other.hasSuccessful() && Objects.equals(successful(), other.successful())
&& hasFailed() == other.hasFailed() && Objects.equals(failed(), other.failed());
}
/**
* 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("DeleteMessageBatchResponse").add("Successful", hasSuccessful() ? successful() : null)
.add("Failed", hasFailed() ? failed() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Successful":
return Optional.ofNullable(clazz.cast(successful()));
case "Failed":
return Optional.ofNullable(clazz.cast(failed()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((DeleteMessageBatchResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SqsResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* A list of DeleteMessageBatchResultEntry items.
*
*
* @param successful
* A list of DeleteMessageBatchResultEntry items.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder successful(Collection successful);
/**
*
* A list of DeleteMessageBatchResultEntry items.
*
*
* @param successful
* A list of DeleteMessageBatchResultEntry items.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder successful(DeleteMessageBatchResultEntry... successful);
/**
*
* A list of DeleteMessageBatchResultEntry items.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.sqs.model.DeleteMessageBatchResultEntry.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.sqs.model.DeleteMessageBatchResultEntry#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.sqs.model.DeleteMessageBatchResultEntry.Builder#build()} is called
* immediately and its result is passed to {@link #successful(List)}.
*
* @param successful
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.sqs.model.DeleteMessageBatchResultEntry.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #successful(java.util.Collection)
*/
Builder successful(Consumer... successful);
/**
*
* A list of BatchResultErrorEntry items.
*
*
* @param failed
* A list of BatchResultErrorEntry items.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder failed(Collection failed);
/**
*
* A list of BatchResultErrorEntry items.
*
*
* @param failed
* A list of BatchResultErrorEntry items.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder failed(BatchResultErrorEntry... failed);
/**
*
* A list of BatchResultErrorEntry items.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.sqs.model.BatchResultErrorEntry.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.sqs.model.BatchResultErrorEntry#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.sqs.model.BatchResultErrorEntry.Builder#build()} is called immediately
* and its result is passed to {@link #failed(List)}.
*
* @param failed
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.sqs.model.BatchResultErrorEntry.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #failed(java.util.Collection)
*/
Builder failed(Consumer... failed);
}
static final class BuilderImpl extends SqsResponse.BuilderImpl implements Builder {
private List successful = DefaultSdkAutoConstructList.getInstance();
private List failed = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DeleteMessageBatchResponse model) {
super(model);
successful(model.successful);
failed(model.failed);
}
public final List getSuccessful() {
List result = DeleteMessageBatchResultEntryListCopier
.copyToBuilder(this.successful);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setSuccessful(Collection successful) {
this.successful = DeleteMessageBatchResultEntryListCopier.copyFromBuilder(successful);
}
@Override
public final Builder successful(Collection successful) {
this.successful = DeleteMessageBatchResultEntryListCopier.copy(successful);
return this;
}
@Override
@SafeVarargs
public final Builder successful(DeleteMessageBatchResultEntry... successful) {
successful(Arrays.asList(successful));
return this;
}
@Override
@SafeVarargs
public final Builder successful(Consumer... successful) {
successful(Stream.of(successful).map(c -> DeleteMessageBatchResultEntry.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getFailed() {
List result = BatchResultErrorEntryListCopier.copyToBuilder(this.failed);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setFailed(Collection failed) {
this.failed = BatchResultErrorEntryListCopier.copyFromBuilder(failed);
}
@Override
public final Builder failed(Collection failed) {
this.failed = BatchResultErrorEntryListCopier.copy(failed);
return this;
}
@Override
@SafeVarargs
public final Builder failed(BatchResultErrorEntry... failed) {
failed(Arrays.asList(failed));
return this;
}
@Override
@SafeVarargs
public final Builder failed(Consumer... failed) {
failed(Stream.of(failed).map(c -> BatchResultErrorEntry.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public DeleteMessageBatchResponse build() {
return new DeleteMessageBatchResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}