com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBRangeKey Maven / Gradle / Ivy
/*
* Copyright 2011-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://aws.amazon.com/apache2.0
*
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
* OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and
* limitations under the License.
*/
package com.amazonaws.services.dynamodbv2.datamodeling;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotation for marking a property in a class as the range key for a DynamoDB
* table. Applied to the getter method or the class field for the range key
* property. If the annotation is applied directly to the class field, the
* corresponding getter and setter must be declared in the same class.
*
* This annotation is required for tables that use a range key.
*/
@DynamoDB
@DynamoDBKeyed(com.amazonaws.services.dynamodbv2.model.KeyType.RANGE)
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.METHOD})
public @interface DynamoDBRangeKey {
/**
* Optional parameter when the name of the attribute as stored in DynamoDB
* should differ from the name used by the getter / setter.
*/
String attributeName() default "";
}