Class StorageGrpc (2.39.0)

public final class StorageGrpc

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 > StorageGrpc

Static Fields

SERVICE_NAME

public static final String SERVICE_NAME
Field Value
Type Description
String

Static Methods

bindService(StorageGrpc.AsyncService service)

public static final ServerServiceDefinition bindService(StorageGrpc.AsyncService service)
Parameter
Name Description
service StorageGrpc.AsyncService
Returns
Type Description
io.grpc.ServerServiceDefinition

getBidiWriteObjectMethod()

public static MethodDescriptor<BidiWriteObjectRequest,BidiWriteObjectResponse> getBidiWriteObjectMethod()
Returns
Type Description
io.grpc.MethodDescriptor<BidiWriteObjectRequest,BidiWriteObjectResponse>

getCancelResumableWriteMethod()

public static MethodDescriptor<CancelResumableWriteRequest,CancelResumableWriteResponse> getCancelResumableWriteMethod()
Returns
Type Description
io.grpc.MethodDescriptor<CancelResumableWriteRequest,CancelResumableWriteResponse>

getComposeObjectMethod()

public static MethodDescriptor<ComposeObjectRequest,Object> getComposeObjectMethod()
Returns
Type Description
io.grpc.MethodDescriptor<ComposeObjectRequest,Object>

getCreateBucketMethod()

public static MethodDescriptor<CreateBucketRequest,Bucket> getCreateBucketMethod()
Returns
Type Description
io.grpc.MethodDescriptor<CreateBucketRequest,Bucket>

getCreateHmacKeyMethod()

public static MethodDescriptor<CreateHmacKeyRequest,CreateHmacKeyResponse> getCreateHmacKeyMethod()
Returns
Type Description
io.grpc.MethodDescriptor<CreateHmacKeyRequest,CreateHmacKeyResponse>

getCreateNotificationConfigMethod()

public static MethodDescriptor<CreateNotificationConfigRequest,NotificationConfig> getCreateNotificationConfigMethod()
Returns
Type Description
io.grpc.MethodDescriptor<CreateNotificationConfigRequest,NotificationConfig>

getDeleteBucketMethod()

public static MethodDescriptor<DeleteBucketRequest,Empty> getDeleteBucketMethod()
Returns
Type Description
io.grpc.MethodDescriptor<DeleteBucketRequest,Empty>

getDeleteHmacKeyMethod()

public static MethodDescriptor<DeleteHmacKeyRequest,Empty> getDeleteHmacKeyMethod()
Returns
Type Description
io.grpc.MethodDescriptor<DeleteHmacKeyRequest,Empty>

getDeleteNotificationConfigMethod()

public static MethodDescriptor<DeleteNotificationConfigRequest,Empty> getDeleteNotificationConfigMethod()
Returns
Type Description
io.grpc.MethodDescriptor<DeleteNotificationConfigRequest,Empty>

getDeleteObjectMethod()

public static MethodDescriptor<DeleteObjectRequest,Empty> getDeleteObjectMethod()
Returns
Type Description
io.grpc.MethodDescriptor<DeleteObjectRequest,Empty>

getGetBucketMethod()

public static MethodDescriptor<GetBucketRequest,Bucket> getGetBucketMethod()
Returns
Type Description
io.grpc.MethodDescriptor<GetBucketRequest,Bucket>

getGetHmacKeyMethod()

public static MethodDescriptor<GetHmacKeyRequest,HmacKeyMetadata> getGetHmacKeyMethod()
Returns
Type Description
io.grpc.MethodDescriptor<GetHmacKeyRequest,HmacKeyMetadata>

getGetIamPolicyMethod()

public static MethodDescriptor<GetIamPolicyRequest,Policy> getGetIamPolicyMethod()
Returns
Type Description
io.grpc.MethodDescriptor<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getGetNotificationConfigMethod()

public static MethodDescriptor<GetNotificationConfigRequest,NotificationConfig> getGetNotificationConfigMethod()
Returns
Type Description
io.grpc.MethodDescriptor<GetNotificationConfigRequest,NotificationConfig>

getGetObjectMethod()

public static MethodDescriptor<GetObjectRequest,Object> getGetObjectMethod()
Returns
Type Description
io.grpc.MethodDescriptor<GetObjectRequest,Object>

getGetServiceAccountMethod()

public static MethodDescriptor<GetServiceAccountRequest,ServiceAccount> getGetServiceAccountMethod()
Returns
Type Description
io.grpc.MethodDescriptor<GetServiceAccountRequest,ServiceAccount>

getListBucketsMethod()

public static MethodDescriptor<ListBucketsRequest,ListBucketsResponse> getListBucketsMethod()
Returns
Type Description
io.grpc.MethodDescriptor<ListBucketsRequest,ListBucketsResponse>

getListHmacKeysMethod()

public static MethodDescriptor<ListHmacKeysRequest,ListHmacKeysResponse> getListHmacKeysMethod()
Returns
Type Description
io.grpc.MethodDescriptor<ListHmacKeysRequest,ListHmacKeysResponse>

getListNotificationConfigsMethod()

public static MethodDescriptor<ListNotificationConfigsRequest,ListNotificationConfigsResponse> getListNotificationConfigsMethod()
Returns
Type Description
io.grpc.MethodDescriptor<ListNotificationConfigsRequest,ListNotificationConfigsResponse>

getListObjectsMethod()

public static MethodDescriptor<ListObjectsRequest,ListObjectsResponse> getListObjectsMethod()
Returns
Type Description
io.grpc.MethodDescriptor<ListObjectsRequest,ListObjectsResponse>

getLockBucketRetentionPolicyMethod()

public static MethodDescriptor<LockBucketRetentionPolicyRequest,Bucket> getLockBucketRetentionPolicyMethod()
Returns
Type Description
io.grpc.MethodDescriptor<LockBucketRetentionPolicyRequest,Bucket>

getQueryWriteStatusMethod()

public static MethodDescriptor<QueryWriteStatusRequest,QueryWriteStatusResponse> getQueryWriteStatusMethod()
Returns
Type Description
io.grpc.MethodDescriptor<QueryWriteStatusRequest,QueryWriteStatusResponse>

getReadObjectMethod()

public static MethodDescriptor<ReadObjectRequest,ReadObjectResponse> getReadObjectMethod()
Returns
Type Description
io.grpc.MethodDescriptor<ReadObjectRequest,ReadObjectResponse>

getRestoreObjectMethod()

public static MethodDescriptor<RestoreObjectRequest,Object> getRestoreObjectMethod()
Returns
Type Description
io.grpc.MethodDescriptor<RestoreObjectRequest,Object>

getRewriteObjectMethod()

public static MethodDescriptor<RewriteObjectRequest,RewriteResponse> getRewriteObjectMethod()
Returns
Type Description
io.grpc.MethodDescriptor<RewriteObjectRequest,RewriteResponse>

getServiceDescriptor()

public static ServiceDescriptor getServiceDescriptor()
Returns
Type Description
io.grpc.ServiceDescriptor

getSetIamPolicyMethod()

public static MethodDescriptor<SetIamPolicyRequest,Policy> getSetIamPolicyMethod()
Returns
Type Description
io.grpc.MethodDescriptor<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

getStartResumableWriteMethod()

public static MethodDescriptor<StartResumableWriteRequest,StartResumableWriteResponse> getStartResumableWriteMethod()
Returns
Type Description
io.grpc.MethodDescriptor<StartResumableWriteRequest,StartResumableWriteResponse>

getTestIamPermissionsMethod()

public static MethodDescriptor<TestIamPermissionsRequest,TestIamPermissionsResponse> getTestIamPermissionsMethod()
Returns
Type Description
io.grpc.MethodDescriptor<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

getUpdateBucketMethod()

public static MethodDescriptor<UpdateBucketRequest,Bucket> getUpdateBucketMethod()
Returns
Type Description
io.grpc.MethodDescriptor<UpdateBucketRequest,Bucket>

getUpdateHmacKeyMethod()

public static MethodDescriptor<UpdateHmacKeyRequest,HmacKeyMetadata> getUpdateHmacKeyMethod()
Returns
Type Description
io.grpc.MethodDescriptor<UpdateHmacKeyRequest,HmacKeyMetadata>

getUpdateObjectMethod()

public static MethodDescriptor<UpdateObjectRequest,Object> getUpdateObjectMethod()
Returns
Type Description
io.grpc.MethodDescriptor<UpdateObjectRequest,Object>

getWriteObjectMethod()

public static MethodDescriptor<WriteObjectRequest,WriteObjectResponse> getWriteObjectMethod()
Returns
Type Description
io.grpc.MethodDescriptor<WriteObjectRequest,WriteObjectResponse>

newBlockingStub(Channel channel)

public static StorageGrpc.StorageBlockingStub newBlockingStub(Channel channel)

Creates a new blocking-style stub that supports unary and streaming output calls on the service

Parameter
Name Description
channel io.grpc.Channel
Returns
Type Description
StorageGrpc.StorageBlockingStub

newFutureStub(Channel channel)

public static StorageGrpc.StorageFutureStub newFutureStub(Channel channel)

Creates a new ListenableFuture-style stub that supports unary calls on the service

Parameter
Name Description
channel io.grpc.Channel
Returns
Type Description
StorageGrpc.StorageFutureStub

newStub(Channel channel)

public static StorageGrpc.StorageStub newStub(Channel channel)

Creates a new async stub that supports all call types for the service

Parameter
Name Description
channel io.grpc.Channel
Returns
Type Description
StorageGrpc.StorageStub