Class StorageGrpc.StorageStub (2.1.10)

public static final class StorageGrpc.StorageStub extends AbstractAsyncStub<StorageGrpc.StorageStub>

Manages Google Cloud Storage resources.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractAsyncStub > StorageGrpc.StorageStub

Methods

build(Channel channel, CallOptions callOptions)

protected StorageGrpc.StorageStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
StorageGrpc.StorageStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

queryWriteStatus(QueryWriteStatusRequest request, StreamObserver<QueryWriteStatusResponse> responseObserver)

public void queryWriteStatus(QueryWriteStatusRequest request, StreamObserver<QueryWriteStatusResponse> responseObserver)

Determines the persisted_size for an object that is being written, which can then be used as the write_offset for the next Write() call. If the object does not exist (i.e., the object 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 object. 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 object name, the sequence of returned persisted_size values will be non-decreasing.

Parameters
NameDescription
requestQueryWriteStatusRequest
responseObserverio.grpc.stub.StreamObserver<QueryWriteStatusResponse>

readObject(ReadObjectRequest request, StreamObserver<ReadObjectResponse> responseObserver)

public void readObject(ReadObjectRequest request, StreamObserver<ReadObjectResponse> responseObserver)

Reads an object's data.

Parameters
NameDescription
requestReadObjectRequest
responseObserverio.grpc.stub.StreamObserver<ReadObjectResponse>

startResumableWrite(StartResumableWriteRequest request, StreamObserver<StartResumableWriteResponse> responseObserver)

public void startResumableWrite(StartResumableWriteRequest request, StreamObserver<StartResumableWriteResponse> responseObserver)

Starts a resumable write. How long the write operation remains valid, and what happens when the write operation becomes invalid, are service-dependent.

Parameters
NameDescription
requestStartResumableWriteRequest
responseObserverio.grpc.stub.StreamObserver<StartResumableWriteResponse>

writeObject(StreamObserver<WriteObjectResponse> responseObserver)

public StreamObserver<WriteObjectRequest> writeObject(StreamObserver<WriteObjectResponse> responseObserver)

Stores a new object and metadata. An object can be written either in a single message stream or in a resumable sequence of message streams. To write using a single stream, the client should include in the first message of the stream an WriteObjectSpec describing the destination bucket, object, and any preconditions. Additionally, the final message must set 'finish_write' to true, or else it is an error. For a resumable write, the client should instead call StartResumableWrite() and provide that method an WriteObjectSpec. They should then attach the returned upload_id to the first message of each following call to Create. If there is an error or the connection is broken during the resumable Create(), the client should check the status of the Create() by calling QueryWriteStatus() and continue writing from the returned persisted_size. This may be less than the amount of data the client previously sent. The service will not view the object as complete until the client has sent a WriteObjectRequest with finish_write set to true. Sending any requests on a stream after sending a request with finish_write set to true will cause an error. The client should check the response it receives to determine how much data the service was able to commit and whether the service views the object as complete.

Parameter
NameDescription
responseObserverio.grpc.stub.StreamObserver<WriteObjectResponse>
Returns
TypeDescription
io.grpc.stub.StreamObserver<WriteObjectRequest>