com.google.storage.v2

Class StorageGrpc.StorageFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<StorageGrpc.StorageFutureStub>

com.google.storage.v2.StorageGrpc.StorageFutureStub

Enclosing class:

StorageGrpc

public static final class StorageGrpc.StorageFutureStub
extends AbstractFutureStub<StorageGrpc.StorageFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service Storage.

 ## 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).
 

Nested Class Summary

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

AbstractStub.StubFactory<T extends AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected StorageGrpc.StorageFutureStub	build(Channel channel, CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<CancelResumableWriteResponse>	cancelResumableWrite(CancelResumableWriteRequest request) Cancels an in-progress resumable upload.
com.google.common.util.concurrent.ListenableFuture<Object>	composeObject(ComposeObjectRequest request) Concatenates a list of existing objects into a new object in the same bucket.
com.google.common.util.concurrent.ListenableFuture<Bucket>	createBucket(CreateBucketRequest request) Creates a new bucket.
com.google.common.util.concurrent.ListenableFuture<CreateHmacKeyResponse>	createHmacKey(CreateHmacKeyRequest request) Creates a new HMAC key for the given service account.
com.google.common.util.concurrent.ListenableFuture<NotificationConfig>	createNotificationConfig(CreateNotificationConfigRequest request) Creates a NotificationConfig for a given bucket.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteBucket(DeleteBucketRequest request) Permanently deletes an empty bucket.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteHmacKey(DeleteHmacKeyRequest request) Deletes a given HMAC key.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteNotificationConfig(DeleteNotificationConfigRequest request) Permanently deletes a NotificationConfig.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteObject(DeleteObjectRequest request) Deletes an object and its metadata.
com.google.common.util.concurrent.ListenableFuture<Bucket>	getBucket(GetBucketRequest request) Returns metadata for the specified bucket.
com.google.common.util.concurrent.ListenableFuture<HmacKeyMetadata>	getHmacKey(GetHmacKeyRequest request) Gets an existing HMAC key metadata for the given id.
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy>	getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request) Gets the IAM policy for a specified bucket or object.
com.google.common.util.concurrent.ListenableFuture<NotificationConfig>	getNotificationConfig(GetNotificationConfigRequest request) View a NotificationConfig.
com.google.common.util.concurrent.ListenableFuture<Object>	getObject(GetObjectRequest request) Retrieves an object's metadata.
com.google.common.util.concurrent.ListenableFuture<ServiceAccount>	getServiceAccount(GetServiceAccountRequest request) Retrieves the name of a project's Google Cloud Storage service account.
com.google.common.util.concurrent.ListenableFuture<ListBucketsResponse>	listBuckets(ListBucketsRequest request) Retrieves a list of buckets for a given project.
com.google.common.util.concurrent.ListenableFuture<ListHmacKeysResponse>	listHmacKeys(ListHmacKeysRequest request) Lists HMAC keys under a given project with the additional filters provided.
com.google.common.util.concurrent.ListenableFuture<ListNotificationConfigsResponse>	listNotificationConfigs(ListNotificationConfigsRequest request) Retrieves a list of NotificationConfigs for a given bucket.
com.google.common.util.concurrent.ListenableFuture<ListObjectsResponse>	listObjects(ListObjectsRequest request) Retrieves a list of objects matching the criteria.
com.google.common.util.concurrent.ListenableFuture<Bucket>	lockBucketRetentionPolicy(LockBucketRetentionPolicyRequest request) Locks retention policy on a bucket.
com.google.common.util.concurrent.ListenableFuture<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.
com.google.common.util.concurrent.ListenableFuture<RewriteResponse>	rewriteObject(RewriteObjectRequest request) Rewrites a source object to a destination object.
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy>	setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request) Updates an IAM policy for the specified bucket or object.
com.google.common.util.concurrent.ListenableFuture<StartResumableWriteResponse>	startResumableWrite(StartResumableWriteRequest request) Starts a resumable write.
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request) Tests a set of permissions on the given bucket or object to see which, if any, are held by the caller.
com.google.common.util.concurrent.ListenableFuture<Bucket>	updateBucket(UpdateBucketRequest request) Updates a bucket.
com.google.common.util.concurrent.ListenableFuture<HmacKeyMetadata>	updateHmacKey(UpdateHmacKeyRequest request) Updates a given HMAC key state between ACTIVE and INACTIVE.
com.google.common.util.concurrent.ListenableFuture<Object>	updateObject(UpdateObjectRequest request) Updates an object's metadata.

Methods inherited from class io.grpc.stub.AbstractFutureStub

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.StorageFutureStub build(Channel channel,
                                              CallOptions callOptions)

Specified by:

build in class AbstractStub<StorageGrpc.StorageFutureStub>

deleteBucket

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteBucket(DeleteBucketRequest request)

 Permanently deletes an empty bucket.
 

getBucket

public com.google.common.util.concurrent.ListenableFuture<Bucket> getBucket(GetBucketRequest request)

 Returns metadata for the specified bucket.
 

createBucket

public com.google.common.util.concurrent.ListenableFuture<Bucket> createBucket(CreateBucketRequest request)

 Creates a new bucket.
 

listBuckets

