software.amazon.awssdk.services.dynamodb.model.ListTablesResponse 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.Function;
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;
/**
*
* Represents the output of a ListTables operation.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ListTablesResponse extends DynamoDbResponse implements
ToCopyableBuilder {
private static final SdkField> TABLE_NAMES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("TableNames")
.getter(getter(ListTablesResponse::tableNames))
.setter(setter(Builder::tableNames))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TableNames").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField LAST_EVALUATED_TABLE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LastEvaluatedTableName").getter(getter(ListTablesResponse::lastEvaluatedTableName))
.setter(setter(Builder::lastEvaluatedTableName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastEvaluatedTableName").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TABLE_NAMES_FIELD,
LAST_EVALUATED_TABLE_NAME_FIELD));
private final List tableNames;
private final String lastEvaluatedTableName;
private ListTablesResponse(BuilderImpl builder) {
super(builder);
this.tableNames = builder.tableNames;
this.lastEvaluatedTableName = builder.lastEvaluatedTableName;
}
/**
* For responses, this returns true if the service returned a value for the TableNames 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 hasTableNames() {
return tableNames != null && !(tableNames instanceof SdkAutoConstructList);
}
/**
*
* The names of the tables associated with the current account at the current endpoint. The maximum size of this
* array is 100.
*
*
* If LastEvaluatedTableName also appears in the output, you can use this value as the
* ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the
* next page of results.
*
*
* 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 #hasTableNames} method.
*
*
* @return The names of the tables associated with the current account at the current endpoint. The maximum size of
* this array is 100.
*
* If LastEvaluatedTableName also appears in the output, you can use this value as the
* ExclusiveStartTableName parameter in a subsequent ListTables request and obtain
* the next page of results.
*/
public final List tableNames() {
return tableNames;
}
/**
*
* The name of the last table in the current page of results. Use this value as the
* ExclusiveStartTableName in a new request to obtain the next page of results, until all the table
* names are returned.
*
*
* If you do not receive a LastEvaluatedTableName value in the response, this means that there are no
* more table names to be retrieved.
*
*
* @return The name of the last table in the current page of results. Use this value as the
* ExclusiveStartTableName in a new request to obtain the next page of results, until all the
* table names are returned.
*
* If you do not receive a LastEvaluatedTableName value in the response, this means that there
* are no more table names to be retrieved.
*/
public final String lastEvaluatedTableName() {
return lastEvaluatedTableName;
}
@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(hasTableNames() ? tableNames() : null);
hashCode = 31 * hashCode + Objects.hashCode(lastEvaluatedTableName());
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 ListTablesResponse)) {
return false;
}
ListTablesResponse other = (ListTablesResponse) obj;
return hasTableNames() == other.hasTableNames() && Objects.equals(tableNames(), other.tableNames())
&& Objects.equals(lastEvaluatedTableName(), other.lastEvaluatedTableName());
}
/**
* 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("ListTablesResponse").add("TableNames", hasTableNames() ? tableNames() : null)
.add("LastEvaluatedTableName", lastEvaluatedTableName()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "TableNames":
return Optional.ofNullable(clazz.cast(tableNames()));
case "LastEvaluatedTableName":
return Optional.ofNullable(clazz.cast(lastEvaluatedTableName()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListTablesResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends DynamoDbResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The names of the tables associated with the current account at the current endpoint. The maximum size of this
* array is 100.
*
*
* If LastEvaluatedTableName also appears in the output, you can use this value as the
* ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the
* next page of results.
*
*
* @param tableNames
* The names of the tables associated with the current account at the current endpoint. The maximum size
* of this array is 100.
*
* If LastEvaluatedTableName also appears in the output, you can use this value as the
* ExclusiveStartTableName parameter in a subsequent ListTables request and
* obtain the next page of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tableNames(Collection tableNames);
/**
*
* The names of the tables associated with the current account at the current endpoint. The maximum size of this
* array is 100.
*
*
* If LastEvaluatedTableName also appears in the output, you can use this value as the
* ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the
* next page of results.
*
*
* @param tableNames
* The names of the tables associated with the current account at the current endpoint. The maximum size
* of this array is 100.
*
* If LastEvaluatedTableName also appears in the output, you can use this value as the
* ExclusiveStartTableName parameter in a subsequent ListTables request and
* obtain the next page of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tableNames(String... tableNames);
/**
*
* The name of the last table in the current page of results. Use this value as the
* ExclusiveStartTableName in a new request to obtain the next page of results, until all the table
* names are returned.
*
*
* If you do not receive a LastEvaluatedTableName value in the response, this means that there are
* no more table names to be retrieved.
*
*
* @param lastEvaluatedTableName
* The name of the last table in the current page of results. Use this value as the
* ExclusiveStartTableName in a new request to obtain the next page of results, until all
* the table names are returned.
*
* If you do not receive a LastEvaluatedTableName value in the response, this means that
* there are no more table names to be retrieved.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastEvaluatedTableName(String lastEvaluatedTableName);
}
static final class BuilderImpl extends DynamoDbResponse.BuilderImpl implements Builder {
private List tableNames = DefaultSdkAutoConstructList.getInstance();
private String lastEvaluatedTableName;
private BuilderImpl() {
}
private BuilderImpl(ListTablesResponse model) {
super(model);
tableNames(model.tableNames);
lastEvaluatedTableName(model.lastEvaluatedTableName);
}
public final Collection getTableNames() {
if (tableNames instanceof SdkAutoConstructList) {
return null;
}
return tableNames;
}
public final void setTableNames(Collection tableNames) {
this.tableNames = TableNameListCopier.copy(tableNames);
}
@Override
public final Builder tableNames(Collection tableNames) {
this.tableNames = TableNameListCopier.copy(tableNames);
return this;
}
@Override
@SafeVarargs
public final Builder tableNames(String... tableNames) {
tableNames(Arrays.asList(tableNames));
return this;
}
public final String getLastEvaluatedTableName() {
return lastEvaluatedTableName;
}
public final void setLastEvaluatedTableName(String lastEvaluatedTableName) {
this.lastEvaluatedTableName = lastEvaluatedTableName;
}
@Override
public final Builder lastEvaluatedTableName(String lastEvaluatedTableName) {
this.lastEvaluatedTableName = lastEvaluatedTableName;
return this;
}
@Override
public ListTablesResponse build() {
return new ListTablesResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}