@Generated(value="software.amazon.awssdk:codegen") public final class Projection extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Projection.Builder,Projection>
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.
Modifier and Type | Class and Description |
---|---|
static interface |
Projection.Builder |
Modifier and Type | Method and Description |
---|---|
static Projection.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasNonKeyAttributes()
Returns true if the NonKeyAttributes property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
List<String> |
nonKeyAttributes()
Represents the non-key attribute names which will be projected into the index.
|
ProjectionType |
projectionType()
The set of attributes that are projected into the index:
|
String |
projectionTypeAsString()
The set of attributes that are projected into the index:
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends Projection.Builder> |
serializableBuilderClass() |
Projection.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public 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 is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
If the service returns an enum value that is not available in the current SDK version, projectionType
will return ProjectionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from projectionTypeAsString()
.
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 is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
ProjectionType
public String projectionTypeAsString()
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 is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
If the service returns an enum value that is not available in the current SDK version, projectionType
will return ProjectionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from projectionTypeAsString()
.
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 is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
ProjectionType
public boolean hasNonKeyAttributes()
public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasNonKeyAttributes()
to see if a value was sent in this field.
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.
public Projection.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<Projection.Builder,Projection>
public static Projection.Builder builder()
public static Class<? extends Projection.Builder> serializableBuilderClass()
public boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public String toString()
Copyright © 2020. All rights reserved.