alluxio.underfs.gcs.v2

Class GCSV2OutputStream

java.lang.Object

java.io.OutputStream

alluxio.underfs.gcs.v2.GCSV2OutputStream

All Implemented Interfaces:

ContentHashable, Closeable, Flushable, AutoCloseable

@NotThreadSafe
public final class GCSV2OutputStream
extends OutputStream
implements ContentHashable

A stream for writing a file into GCS using Google cloud API (GCS output stream version 2). The data is streaming writing to GCS without waiting for the complete file to arrive in Alluxio worker.

Constructor Summary

Constructors

Constructor and Description
GCSV2OutputStream(String bucketName, String key, com.google.cloud.storage.Storage client) Constructs a new stream for writing a file.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
Optional<String>	getContentHash()
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GCSV2OutputStream

public GCSV2OutputStream(String bucketName,
                         String key,
                         com.google.cloud.storage.Storage client)

Constructs a new stream for writing a file.

Parameters:

bucketName - the name of the bucket

key - the key of the file

client - the Google cloud storage client

Method Detail

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

getContentHash

public Optional<String> getContentHash()

Specified by:

getContentHash in interface ContentHashable

Returns:

the content hash of the file written to the UFS if available after the stream has been closed