oracle.kv.util.migrator.DataSinkConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of oracle-nosql-server Show documentation

NoSQL Database Server - supplies build and runtime support for the server (store) side of the Oracle NoSQL Database.

The newest version!

/*-
 * Copyright (C) 2011, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This file was distributed by Oracle as part of a version of Oracle NoSQL
 * Database made available at:
 *
 * http://www.oracle.com/technetwork/database/database-technologies/nosqldb/downloads/index.html
 *
 * Please see the LICENSE file included in the top-level directory of the
 * appropriate version of Oracle NoSQL Database for a copy of the license and
 * additional information.
 */

package oracle.kv.util.migrator;

/**
 * Represents the configuration of writing to data storage.
 */
public interface DataSinkConfig {

    /**
     * Returns the name of the DataSinkConfig in configuration file
     */
    String getName();

    /**
     * Create a JSON representation of the DataSinkConfig.
     *
     * @param pretty set to true for a nicely formatted JSON string, with
     * indentation and carriage returns, otherwise the string will be a single
     * line
     *
     * @return a JSON representation of the DataSinkConfig
     */
    String toJsonString(boolean pretty);
}