software.amazon.awssdk.enhanced.dynamodb.mapper.annotations.DynamoDbPartitionKey Maven / Gradle / Ivy

Go to download
/*
 * Copyright 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.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. 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 software.amazon.awssdk.enhanced.dynamodb.mapper.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.enhanced.dynamodb.internal.mapper.BeanTableSchemaAttributeTags;

/**
 * Denotes this attribute as being the primary partition key of the DynamoDb table. This attribute must map to a
 * DynamoDb scalar type (string, number or binary) to be valid. Every mapped table schema must have exactly one of these.
 *
 * 
 * Example using {@link DynamoDbPartitionKey}:
 * 
 * {@code
 * @DynamoDbBean
 * public class Customer {
 *     private String id;
 *     private Instant createdOn;
 *
 *     @DynamoDbPartitionKey
 *     public String getId() {
 *          return this.id;
 *     }
 *
 *     public void setId(String id) {
 *          this.name = id;
 *     }
 *
 *     public Instant getCreatedOn() {
 *          return this.createdOn;
 *     }
 *     public void setCreatedOn(Instant createdOn) {
 *          this.createdOn = createdOn;
 *      }
 * }
 * }
 * 
 */
@SdkPublicApi
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@BeanTableSchemaAttributeTag(BeanTableSchemaAttributeTags.class)
public @interface DynamoDbPartitionKey {
}