com.mongodb.internal.operation.SearchIndexRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mongodb-driver-core Show documentation

The Java operations layer for the MongoDB Java Driver. Third parties can wrap this layer to provide custom higher-level APIs

There is a newer version: 5.3.0-beta0

Show newest version

/*
 * Copyright 2008-present MongoDB, Inc.
 *
 * 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://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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.mongodb.internal.operation;

import com.mongodb.lang.Nullable;
import org.bson.BsonDocument;

import static com.mongodb.assertions.Assertions.assertNotNull;

/**
 * A request for creating or updating an Atlas Search index.
 *
 * Additional options may be introduced as Atlas evolves.
 * To maintain a clear API, it can be split into separate classes, e.g., {@code SearchIndexCreateRequest}
 * and {@code SearchIndexUpdateRequest}, for handling each operation separately in the future.
 *
 * This class is not part of the public API and may be removed or changed at any time
 */
final class SearchIndexRequest {
    private final BsonDocument definition;
    @Nullable
    private final String indexName;

    SearchIndexRequest(final BsonDocument definition, @Nullable final String indexName) {
        assertNotNull(definition);
        this.definition = definition;
        this.indexName = indexName;
    }

    public BsonDocument getDefinition() {
        return definition;
    }

    @Nullable
    public String getIndexName() {
        return indexName;
    }
}