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:

  • Method Details

    • 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.

      When using the DynamoDB console, ALL is selected by default.

      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.

      When using the DynamoDB console, ALL is selected by default.

      See Also:

    • 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.

      When using the DynamoDB console, ALL is selected by default.

      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.

      When using the DynamoDB console, ALL is selected by default.

      See Also:

    • 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 global and local secondary indexes, the total count of NonKeyAttributes summed across all of the 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.

      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 global and local secondary indexes, the total count of NonKeyAttributes summed across all of the 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.

    • toBuilder

      public Projection.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Projection.Builder,Projection>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.