software.amazon.awssdk.services.dynamodb.model.TransactGetItemsRequest 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 TransactGetItemsRequest extends DynamoDbRequest implements
ToCopyableBuilder {
private static final SdkField> TRANSACT_ITEMS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("TransactItems")
.getter(getter(TransactGetItemsRequest::transactItems))
.setter(setter(Builder::transactItems))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TransactItems").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(TransactGetItem::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(TransactGetItemsRequest::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(TRANSACT_ITEMS_FIELD,
RETURN_CONSUMED_CAPACITY_FIELD));
private final List transactItems;
private final String returnConsumedCapacity;
private TransactGetItemsRequest(BuilderImpl builder) {
super(builder);
this.transactItems = builder.transactItems;
this.returnConsumedCapacity = builder.returnConsumedCapacity;
}
/**
* For responses, this returns true if the service returned a value for the TransactItems 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 hasTransactItems() {
return transactItems != null && !(transactItems instanceof SdkAutoConstructList);
}
/**
*
* An ordered array of up to 100 TransactGetItem objects, each of which contains a Get
* structure.
*
*
* 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 #hasTransactItems} method.
*
*
* @return An ordered array of up to 100 TransactGetItem objects, each of which contains a
* Get structure.
*/
public final List transactItems() {
return transactItems;
}
/**
*
* A value of TOTAL causes consumed capacity information to be returned, and a value of
* NONE prevents that information from being returned. No other value is valid.
*
*
* 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 A value of TOTAL causes consumed capacity information to be returned, and a value of
* NONE prevents that information from being returned. No other value is valid.
* @see ReturnConsumedCapacity
*/
public final ReturnConsumedCapacity returnConsumedCapacity() {
return ReturnConsumedCapacity.fromValue(returnConsumedCapacity);
}
/**
*
* A value of TOTAL causes consumed capacity information to be returned, and a value of
* NONE prevents that information from being returned. No other value is valid.
*
*
* 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 A value of TOTAL causes consumed capacity information to be returned, and a value of
* NONE prevents that information from being returned. No other value is valid.
* @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(hasTransactItems() ? transactItems() : 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 TransactGetItemsRequest)) {
return false;
}
TransactGetItemsRequest other = (TransactGetItemsRequest) obj;
return hasTransactItems() == other.hasTransactItems() && Objects.equals(transactItems(), other.transactItems())
&& 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("TransactGetItemsRequest").add("TransactItems", hasTransactItems() ? transactItems() : null)
.add("ReturnConsumedCapacity", returnConsumedCapacityAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "TransactItems":
return Optional.ofNullable(clazz.cast(transactItems()));
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((TransactGetItemsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends DynamoDbRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* An ordered array of up to 100 TransactGetItem objects, each of which contains a Get
* structure.
*
*
* @param transactItems
* An ordered array of up to 100 TransactGetItem objects, each of which contains a
* Get structure.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder transactItems(Collection transactItems);
/**
*
* An ordered array of up to 100 TransactGetItem objects, each of which contains a Get
* structure.
*
*
* @param transactItems
* An ordered array of up to 100 TransactGetItem objects, each of which contains a
* Get structure.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder transactItems(TransactGetItem... transactItems);
/**
*
* An ordered array of up to 100 TransactGetItem objects, each of which contains a Get
* structure.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.dynamodb.model.TransactGetItem.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.dynamodb.model.TransactGetItem#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.dynamodb.model.TransactGetItem.Builder#build()} is called immediately
* and its result is passed to {@link #transactItems(List)}.
*
* @param transactItems
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.dynamodb.model.TransactGetItem.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #transactItems(java.util.Collection)
*/
Builder transactItems(Consumer... transactItems);
/**
*
* A value of TOTAL causes consumed capacity information to be returned, and a value of
* NONE prevents that information from being returned. No other value is valid.
*
*
* @param returnConsumedCapacity
* A value of TOTAL causes consumed capacity information to be returned, and a value of
* NONE prevents that information from being returned. No other value is valid.
* @see ReturnConsumedCapacity
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReturnConsumedCapacity
*/
Builder returnConsumedCapacity(String returnConsumedCapacity);
/**
*
* A value of TOTAL causes consumed capacity information to be returned, and a value of
* NONE prevents that information from being returned. No other value is valid.
*
*
* @param returnConsumedCapacity
* A value of TOTAL causes consumed capacity information to be returned, and a value of
* NONE prevents that information from being returned. No other value is valid.
* @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 transactItems = DefaultSdkAutoConstructList.getInstance();
private String returnConsumedCapacity;
private BuilderImpl() {
}
private BuilderImpl(TransactGetItemsRequest model) {
super(model);
transactItems(model.transactItems);
returnConsumedCapacity(model.returnConsumedCapacity);
}
public final List getTransactItems() {
List result = TransactGetItemListCopier.copyToBuilder(this.transactItems);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTransactItems(Collection transactItems) {
this.transactItems = TransactGetItemListCopier.copyFromBuilder(transactItems);
}
@Override
public final Builder transactItems(Collection transactItems) {
this.transactItems = TransactGetItemListCopier.copy(transactItems);
return this;
}
@Override
@SafeVarargs
public final Builder transactItems(TransactGetItem... transactItems) {
transactItems(Arrays.asList(transactItems));
return this;
}
@Override
@SafeVarargs
public final Builder transactItems(Consumer... transactItems) {
transactItems(Stream.of(transactItems).map(c -> TransactGetItem.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 TransactGetItemsRequest build() {
return new TransactGetItemsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}