com.amazonaws.services.dynamodbv2.model.ListTablesRequest Maven / Gradle / Ivy
Show all versions of aws-sdk-android Show documentation
/*
* Copyright 2010-2015 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 com.amazonaws.services.dynamodbv2.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.dynamodbv2.AmazonDynamoDB#listTables(ListTablesRequest) ListTables operation}.
*
* Returns an array of table names associated with the current account
* and endpoint. The output from ListTables is paginated, with
* each page returning a maximum of 100 table names.
*
*
* @see com.amazonaws.services.dynamodbv2.AmazonDynamoDB#listTables(ListTablesRequest)
*/
public class ListTablesRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The first table name that this operation will evaluate. Use the value
* that was returned for LastEvaluatedTableName in a previous
* operation, so that you can obtain the next page of results.
*
* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
*/
private String exclusiveStartTableName;
/**
* A maximum number of table names to return. If this parameter is not
* specified, the limit is 100.
*
* Constraints:
* Range: 1 - 100
*/
private Integer limit;
/**
* Default constructor for a new ListTablesRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public ListTablesRequest() {}
/**
* Constructs a new ListTablesRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param exclusiveStartTableName The first table name that this
* operation will evaluate. Use the value that was returned for
* LastEvaluatedTableName in a previous operation, so that you can
* obtain the next page of results.
*/
public ListTablesRequest(String exclusiveStartTableName) {
setExclusiveStartTableName(exclusiveStartTableName);
}
/**
* Constructs a new ListTablesRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param exclusiveStartTableName The first table name that this
* operation will evaluate. Use the value that was returned for
* LastEvaluatedTableName in a previous operation, so that you can
* obtain the next page of results.
* @param limit A maximum number of table names to return. If this
* parameter is not specified, the limit is 100.
*/
public ListTablesRequest(String exclusiveStartTableName, Integer limit) {
setExclusiveStartTableName(exclusiveStartTableName);
setLimit(limit);
}
/**
* The first table name that this operation will evaluate. Use the value
* that was returned for LastEvaluatedTableName in a previous
* operation, so that you can obtain the next page of results.
*
* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
*
* @return The first table name that this operation will evaluate. Use the value
* that was returned for LastEvaluatedTableName in a previous
* operation, so that you can obtain the next page of results.
*/
public String getExclusiveStartTableName() {
return exclusiveStartTableName;
}
/**
* The first table name that this operation will evaluate. Use the value
* that was returned for LastEvaluatedTableName in a previous
* operation, so that you can obtain the next page of results.
*
* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
*
* @param exclusiveStartTableName The first table name that this operation will evaluate. Use the value
* that was returned for LastEvaluatedTableName in a previous
* operation, so that you can obtain the next page of results.
*/
public void setExclusiveStartTableName(String exclusiveStartTableName) {
this.exclusiveStartTableName = exclusiveStartTableName;
}
/**
* The first table name that this operation will evaluate. Use the value
* that was returned for LastEvaluatedTableName in a previous
* operation, so that you can obtain the next page of results.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 3 - 255
* Pattern: [a-zA-Z0-9_.-]+
*
* @param exclusiveStartTableName The first table name that this operation will evaluate. Use the value
* that was returned for LastEvaluatedTableName in a previous
* operation, so that you can obtain the next page of results.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ListTablesRequest withExclusiveStartTableName(String exclusiveStartTableName) {
this.exclusiveStartTableName = exclusiveStartTableName;
return this;
}
/**
* A maximum number of table names to return. If this parameter is not
* specified, the limit is 100.
*
* Constraints:
* Range: 1 - 100
*
* @return A maximum number of table names to return. If this parameter is not
* specified, the limit is 100.
*/
public Integer getLimit() {
return limit;
}
/**
* A maximum number of table names to return. If this parameter is not
* specified, the limit is 100.
*
* Constraints:
* Range: 1 - 100
*
* @param limit A maximum number of table names to return. If this parameter is not
* specified, the limit is 100.
*/
public void setLimit(Integer limit) {
this.limit = limit;
}
/**
* A maximum number of table names to return. If this parameter is not
* specified, the limit is 100.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Range: 1 - 100
*
* @param limit A maximum number of table names to return. If this parameter is not
* specified, the limit is 100.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ListTablesRequest withLimit(Integer limit) {
this.limit = limit;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getExclusiveStartTableName() != null) sb.append("ExclusiveStartTableName: " + getExclusiveStartTableName() + ",");
if (getLimit() != null) sb.append("Limit: " + getLimit() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getExclusiveStartTableName() == null) ? 0 : getExclusiveStartTableName().hashCode());
hashCode = prime * hashCode + ((getLimit() == null) ? 0 : getLimit().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof ListTablesRequest == false) return false;
ListTablesRequest other = (ListTablesRequest)obj;
if (other.getExclusiveStartTableName() == null ^ this.getExclusiveStartTableName() == null) return false;
if (other.getExclusiveStartTableName() != null && other.getExclusiveStartTableName().equals(this.getExclusiveStartTableName()) == false) return false;
if (other.getLimit() == null ^ this.getLimit() == null) return false;
if (other.getLimit() != null && other.getLimit().equals(this.getLimit()) == false) return false;
return true;
}
}