Package com.google.bytestream

Class ByteStreamGrpc.ByteStreamBlockingStub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractBlockingStub<ByteStreamGrpc.ByteStreamBlockingStub>
com.google.bytestream.ByteStreamGrpc.ByteStreamBlockingStub
Enclosing class:
ByteStreamGrpc
public static final class ByteStreamGrpc.ByteStreamBlockingStub extends io.grpc.stub.AbstractBlockingStub<ByteStreamGrpc.ByteStreamBlockingStub>
A stub to allow clients to do synchronous rpc calls to service ByteStream. 
 #### Introduction
 The Byte Stream API enables a client to read and write a stream of bytes to
 and from a resource. Resources have names, and these names are supplied in
 the API calls below to identify the resource that is being read from or
 written to.
 All implementations of the Byte Stream API export the interface defined here:
 * `Read()`: Reads the contents of a resource.
 * `Write()`: Writes the contents of a resource. The client can call `Write()`
   multiple times with the same resource and can check the status of the write
   by calling `QueryWriteStatus()`.
 #### Service parameters and metadata
 The ByteStream API provides no direct way to access/modify any metadata
 associated with the resource.
 #### Errors
 The errors returned by the service are in the Google canonical error space.

  • Method Details

    • build

      protected ByteStreamGrpc.ByteStreamBlockingStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<ByteStreamGrpc.ByteStreamBlockingStub>

    • read

      public Iterator<ByteStreamProto.ReadResponse> read(ByteStreamProto.ReadRequest request)
       `Read()` is used to retrieve the contents of a resource as a sequence
 of bytes. The bytes are returned in a sequence of responses, and the
 responses are delivered as the results of a server-side streaming RPC.

    • queryWriteStatus

      public ByteStreamProto.QueryWriteStatusResponse queryWriteStatus(ByteStreamProto.QueryWriteStatusRequest request)
       `QueryWriteStatus()` is used to find the `committed_size` for a resource
 that is being written, which can then be used as the `write_offset` for
 the next `Write()` call.
 If the resource does not exist (i.e., the resource has been deleted, or the
 first `Write()` has not yet reached the service), this method returns the
 error `NOT_FOUND`.
 The client **may** call `QueryWriteStatus()` at any time to determine how
 much data has been processed for this resource. This is useful if the
 client is buffering data and needs to know which data can be safely
 evicted. For any sequence of `QueryWriteStatus()` calls for a given
 resource name, the sequence of returned `committed_size` values will be
 non-decreasing.