com.mongodb.client.model.DropCollectionOptions 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.client.model;

import com.mongodb.AutoEncryptionSettings;
import com.mongodb.annotations.Beta;
import com.mongodb.lang.Nullable;
import org.bson.conversions.Bson;

/**
 * Options for dropping a collection
 *
 * @mongodb.driver.manual reference/command/drop/ Drop Collection
 * @mongodb.driver.manual core/security-client-side-encryption/ In-use encryption
 * @since 4.7
 */
public class DropCollectionOptions {
    private Bson encryptedFields;

    /**
     * Gets any explicitly set encrypted fields.
     *
     * Note: If not set the driver will lookup the namespace in {@link AutoEncryptionSettings#getEncryptedFieldsMap()}
     * @return the encrypted fields document
     * @since 4.7
     * @mongodb.server.release 7.0
     */
    @Beta(Beta.Reason.SERVER)
    @Nullable
    public Bson getEncryptedFields() {
        return encryptedFields;
    }

    /**
     * Sets the encrypted fields document
     *
     * Explicitly set encrypted fields.
     * Note: If not set the driver will lookup the namespace in {@link AutoEncryptionSettings#getEncryptedFieldsMap()}
     * @param encryptedFields the encrypted fields document
     * @return this
     * @since 4.7
     * @mongodb.server.release 7.0
     * @mongodb.driver.manual core/security-client-side-encryption/ In-use encryption
     */
    @Beta(Beta.Reason.SERVER)
    public DropCollectionOptions encryptedFields(@Nullable final Bson encryptedFields) {
        this.encryptedFields = encryptedFields;
        return this;
    }

    @Override
    public String toString() {
        return "DropCollectionOptions{"
                + ", encryptedFields=" + encryptedFields
                + '}';
    }
}