Projection (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.dynamodbv2.model.Projection

All Implemented Interfaces:

Serializable
```
public class Projection
extends Object
implements Serializable
```
Represents attributes that are copied (projected) from the table into the 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()

Constructors
Constructor and Description
`Projection()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`List<String>`	`getNonKeyAttributes()` Represents the non-key attribute names which will be projected into the index.
`String`	`getProjectionType()` Represents 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)` Represents the set of attributes that are projected into the index:
`void`	`setProjectionType(String projectionType)` Represents 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)` Represents the set of attributes that are projected into the index:
`Projection`	`withProjectionType(String projectionType)` Represents the set of attributes that are projected into the index:

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Projection
```
public Projection()
```
- Method Detail
  - getProjectionType
```
public String getProjectionType()
```
    Represents 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:
    Represents 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)
```
    Represents 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 - Represents 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)
```
    Represents 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 - Represents 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)
```
    Represents 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 - Represents 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)
```
    Represents 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 - Represents 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.
    The total count of attributes specified in 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.
    The total count of attributes specified in 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.
    The total count of attributes specified in 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.
    The total count of attributes specified in 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.
    The total count of attributes specified in 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.
    The total count of attributes specified in 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.
    The total count of attributes specified in 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.
    The total count of attributes specified in 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

Did this page help you?

Class Projection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Projection

Method Detail

getProjectionType

setProjectionType

withProjectionType

setProjectionType

withProjectionType

getNonKeyAttributes

setNonKeyAttributes

withNonKeyAttributes

withNonKeyAttributes

toString

hashCode

equals