software.amazon.awssdk.enhanced.dynamodb.IndexMetadata 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;

import java.util.Optional;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;

/**
 * A metadata class that stores information about an index
 */
@SdkPublicApi
@ThreadSafe
public interface IndexMetadata {
    /**
     * The name of the index
     */
    String name();

    /**
     * The partition key for the index; if there is one.
     */
    Optional partitionKey();

    /**
     * The sort key for the index; if there is one.
     */
    Optional sortKey();
}