org.opensearch.common.blobstore.InputStreamWithMetadata Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opensearch Show documentation

OpenSearch subproject :server

There is a newer version: 2.18.0

/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 */

package org.opensearch.common.blobstore;

import org.opensearch.common.annotation.ExperimentalApi;

import java.io.Closeable;
import java.io.IOException;
import java.io.InputStream;
import java.util.Map;

/**
 * Represents the response from a blob download operation, containing both the
 * input stream of the blob content and the associated metadata.
 *
 * @opensearch.experimental
 */
@ExperimentalApi
public class InputStreamWithMetadata implements Closeable {

    /**
     * Downloaded blob InputStream
     */
    private final InputStream inputStream;

    /**
     * Metadata of the downloaded blob
     */
    private final Map metadata;

    public InputStream getInputStream() {
        return inputStream;
    }

    public Map getMetadata() {
        return metadata;
    }

    public InputStreamWithMetadata(InputStream inputStream, Map metadata) {
        this.inputStream = inputStream;
        this.metadata = metadata;
    }

    @Override
    public void close() throws IOException {
        if (inputStream != null) {
            inputStream.close();
        }
    }
}