Projection (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Projection
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Projection()

Constructors
Constructor and Description
`Projection()`

Method Summary

All Methods Instance Methods Concrete 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`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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.
`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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Projection
```
public Projection()
```
- Method Detail
  - 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 - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
    - ALL - All of the table attributes are projected into the index.
    When using the DynamoDB console, ALL is selected by default.
    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 - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
    
    ALL - All of the table attributes are projected into the index.
    
    When using the DynamoDB console, ALL is selected by default.
    See Also:
    
    ProjectionType
  - 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 - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
    - ALL - All of the table attributes are projected into the index.
    When using the DynamoDB console, ALL is selected by default.
    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 - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
    
    ALL - All of the table attributes are projected into the index.
    
    When using the DynamoDB console, ALL is selected by default.
    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 - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
    - ALL - All of the table attributes are projected into the index.
    When using the DynamoDB console, ALL is selected by default.
    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 - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
    
    ALL - All of the table attributes are projected into the index.
    
    When using the DynamoDB console, ALL is selected by default.
    Returns:
    
    Returns a reference to this 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 - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
    - ALL - All of the table attributes are projected into the index.
    When using the DynamoDB console, ALL is selected by default.
    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 - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
    
    ALL - All of the table attributes are projected into the index.
    
    When using the DynamoDB console, ALL is selected by default.
    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 - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
    - ALL - All of the table attributes are projected into the index.
    When using the DynamoDB console, ALL is selected by default.
    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 - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
    
    ALL - All of the table attributes are projected into the index.
    
    When using the DynamoDB console, ALL is selected by default.
    Returns:
    
    Returns a reference to this 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 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
    
    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 100. 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 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
    
    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 100. 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 100. 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.
    
    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 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
    
    Returns:
    
    Returns a reference to this 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 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
    
    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 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Projection clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class Projection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Projection

Method Detail

setProjectionType

getProjectionType

withProjectionType

setProjectionType

withProjectionType

getNonKeyAttributes

setNonKeyAttributes

withNonKeyAttributes

withNonKeyAttributes

toString

equals

hashCode

clone

marshall