software.amazon.awssdk.services.dynamodb.model.BatchExecuteStatementRequest 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.dynamodb.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 BatchExecuteStatementRequest extends DynamoDbRequest implements
ToCopyableBuilder {
private static final SdkField> STATEMENTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Statements")
.getter(getter(BatchExecuteStatementRequest::statements))
.setter(setter(Builder::statements))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Statements").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(BatchStatementRequest::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField RETURN_CONSUMED_CAPACITY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ReturnConsumedCapacity").getter(getter(BatchExecuteStatementRequest::returnConsumedCapacityAsString))
.setter(setter(Builder::returnConsumedCapacity))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReturnConsumedCapacity").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(STATEMENTS_FIELD,
RETURN_CONSUMED_CAPACITY_FIELD));
private final List statements;
private final String returnConsumedCapacity;
private BatchExecuteStatementRequest(BuilderImpl builder) {
super(builder);
this.statements = builder.statements;
this.returnConsumedCapacity = builder.returnConsumedCapacity;
}
/**
* For responses, this returns true if the service returned a value for the Statements 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 hasStatements() {
return statements != null && !(statements instanceof SdkAutoConstructList);
}
/**
*
* The list of PartiQL statements representing the batch to run.
*
*
* 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 #hasStatements} method.
*
*
* @return The list of PartiQL statements representing the batch to run.
*/
public final List statements() {
return statements;
}
/**
* Returns the value of the ReturnConsumedCapacity property for this object.
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #returnConsumedCapacity} will return {@link ReturnConsumedCapacity#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #returnConsumedCapacityAsString}.
*
*
* @return The value of the ReturnConsumedCapacity property for this object.
* @see ReturnConsumedCapacity
*/
public final ReturnConsumedCapacity returnConsumedCapacity() {
return ReturnConsumedCapacity.fromValue(returnConsumedCapacity);
}
/**
* Returns the value of the ReturnConsumedCapacity property for this object.
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #returnConsumedCapacity} will return {@link ReturnConsumedCapacity#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #returnConsumedCapacityAsString}.
*
*
* @return The value of the ReturnConsumedCapacity property for this object.
* @see ReturnConsumedCapacity
*/
public final String returnConsumedCapacityAsString() {
return returnConsumedCapacity;
}
@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(hasStatements() ? statements() : null);
hashCode = 31 * hashCode + Objects.hashCode(returnConsumedCapacityAsString());
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 BatchExecuteStatementRequest)) {
return false;
}
BatchExecuteStatementRequest other = (BatchExecuteStatementRequest) obj;
return hasStatements() == other.hasStatements() && Objects.equals(statements(), other.statements())
&& Objects.equals(returnConsumedCapacityAsString(), other.returnConsumedCapacityAsString());
}
/**
* 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("BatchExecuteStatementRequest").add("Statements", hasStatements() ? statements() : null)
.add("ReturnConsumedCapacity", returnConsumedCapacityAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Statements":
return Optional.ofNullable(clazz.cast(statements()));
case "ReturnConsumedCapacity":
return Optional.ofNullable(clazz.cast(returnConsumedCapacityAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((BatchExecuteStatementRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends DynamoDbRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The list of PartiQL statements representing the batch to run.
*
*
* @param statements
* The list of PartiQL statements representing the batch to run.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder statements(Collection statements);
/**
*
* The list of PartiQL statements representing the batch to run.
*
*
* @param statements
* The list of PartiQL statements representing the batch to run.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder statements(BatchStatementRequest... statements);
/**
*
* The list of PartiQL statements representing the batch to run.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.dynamodb.model.BatchStatementRequest.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.dynamodb.model.BatchStatementRequest#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.dynamodb.model.BatchStatementRequest.Builder#build()} is called
* immediately and its result is passed to {@link #statements(List)}.
*
* @param statements
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.dynamodb.model.BatchStatementRequest.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #statements(java.util.Collection)
*/
Builder statements(Consumer... statements);
/**
* Sets the value of the ReturnConsumedCapacity property for this object.
*
* @param returnConsumedCapacity
* The new value for the ReturnConsumedCapacity property for this object.
* @see ReturnConsumedCapacity
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReturnConsumedCapacity
*/
Builder returnConsumedCapacity(String returnConsumedCapacity);
/**
* Sets the value of the ReturnConsumedCapacity property for this object.
*
* @param returnConsumedCapacity
* The new value for the ReturnConsumedCapacity property for this object.
* @see ReturnConsumedCapacity
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReturnConsumedCapacity
*/
Builder returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends DynamoDbRequest.BuilderImpl implements Builder {
private List statements = DefaultSdkAutoConstructList.getInstance();
private String returnConsumedCapacity;
private BuilderImpl() {
}
private BuilderImpl(BatchExecuteStatementRequest model) {
super(model);
statements(model.statements);
returnConsumedCapacity(model.returnConsumedCapacity);
}
public final List getStatements() {
List result = PartiQLBatchRequestCopier.copyToBuilder(this.statements);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setStatements(Collection statements) {
this.statements = PartiQLBatchRequestCopier.copyFromBuilder(statements);
}
@Override
public final Builder statements(Collection statements) {
this.statements = PartiQLBatchRequestCopier.copy(statements);
return this;
}
@Override
@SafeVarargs
public final Builder statements(BatchStatementRequest... statements) {
statements(Arrays.asList(statements));
return this;
}
@Override
@SafeVarargs
public final Builder statements(Consumer... statements) {
statements(Stream.of(statements).map(c -> BatchStatementRequest.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getReturnConsumedCapacity() {
return returnConsumedCapacity;
}
public final void setReturnConsumedCapacity(String returnConsumedCapacity) {
this.returnConsumedCapacity = returnConsumedCapacity;
}
@Override
public final Builder returnConsumedCapacity(String returnConsumedCapacity) {
this.returnConsumedCapacity = returnConsumedCapacity;
return this;
}
@Override
public final Builder returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) {
this.returnConsumedCapacity(returnConsumedCapacity == null ? null : returnConsumedCapacity.toString());
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 BatchExecuteStatementRequest build() {
return new BatchExecuteStatementRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}