com.amazonaws.services.dynamodbv2.model

Class Projection

java.lang.Object

com.amazonaws.services.dynamodbv2.model.Projection

All Implemented Interfaces:

Serializable, Cloneable

public class Projection
extends Object
implements Serializable, Cloneable

Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Projection()

Method Summary

Methods

Modifier and Type	Method and Description
Projection	clone()
boolean	equals(Object obj)
List<String>	getNonKeyAttributes() Represents the non-key attribute names which will be projected into the index.
String	getProjectionType() The set of attributes that are projected into the index:
int	hashCode()
void	setNonKeyAttributes(Collection<String> nonKeyAttributes) Represents the non-key attribute names which will be projected into the index.
void	setProjectionType(ProjectionType projectionType) The set of attributes that are projected into the index:
void	setProjectionType(String projectionType) The set of attributes that are projected into the index:
String	toString() Returns a string representation of this object; useful for testing and debugging.
Projection	withNonKeyAttributes(Collection<String> nonKeyAttributes) Represents the non-key attribute names which will be projected into the index.
Projection	withNonKeyAttributes(String... nonKeyAttributes) Represents the non-key attribute names which will be projected into the index.
Projection	withProjectionType(ProjectionType projectionType) The set of attributes that are projected into the index:
Projection	withProjectionType(String projectionType) The set of attributes that are projected into the index:

Methods inherited from class java.lang.Object

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

Constructor Detail

Projection

public Projection()

Method Detail

getProjectionType

public String getProjectionType()

The set of attributes that are projected into the index:

• KEYS_ONLY - Only the index and primary keys are projected into the index.

• INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

• ALL - All of the table attributes are projected into the index.

Constraints:
Allowed Values: ALL, KEYS_ONLY, INCLUDE

Returns:

The set of attributes that are projected into the index:

• KEYS_ONLY - Only the index and primary keys are projected into the index.

• INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

• ALL - All of the table attributes are projected into the index.

See Also:

ProjectionType

setProjectionType

public void setProjectionType(String projectionType)

The set of attributes that are projected into the index:

• KEYS_ONLY - Only the index and primary keys are projected into the index.

• INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

• ALL - All of the table attributes are projected into the index.

Constraints:
Allowed Values: ALL, KEYS_ONLY, INCLUDE

Parameters:

projectionType - The set of attributes that are projected into the index:

• KEYS_ONLY - Only the index and primary keys are projected into the index.

• INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

• ALL - All of the table attributes are projected into the index.

See Also:

ProjectionType

withProjectionType

public Projection withProjectionType(String projectionType)

The set of attributes that are projected into the index:

• KEYS_ONLY - Only the index and primary keys are projected into the index.

• INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

• ALL - All of the table attributes are projected into the index.

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

Constraints:
Allowed Values: ALL, KEYS_ONLY, INCLUDE

Parameters:

projectionType - The set of attributes that are projected into the index:

• KEYS_ONLY - Only the index and primary keys are projected into the index.

• INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

• ALL - All of the table attributes are projected into the index.

Returns:

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

See Also:

ProjectionType

setProjectionType

public void setProjectionType(ProjectionType projectionType)

The set of attributes that are projected into the index:

• KEYS_ONLY - Only the index and primary keys are projected into the index.

• INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

• ALL - All of the table attributes are projected into the index.

Constraints:
Allowed Values: ALL, KEYS_ONLY, INCLUDE

Parameters:

projectionType - The set of attributes that are projected into the index:

• KEYS_ONLY - Only the index and primary keys are projected into the index.

• INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

• ALL - All of the table attributes are projected into the index.

See Also:

ProjectionType

withProjectionType

public Projection withProjectionType(ProjectionType projectionType)

The set of attributes that are projected into the index:

• KEYS_ONLY - Only the index and primary keys are projected into the index.

• INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

• ALL - All of the table attributes are projected into the index.

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

Constraints:
Allowed Values: ALL, KEYS_ONLY, INCLUDE

Parameters:

projectionType - The set of attributes that are projected into the index:

• KEYS_ONLY - Only the index and primary keys are projected into the index.

• INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

• ALL - All of the table attributes are projected into the index.

Returns:

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

See Also:

ProjectionType

getNonKeyAttributes

public List<String> getNonKeyAttributes()

Represents the non-key attribute names which will be projected into the index.

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

Constraints:
Length: 1 - 20

Returns:

Represents the non-key attribute names which will be projected into the index.

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

setNonKeyAttributes

public void setNonKeyAttributes(Collection<String> nonKeyAttributes)

Represents the non-key attribute names which will be projected into the index.

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

Constraints:
Length: 1 - 20

Parameters:

nonKeyAttributes - Represents the non-key attribute names which will be projected into the index.

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

withNonKeyAttributes

public Projection withNonKeyAttributes(String... nonKeyAttributes)

Represents the non-key attribute names which will be projected into the index.

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

NOTE: This method appends the values to the existing list (if any). Use setNonKeyAttributes(java.util.Collection) or withNonKeyAttributes(java.util.Collection) if you want to override the existing values.

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

Constraints:
Length: 1 - 20

Parameters:

nonKeyAttributes - Represents the non-key attribute names which will be projected into the index.

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

Returns:

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

withNonKeyAttributes

public Projection withNonKeyAttributes(Collection<String> nonKeyAttributes)

Represents the non-key attribute names which will be projected into the index.

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

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

Constraints:
Length: 1 - 20

Parameters:

nonKeyAttributes - Represents the non-key attribute names which will be projected into the index.

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

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

clone

public Projection clone()

Overrides:

clone in class Object