Package software.amazon.awssdk.services.dynamodb.document.spec

Class AbstractSpecWithPrimaryKey<T extends AmazonWebServiceRequest>

java.lang.Object

software.amazon.awssdk.services.dynamodb.document.spec.AbstractSpecWithPrimaryKey<T>

Direct Known Subclasses:

DeleteItemSpec, GetItemSpec, UpdateItemSpec

public class AbstractSpecWithPrimaryKey<T extends AmazonWebServiceRequest>
extends Object

Common base class for parameter specification that involves a primary key.

Method Summary

Modifier and Type	Method	Description
Collection<KeyAttribute>	getKeyComponents()	Returns the primary key components that has been specified.
ProgressListener	getProgressListener()
T	getRequest()	Internal method.
RequestMetricCollector	getRequestMetricCollector()
void	setProgressListener(ProgressListener progressListener)
void	setRequest(T req)
void	setRequestMetricCollector(RequestMetricCollector requestMetricCollector)
AbstractSpecWithPrimaryKey<T>	withPrimaryKey(String hashKeyName, Object hashKeyValue)	Sets the primary key with the specified hash-only key name and value.
AbstractSpecWithPrimaryKey<T>	withPrimaryKey(String hashKeyName, Object hashKeyValue, String rangeKeyName, Object rangeKeyValue)	Sets the primary key with the specified hash key and range key.
AbstractSpecWithPrimaryKey<T>	withPrimaryKey(KeyAttribute... components)	Sets the primary key with the specified key components.
AbstractSpecWithPrimaryKey<T>	withPrimaryKey(PrimaryKey primaryKey)	Sets the primary key.
software.amazon.awssdk.services.dynamodb.document.spec.AbstractSpec<T>	withProgressListener(ProgressListener progressListener)
software.amazon.awssdk.services.dynamodb.document.spec.AbstractSpec<T>	withRequestMetricCollector(RequestMetricCollector requestMetricCollector)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getKeyComponents

public final Collection<KeyAttribute> getKeyComponents()

Returns the primary key components that has been specified.

withPrimaryKey

public AbstractSpecWithPrimaryKey<T> withPrimaryKey(KeyAttribute... components)

Sets the primary key with the specified key components.

withPrimaryKey

public AbstractSpecWithPrimaryKey<T> withPrimaryKey(PrimaryKey primaryKey)

Sets the primary key.

withPrimaryKey

public AbstractSpecWithPrimaryKey<T> withPrimaryKey(String hashKeyName,
                                                    Object hashKeyValue)

Sets the primary key with the specified hash-only key name and value.

withPrimaryKey

public AbstractSpecWithPrimaryKey<T> withPrimaryKey(String hashKeyName,
                                                    Object hashKeyValue,
                                                    String rangeKeyName,
                                                    Object rangeKeyValue)

Sets the primary key with the specified hash key and range key.

setRequest

public void setRequest(T req)

getRequest

public T getRequest()

Internal method. Not meant to be called directly. May change without notice.

getProgressListener

public ProgressListener getProgressListener()

setProgressListener

public void setProgressListener(ProgressListener progressListener)

getRequestMetricCollector

public RequestMetricCollector getRequestMetricCollector()

setRequestMetricCollector

public void setRequestMetricCollector(RequestMetricCollector requestMetricCollector)

withProgressListener

public software.amazon.awssdk.services.dynamodb.document.spec.AbstractSpec<T> withProgressListener(ProgressListener progressListener)

withRequestMetricCollector

public software.amazon.awssdk.services.dynamodb.document.spec.AbstractSpec<T> withRequestMetricCollector(RequestMetricCollector requestMetricCollector)