Class StorageGrpc.StorageStub (2.18.0)

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

API Overview and Naming Syntax

The Cloud Storage 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).

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
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
StorageGrpc.StorageStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

cancelResumableWrite(CancelResumableWriteRequest request, StreamObserver<CancelResumableWriteResponse> responseObserver)

public void cancelResumableWrite(CancelResumableWriteRequest request, StreamObserver<CancelResumableWriteResponse> responseObserver)

Cancels an in-progress resumable upload.

Parameters
Name Description
request CancelResumableWriteRequest
responseObserver io.grpc.stub.StreamObserver<CancelResumableWriteResponse>

composeObject(ComposeObjectRequest request, StreamObserver<Object> responseObserver)

public void composeObject(ComposeObjectRequest request, StreamObserver<Object> responseObserver)

Concatenates a list of existing objects into a new object in the same bucket.

Parameters
Name Description
request ComposeObjectRequest
responseObserver io.grpc.stub.StreamObserver<Object>

createBucket(CreateBucketRequest request, StreamObserver<Bucket> responseObserver)

public void createBucket(CreateBucketRequest request, StreamObserver<Bucket> responseObserver)

Creates a new bucket.

Parameters
Name Description
request CreateBucketRequest
responseObserver io.grpc.stub.StreamObserver<Bucket>

createHmacKey(CreateHmacKeyRequest request, StreamObserver<CreateHmacKeyResponse> responseObserver)

public void createHmacKey(CreateHmacKeyRequest request, StreamObserver<CreateHmacKeyResponse> responseObserver)

Creates a new HMAC key for the given service account.

Parameters
Name Description
request CreateHmacKeyRequest
responseObserver io.grpc.stub.StreamObserver<CreateHmacKeyResponse>

createNotification(CreateNotificationRequest request, StreamObserver<Notification> responseObserver)

public void createNotification(CreateNotificationRequest request, StreamObserver<Notification> responseObserver)

Creates a notification subscription for a given bucket. These notifications, when triggered, publish messages to the specified Pub/Sub topics. See https://cloud.google.com/storage/docs/pubsub-notifications.

Parameters
Name Description
request