Class StorageGrpc.StorageBlockingStub (2.27.1)

public static final class StorageGrpc.StorageBlockingStub extends AbstractBlockingStub<StorageGrpc.StorageBlockingStub>

A stub to allow clients to do synchronous 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).

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > StorageGrpc.StorageBlockingStub

Inherited Members

io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build(Channel channel, CallOptions callOptions)

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

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`StorageGrpc.StorageBlockingStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

cancelResumableWrite(CancelResumableWriteRequest request)

public 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.

Parameter
Name	Description
`request`	`CancelResumableWriteRequest`

Returns
Type	Description
`CancelResumableWriteResponse`

composeObject(ComposeObjectRequest request)

public Object composeObject(ComposeObjectRequest request)

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

Parameter
Name	Description
`request`	`ComposeObjectRequest`

Returns
Type	Description
`Object`

createBucket(CreateBucketRequest request)

public Bucket createBucket(CreateBucketRequest request)

Creates a new bucket.

Parameter
Name	Description
`request`	`CreateBucketRequest`

Returns
Type	Description
`Bucket`

createHmacKey(CreateHmacKeyRequest request)

public CreateHmacKeyResponse createHmacKey(CreateHmacKeyRequest request)

Creates a new HMAC key for the given service account.

Parameter
Name	Description
`request`	`CreateHmacKeyRequest`

Returns
Type	Description
`CreateHmacKeyResponse`

createNotificationConfig(CreateNotificationConfigRequest request)

public 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.

Parameter
Name	Description
`request`	`CreateNotificationConfigRequest`

Returns
Type	Description
`NotificationConfig`

deleteBucket(DeleteBucketRequest request)

public Empty deleteBucket(DeleteBucketRequest request)

Permanently deletes an empty bucket.

Parameter
Name	Description
`request`	`DeleteBucketRequest`

Returns
Type	Description
`Empty`

deleteHmacKey(DeleteHmacKeyRequest request)

public Empty deleteHmacKey(DeleteHmacKeyRequest request)

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

Parameter
Name	Description
`request`	`DeleteHmacKeyRequest`

Returns
Type	Description
`Empty`

deleteNotificationConfig(DeleteNotificationConfigRequest request)

public Empty deleteNotificationConfig(DeleteNotificationConfigRequest request)

Permanently deletes a NotificationConfig.

Parameter
Name	Description
`request`	`DeleteNotificationConfigRequest`

Returns
Type	Description
`Empty`

deleteObject(DeleteObjectRequest request)

public 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.

Parameter
Name	Description
`request`	`DeleteObjectRequest`

Returns
Type	Description
`Empty`

getBucket(GetBucketRequest request)

public Bucket getBucket(GetBucketRequest request)

Returns metadata for the specified bucket.

Parameter
Name	Description
`request`	`GetBucketRequest`

Returns
Type	Description
`Bucket`

getHmacKey(GetHmacKeyRequest request)

public HmacKeyMetadata getHmacKey(GetHmacKeyRequest request)

Gets an existing HMAC key metadata for the given id.

Parameter
Name	Description
`request`	`GetHmacKeyRequest`

Returns
Type	Description
`HmacKeyMetadata`

getIamPolicy(GetIamPolicyRequest request)

public Policy getIamPolicy(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.

Parameter
Name	Description
`request`	`com.google.iam.v1.GetIamPolicyRequest`

Returns
Type	Description
`com.google.iam.v1.Policy`

getNotificationConfig(GetNotificationConfigRequest request)

public NotificationConfig getNotificationConfig(GetNotificationConfigRequest request)

View a NotificationConfig.

Parameter
Name	Description
`request`	`GetNotificationConfigRequest`

Returns
Type	Description
`NotificationConfig`

getObject(GetObjectRequest request)

public Object getObject(GetObjectRequest request)

Retrieves an object's metadata.

Parameter
Name	Description
`request`	`GetObjectRequest`

Returns
Type	Description
`Object`

getServiceAccount(GetServiceAccountRequest request)

public ServiceAccount getServiceAccount(GetServiceAccountRequest request)

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

Parameter
Name	Description
`request`	`GetServiceAccountRequest`

Returns
Type	Description
`ServiceAccount`

listBuckets(ListBucketsRequest request)

public ListBucketsResponse listBuckets(ListBucketsRequest request)

Retrieves a list of buckets for a given project.

Parameter
Name	Description
`request`	`ListBucketsRequest`

Returns
Type	Description
`ListBucketsResponse`

listHmacKeys(ListHmacKeysRequest request)

public ListHmacKeysResponse listHmacKeys(ListHmacKeysRequest request)

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

Parameter
Name	Description
`request`	`ListHmacKeysRequest`

Returns
Type	Description
`ListHmacKeysResponse`

listNotificationConfigs(ListNotificationConfigsRequest request)

public ListNotificationConfigsResponse listNotificationConfigs(ListNotificationConfigsRequest request)

Retrieves a list of NotificationConfigs for a given bucket.

Parameter
Name	Description
`request`	`ListNotificationConfigsRequest`

Returns
Type	Description
`ListNotificationConfigsResponse`

listObjects(ListObjectsRequest request)

public ListObjectsResponse listObjects(ListObjectsRequest request)

Retrieves a list of objects matching the criteria.

Parameter
Name	Description
`request`	`ListObjectsRequest`

Returns
Type	Description
`ListObjectsResponse`

lockBucketRetentionPolicy(LockBucketRetentionPolicyRequest request)

public Bucket lockBucketRetentionPolicy(LockBucketRetentionPolicyRequest request)

Locks retention policy on a bucket.

Parameter
Name	Description
`request`	`LockBucketRetentionPolicyRequest`

Returns
Type	Description
`Bucket`

queryWriteStatus(QueryWriteStatusRequest request)

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.

Parameter
Name	Description
`request`	`QueryWriteStatusRequest`

Returns
Type	Description
`QueryWriteStatusResponse`

readObject(ReadObjectRequest request)

public Iterator<ReadObjectResponse> readObject(ReadObjectRequest request)

Reads an object's data.

Parameter
Name	Description
`request`	`ReadObjectRequest`

Returns
Type	Description
`Iterator<ReadObjectResponse>`

rewriteObject(RewriteObjectRequest request)

public RewriteResponse rewriteObject(RewriteObjectRequest request)

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

Parameter
Name	Description
`request`	`RewriteObjectRequest`

Returns
Type	Description
`RewriteResponse`

setIamPolicy(SetIamPolicyRequest request)

public Policy setIamPolicy(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.

Parameter
Name	Description
`request`	`com.google.iam.v1.SetIamPolicyRequest`

Returns
Type	Description
`com.google.iam.v1.Policy`

startResumableWrite(StartResumableWriteRequest request)

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.

Parameter
Name	Description
`request`	`StartResumableWriteRequest`

Returns
Type	Description
`StartResumableWriteResponse`

testIamPermissions(TestIamPermissionsRequest request)

public TestIamPermissionsResponse testIamPermissions(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.

Parameter
Name	Description
`request`	`com.google.iam.v1.TestIamPermissionsRequest`

Returns
Type	Description
`com.google.iam.v1.TestIamPermissionsResponse`

updateBucket(UpdateBucketRequest request)

public Bucket updateBucket(UpdateBucketRequest request)

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

Parameter
Name	Description
`request`	`UpdateBucketRequest`

Returns
Type	Description
`Bucket`

updateHmacKey(UpdateHmacKeyRequest request)

public HmacKeyMetadata updateHmacKey(UpdateHmacKeyRequest request)

Updates a given HMAC key state between ACTIVE and INACTIVE.

Parameter
Name	Description
`request`	`UpdateHmacKeyRequest`

Returns
Type	Description
`HmacKeyMetadata`

updateObject(UpdateObjectRequest request)

public Object updateObject(UpdateObjectRequest request)

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

Parameter
Name	Description
`request`	`UpdateObjectRequest`

Returns
Type	Description
`Object`