com.amazonaws.services.dynamodbv2.model

Class DescribeTableRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.dynamodbv2.model.DescribeTableRequest

All Implemented Interfaces:

Serializable

public class DescribeTableRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DescribeTable operation.

Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

NOTE: If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.

See Also:

AmazonDynamoDB.describeTable(DescribeTableRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeTableRequest() Default constructor for a new DescribeTableRequest object.
DescribeTableRequest(String tableName) Constructs a new DescribeTableRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getTableName() The name of the table to describe.
int	hashCode()
void	setTableName(String tableName) The name of the table to describe.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeTableRequest	withTableName(String tableName) The name of the table to describe.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeTableRequest

public DescribeTableRequest()

Default constructor for a new DescribeTableRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

DescribeTableRequest

public DescribeTableRequest(String tableName)

Constructs a new DescribeTableRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

tableName - The name of the table to describe.

Method Detail

getTableName

public String getTableName()

The name of the table to describe.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Returns:

The name of the table to describe.

setTableName

public void setTableName(String tableName)

The name of the table to describe.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Parameters:

tableName - The name of the table to describe.

withTableName

public DescribeTableRequest withTableName(String tableName)

The name of the table to describe.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Parameters:

tableName - The name of the table to describe.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object