public com.google.common.util.concurrent.ListenableFuture<ListBucketsResponse> listBuckets(ListBucketsRequest request)

 Retrieves a list of buckets for a given project.
 

lockBucketRetentionPolicy

public com.google.common.util.concurrent.ListenableFuture<Bucket> lockBucketRetentionPolicy(LockBucketRetentionPolicyRequest request)

 Locks retention policy on a bucket.
 

getIamPolicy

public com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy> getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)

 Gets the IAM policy for a specified bucket or object.
 The `resource` field in the request should be
 projects/_/buckets/<bucket_name> for a bucket or
 projects/_/buckets/<bucket_name>/objects/<object_name> for an object.
 

setIamPolicy

public com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy> setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)

 Updates an IAM policy for the specified bucket or object.
 The `resource` field in the request should be
 projects/_/buckets/<bucket_name> for a bucket or
 projects/_/buckets/<bucket_name>/objects/<object_name> for an object.
 

testIamPermissions

public com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.TestIamPermissionsResponse> testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)

 Tests a set of permissions on the given bucket or object to see which, if
 any, are held by the caller.
 The `resource` field in the request should be
 projects/_/buckets/<bucket_name> for a bucket or
 projects/_/buckets/<bucket_name>/objects/<object_name> for an object.
 

updateBucket

public com.google.common.util.concurrent.ListenableFuture<Bucket> updateBucket(UpdateBucketRequest request)

 Updates a bucket. Equivalent to JSON API's storage.buckets.patch method.
 

deleteNotificationConfig

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteNotificationConfig(DeleteNotificationConfigRequest request)

 Permanently deletes a NotificationConfig.
 

getNotificationConfig

public com.google.common.util.concurrent.ListenableFuture<NotificationConfig> getNotificationConfig(GetNotificationConfigRequest request)

 View a NotificationConfig.
 

createNotificationConfig

public com.google.common.util.concurrent.ListenableFuture<NotificationConfig> createNotificationConfig(CreateNotificationConfigRequest request)

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

listNotificationConfigs

public com.google.common.util.concurrent.ListenableFuture<ListNotificationConfigsResponse> listNotificationConfigs(ListNotificationConfigsRequest request)

 Retrieves a list of NotificationConfigs for a given bucket.
 

composeObject

public com.google.common.util.concurrent.ListenableFuture<Object> composeObject(ComposeObjectRequest request)

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

deleteObject

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteObject(DeleteObjectRequest request)

 Deletes an object and its metadata.
 Deletions are normally permanent when versioning is disabled or whenever
 the generation parameter is used. However, if soft delete is enabled for
 the bucket, deleted objects can be restored using RestoreObject until the
 soft delete retention period has passed.
 

cancelResumableWrite

public com.google.common.util.concurrent.ListenableFuture<CancelResumableWriteResponse> cancelResumableWrite(CancelResumableWriteRequest request)

 Cancels an in-progress resumable upload.
 Any attempts to write to the resumable upload after cancelling the upload
 will fail.
 The behavior for currently in progress write operations is not guaranteed -
 they could either complete before the cancellation or fail if the
 cancellation completes first.
 

getObject

public com.google.common.util.concurrent.ListenableFuture<Object> getObject(GetObjectRequest request)

 Retrieves an object's metadata.
 

updateObject

public com.google.common.util.concurrent.ListenableFuture<Object> updateObject(UpdateObjectRequest request)

 Updates an object's metadata.
 Equivalent to JSON API's storage.objects.patch.
 

listObjects

public com.google.common.util.concurrent.ListenableFuture<ListObjectsResponse> listObjects(ListObjectsRequest request)

 Retrieves a list of objects matching the criteria.
 

rewriteObject

public com.google.common.util.concurrent.ListenableFuture<RewriteResponse> rewriteObject(RewriteObjectRequest request)

 Rewrites a source object to a destination object. Optionally overrides
 metadata.
 

startResumableWrite

public com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<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.
 

getServiceAccount

public com.google.common.util.concurrent.ListenableFuture<ServiceAccount> getServiceAccount(GetServiceAccountRequest request)

 Retrieves the name of a project's Google Cloud Storage service account.
 

createHmacKey

public com.google.common.util.concurrent.ListenableFuture<CreateHmacKeyResponse> createHmacKey(CreateHmacKeyRequest request)

 Creates a new HMAC key for the given service account.
 

deleteHmacKey

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteHmacKey(DeleteHmacKeyRequest request)

 Deletes a given HMAC key.  Key must be in an INACTIVE state.
 

getHmacKey

public com.google.common.util.concurrent.ListenableFuture<HmacKeyMetadata> getHmacKey(GetHmacKeyRequest request)

 Gets an existing HMAC key metadata for the given id.
 

listHmacKeys

public com.google.common.util.concurrent.ListenableFuture<ListHmacKeysResponse> listHmacKeys(ListHmacKeysRequest request)

 Lists HMAC keys under a given project with the additional filters provided.
 

updateHmacKey

public com.google.common.util.concurrent.ListenableFuture<HmacKeyMetadata> updateHmacKey(UpdateHmacKeyRequest request)

 Updates a given HMAC key state between ACTIVE and INACTIVE.