com.marklogic.flux.api.ArchiveFilesExporter 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 and their metadata from MarkLogic and write them to ZIP files on a local filesystem, HDFS, or S3.
 */
public interface ArchiveFilesExporter extends Executor {

    interface ReadArchiveDocumentOptions extends ReadDocumentsOptions {
        ReadArchiveDocumentOptions categories(String... categories);
    }

    interface WriteArchiveFilesOptions extends WriteFilesOptions {
        WriteArchiveFilesOptions encoding(String encoding);
    }

    ArchiveFilesExporter from(Consumer consumer);

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

    ArchiveFilesExporter to(Consumer consumer);

    ArchiveFilesExporter to(String path);
}