Class Projection
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Projection.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the NonKeyAttributes property.Represents the non-key attribute names which will be projected into the index.final ProjectionType
The set of attributes that are projected into the index:final String
The set of attributes that are projected into the index:static Class
<? extends Projection.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 inKEYS_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 returnProjectionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprojectionTypeAsString()
.- 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 inKEYS_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
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 inKEYS_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 returnProjectionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprojectionTypeAsString()
.- 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 inKEYS_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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<Projection.Builder,
Projection> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-