com.marklogic.flux.api.GenericFilesExporter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flux-api Show documentation

Flux API for data movement with MarkLogic

There is a newer version: 1.1.3

/*
 * Copyright © 2024 MarkLogic Corporation. All Rights Reserved.
 */
package com.marklogic.flux.api;

import java.util.function.Consumer;

/**
 * Read documents from MarkLogic and write them to a local filesystem, HDFS, or S3.
 */
public interface GenericFilesExporter extends Executor {

    interface WriteGenericFilesOptions {
        WriteGenericFilesOptions path(String path);

        WriteGenericFilesOptions compressionType(CompressionType compressionType);

        WriteGenericFilesOptions prettyPrint(boolean value);

        WriteGenericFilesOptions encoding(String encoding);

        WriteGenericFilesOptions zipFileCount(int zipFileCount);

        WriteGenericFilesOptions s3AddCredentials();

        WriteGenericFilesOptions s3AccessKeyId(String accessKeyId);

        WriteGenericFilesOptions s3SecretAccessKey(String secretAccessKey);

        WriteGenericFilesOptions s3Endpoint(String endpoint);
    }

    GenericFilesExporter from(Consumer> consumer);

    /**
     * @since 1.1.0
     */
    GenericFilesExporter streaming();

    GenericFilesExporter to(Consumer consumer);

    GenericFilesExporter to(String path);
}