Package software.amazon.awssdk.services.dynamodb.model

Class Projection

java.lang.Object

software.amazon.awssdk.services.dynamodb.model.Projection

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Projection.Builder,Projection>

@Generated("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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Projection.Builder

Method Summary

Modifier and Type	Method	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()	For responses, this returns true if the service returned a value for the NonKeyAttributes property.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

projectionType

public final 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.

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().

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.

See Also:

ProjectionType

projectionTypeAsString

public final 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 - 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.

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().

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.

See Also:

ProjectionType

hasNonKeyAttributes

public final boolean hasNonKeyAttributes()

For responses, this returns true if the service returned a value for the NonKeyAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

nonKeyAttributes

public final 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 100. 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNonKeyAttributes() method.

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.

toBuilder

public Projection.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Projection.Builder,Projection>

builder

public static Projection.Builder builder()

serializableBuilderClass

public static Class<? extends Projection.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo