com.google.storage.v2

Class StorageGrpc.StorageBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<StorageGrpc.StorageBlockingStub>

com.google.storage.v2.StorageGrpc.StorageBlockingStub

Enclosing class:

StorageGrpc

public static final class StorageGrpc.StorageBlockingStub
extends io.grpc.stub.AbstractBlockingStub<StorageGrpc.StorageBlockingStub>

 ## API Overview and Naming Syntax
 The GCS gRPC API allows applications to read and write data through the
 abstractions of buckets and objects. For a description of these abstractions
 please see https://cloud.google.com/storage/docs.
 Resources are named as follows:
   - Projects are referred to as they are defined by the Resource Manager API,
     using strings like `projects/123456` or `projects/my-string-id`.
   - Buckets are named using string names of the form:
     `projects/{project}/buckets/{bucket}`
     For globally unique buckets, `_` may be substituted for the project.
   - Objects are uniquely identified by their name along with the name of the
     bucket they belong to, as separate strings in this API. For example:
       ReadObjectRequest {
         bucket: 'projects/_/buckets/my-bucket'
         object: 'my-object'
       }
     Note that object names can contain `/` characters, which are treated as
     any other character (no special directory semantics).
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected StorageGrpc.StorageBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
QueryWriteStatusResponse	queryWriteStatus(QueryWriteStatusRequest request) 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.
Iterator<ReadObjectResponse>	readObject(ReadObjectRequest request) Reads an object's data.
StartResumableWriteResponse	startResumableWrite(StartResumableWriteRequest request) Starts a resumable write.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Method Detail

build

protected StorageGrpc.StorageBlockingStub build(io.grpc.Channel channel,
                                                io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<StorageGrpc.StorageBlockingStub>

readObject

public Iterator<ReadObjectResponse> readObject(ReadObjectRequest request)

 Reads an object's data.
 

startResumableWrite

public StartResumableWriteResponse startResumableWrite(StartResumableWriteRequest request)

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

queryWriteStatus

public QueryWriteStatusResponse queryWriteStatus(QueryWriteStatusRequest request)

 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.