Package alluxio.underfs.gcs.v2

Class GCSV2OutputStream

  • All Implemented Interfaces:
    alluxio.underfs.ContentHashable, java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
    @NotThreadSafe
public final class GCSV2OutputStream
extends java.io.OutputStream
implements alluxio.underfs.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 Description
      GCSV2OutputStream​(java.lang.String bucketName, java.lang.String key, com.google.cloud.storage.Storage client)
      Constructs a new stream for writing a file.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()  
      void flush()  
      java.util.Optional<java.lang.String> getContentHash()  
      void write​(byte[] b)  
      void write​(byte[] b, int off, int len)  
      void write​(int b)  

      • Methods inherited from class java.io.OutputStream

        nullOutputStream

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • GCSV2OutputStream

        public GCSV2OutputStream​(java.lang.String bucketName,
                         java.lang.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 java.io.IOException
        Specified by:
        write in class java.io.OutputStream
        Throws:
        java.io.IOException

      • write

        public void write​(byte[] b)
           throws java.io.IOException
        Overrides:
        write in class java.io.OutputStream
        Throws:
        java.io.IOException

      • write

        public void write​(byte[] b,
                  int off,
                  int len)
           throws java.io.IOException
        Overrides:
        write in class java.io.OutputStream
        Throws:
        java.io.IOException

      • flush

        public void flush()
           throws java.io.IOException
        Specified by:
        flush in interface java.io.Flushable
        Overrides:
        flush in class java.io.OutputStream
        Throws:
        java.io.IOException

      • close

        public void close()
           throws java.io.IOException
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Overrides:
        close in class java.io.OutputStream
        Throws:
        java.io.IOException

      • getContentHash

        public java.util.Optional<java.lang.String> getContentHash()
        Specified by:
        getContentHash in interface alluxio.underfs.ContentHashable