Package com.google.storage.v2 (2.38.0)
| GitHub Repository |
This package is not the recommended entry point to using this client library!
For this library, we recommend using com.google.cloud.storage for new applications.
Client Classes
Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.
| Client | Description |
|---|---|
| com.google.storage.v2.StorageClient |
Service Description: ## 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 |
Settings Classes
Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.
| Settings | Description |
|---|---|
| com.google.storage.v2.StorageSettings |
Settings class to configure an instance of StorageClient.
The default instance has everything set to sensible defaults: |
Classes
| Class | Description |
|---|---|
| com.google.storage.v2.BidiWriteObjectRequest | Request message for BidiWriteObject. |
| com.google.storage.v2.BidiWriteObjectRequest.Builder | Request message for BidiWriteObject. |
| com.google.storage.v2.BidiWriteObjectResponse | Response message for BidiWriteObject. |
| com.google.storage.v2.BidiWriteObjectResponse.Builder | Response message for BidiWriteObject. |
| com.google.storage.v2.Bucket | A bucket. |
| com.google.storage.v2.Bucket.Autoclass | Configuration for a bucket's Autoclass feature. |
| com.google.storage.v2.Bucket.Autoclass.Builder | Configuration for a bucket's Autoclass feature. |
| com.google.storage.v2.Bucket.Billing | Billing properties of a bucket. |
| com.google.storage.v2.Bucket.Billing.Builder | Billing properties of a bucket. |
| com.google.storage.v2.Bucket.Builder | A bucket. |
| com.google.storage.v2.Bucket.Cors | Cross-Origin Response sharing (CORS) properties for a bucket. For more on Cloud Storage and CORS, see https://cloud.google.com/storage/docs/cross-origin. |
| com.google.storage.v2.Bucket.Cors.Builder | Cross-Origin Response sharing (CORS) properties for a bucket. For more on Cloud Storage and CORS, see https://cloud.google.com/storage/docs/cross-origin. |
| com.google.storage.v2.Bucket.CustomPlacementConfig | Configuration for Custom Dual Regions. It should specify precisely two eligible regions within the same Multiregion. More information on regions may be found https://cloud.google.com/storage/docs/locations. |
| com.google.storage.v2.Bucket.CustomPlacementConfig.Builder | Configuration for Custom Dual Regions. It should specify precisely two eligible regions within the same Multiregion. More information on regions may be found https://cloud.google.com/storage/docs/locations. |
| com.google.storage.v2.Bucket.Encryption | Encryption properties of a bucket. |
| com.google.storage.v2.Bucket.Encryption.Builder | Encryption properties of a bucket. |
| com.google.storage.v2.Bucket.HierarchicalNamespace | Configuration for a bucket's hierarchical namespace feature. |
| com.google.storage.v2.Bucket.HierarchicalNamespace.Builder | Configuration for a bucket's hierarchical namespace feature. |
| com.google.storage.v2.Bucket.IamConfig | Bucket restriction options. |
| com.google.storage.v2.Bucket.IamConfig.Builder | Bucket restriction options. |
| com.google.storage.v2.Bucket.IamConfig.UniformBucketLevelAccess | Settings for Uniform Bucket level access. See https://cloud.google.com/storage/docs/uniform-bucket-level-access. |
| com.google.storage.v2.Bucket.IamConfig.UniformBucketLevelAccess.Builder | Settings for Uniform Bucket level access. See https://cloud.google.com/storage/docs/uniform-bucket-level-access. |
| com.google.storage.v2.Bucket.Lifecycle | Lifecycle properties of a bucket. For more information, see https://cloud.google.com/storage/docs/lifecycle. |
| com.google.storage.v2.Bucket.Lifecycle.Builder | Lifecycle properties of a bucket. For more information, see https://cloud.google.com/storage/docs/lifecycle. |
| com.google.storage.v2.Bucket.Lifecycle.Rule | A lifecycle Rule, combining an action to take on an object and a condition which will trigger that action. |
| com.google.storage.v2.Bucket.Lifecycle.Rule.Action | An action to take on an object. |
| com.google.storage.v2.Bucket.Lifecycle.Rule.Action.Builder | An action to take on an object. |
| com.google.storage.v2.Bucket.Lifecycle.Rule.Builder | A lifecycle Rule, combining an action to take on an object and a condition which will trigger that action. |
| com.google.storage.v2.Bucket.Lifecycle.Rule.Condition | A condition of an object which triggers some action. |
| com.google.storage.v2.Bucket.Lifecycle.Rule.Condition.Builder | A condition of an object which triggers some action. |
| com.google.storage.v2.Bucket.Logging | Logging-related properties of a bucket. |
| com.google.storage.v2.Bucket.Logging.Builder | Logging-related properties of a bucket. |
| com.google.storage.v2.Bucket.RetentionPolicy | Retention policy properties of a bucket. |
| com.google.storage.v2.Bucket.RetentionPolicy.Builder | Retention policy properties of a bucket. |
| com.google.storage.v2.Bucket.SoftDeletePolicy | Soft delete policy properties of a bucket. |
| com.google.storage.v2.Bucket.SoftDeletePolicy.Builder | Soft delete policy properties of a bucket. |
| com.google.storage.v2.Bucket.Versioning | Properties of a bucket related to versioning. For more on Cloud Storage versioning, see https://cloud.google.com/storage/docs/object-versioning. |
| com.google.storage.v2.Bucket.Versioning.Builder | Properties of a bucket related to versioning. For more on Cloud Storage versioning, see https://cloud.google.com/storage/docs/object-versioning. |
| com.google.storage.v2.Bucket.Website | Properties of a bucket related to accessing the contents as a static website. For more on hosting a static website via Cloud Storage, see https://cloud.google.com/storage/docs/hosting-static-website. |
| com.google.storage.v2.Bucket.Website.Builder | Properties of a bucket related to accessing the contents as a static website. For more on hosting a static website via Cloud Storage, see https://cloud.google.com/storage/docs/hosting-static-website. |
| com.google.storage.v2.BucketAccessControl | An access-control entry. |
| com.google.storage.v2.BucketAccessControl.Builder | An access-control entry. |
| com.google.storage.v2.BucketName | |
| com.google.storage.v2.BucketName.Builder | Builder for projects/{project}/buckets/{bucket}. |
| com.google.storage.v2.CancelResumableWriteRequest |
Message for canceling an in-progress resumable upload.
upload_id must be set.
|
| com.google.storage.v2.CancelResumableWriteRequest.Builder |
Message for canceling an in-progress resumable upload.
upload_id must be set.
|
| com.google.storage.v2.CancelResumableWriteResponse | Empty response message for canceling an in-progress resumable upload, will be extended as needed. |
| com.google.storage.v2.CancelResumableWriteResponse.Builder | Empty response message for canceling an in-progress resumable upload, will be extended as needed. |
| com.google.storage.v2.ChecksummedData | Message used to convey content being read or written, along with an optional checksum. |
| com.google.storage.v2.ChecksummedData.Builder | Message used to convey content being read or written, along with an optional checksum. |
| com.google.storage.v2.CommonObjectRequestParams | Parameters that can be passed to any object request. |
| com.google.storage.v2.CommonObjectRequestParams.Builder | Parameters that can be passed to any object request. |
| com.google.storage.v2.ComposeObjectRequest | Request message for ComposeObject. |
| com.google.storage.v2.ComposeObjectRequest.Builder | Request message for ComposeObject. |
| com.google.storage.v2.ComposeObjectRequest.SourceObject | Description of a source object for a composition request. |
| com.google.storage.v2.ComposeObjectRequest.SourceObject.Builder | Description of a source object for a composition request. |
| com.google.storage.v2.ComposeObjectRequest.SourceObject.ObjectPreconditions | Preconditions for a source object of a composition request. |
| com.google.storage.v2.ComposeObjectRequest.SourceObject.ObjectPreconditions.Builder | Preconditions for a source object of a composition request. |
| com.google.storage.v2.ContentRange | Specifies a requested range of bytes to download. |
| com.google.storage.v2.ContentRange.Builder | Specifies a requested range of bytes to download. |
| com.google.storage.v2.CreateBucketRequest | Request message for CreateBucket. |
| com.google.storage.v2.CreateBucketRequest.Builder | Request message for CreateBucket. |
| com.google.storage.v2.CreateHmacKeyRequest | Request message for CreateHmacKey. |
| com.google.storage.v2.CreateHmacKeyRequest.Builder | Request message for CreateHmacKey. |
| com.google.storage.v2.CreateHmacKeyResponse | Create hmac response. The only time the secret for an HMAC will be returned. |
| com.google.storage.v2.CreateHmacKeyResponse.Builder | Create hmac response. The only time the secret for an HMAC will be returned. |
| com.google.storage.v2.CreateNotificationConfigRequest | Request message for CreateNotificationConfig. |
| com.google.storage.v2.CreateNotificationConfigRequest.Builder | Request message for CreateNotificationConfig. |
| com.google.storage.v2.CryptoKeyName | |
| com.google.storage.v2.CryptoKeyName.Builder | Builder for projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. |
| com.google.storage.v2.CustomerEncryption | Describes the Customer-Supplied Encryption Key mechanism used to store an Object's data at rest. |
| com.google.storage.v2.CustomerEncryption.Builder | Describes the Customer-Supplied Encryption Key mechanism used to store an Object's data at rest. |
| com.google.storage.v2.DeleteBucketRequest | Request message for DeleteBucket. |
| com.google.storage.v2.DeleteBucketRequest.Builder | Request message for DeleteBucket. |
| com.google.storage.v2.DeleteHmacKeyRequest | Request object to delete a given HMAC key. |
| com.google.storage.v2.DeleteHmacKeyRequest.Builder | Request object to delete a given HMAC key. |
| com.google.storage.v2.DeleteNotificationConfigRequest | Request message for DeleteNotificationConfig. |
| com.google.storage.v2.DeleteNotificationConfigRequest.Builder | Request message for DeleteNotificationConfig. |
| com.google.storage.v2.DeleteObjectRequest |
Message for deleting an object.
bucket and object must be set.
|
| com.google.storage.v2.DeleteObjectRequest.Builder |
Message for deleting an object.
bucket and object must be set.
|
| com.google.storage.v2.GetBucketRequest | Request message for GetBucket. |
| com.google.storage.v2.GetBucketRequest.Builder | Request message for GetBucket. |
| com.google.storage.v2.GetHmacKeyRequest | Request object to get metadata on a given HMAC key. |
| com.google.storage.v2.GetHmacKeyRequest.Builder | Request object to get metadata on a given HMAC key. |
| com.google.storage.v2.GetNotificationConfigRequest | Request message for GetNotificationConfig. |
| com.google.storage.v2.GetNotificationConfigRequest.Builder | Request message for GetNotificationConfig. |
| com.google.storage.v2.GetObjectRequest | Request message for GetObject. |
| com.google.storage.v2.GetObjectRequest.Builder | Request message for GetObject. |
| com.google.storage.v2.GetServiceAccountRequest | Request message for GetServiceAccount. |
| com.google.storage.v2.GetServiceAccountRequest.Builder | Request message for GetServiceAccount. |
| com.google.storage.v2.HmacKeyMetadata | Hmac Key Metadata, which includes all information other than the secret. |
| com.google.storage.v2.HmacKeyMetadata.Builder | Hmac Key Metadata, which includes all information other than the secret. |
| com.google.storage.v2.ListBucketsRequest | Request message for ListBuckets. |
| com.google.storage.v2.ListBucketsRequest.Builder | Request message for ListBuckets. |
| com.google.storage.v2.ListBucketsResponse | The result of a call to Buckets.ListBuckets |
| com.google.storage.v2.ListBucketsResponse.Builder | The result of a call to Buckets.ListBuckets |
| com.google.storage.v2.ListHmacKeysRequest | Request to fetch a list of HMAC keys under a given project. |
| com.google.storage.v2.ListHmacKeysRequest.Builder | Request to fetch a list of HMAC keys under a given project. |
| com.google.storage.v2.ListHmacKeysResponse | Hmac key list response with next page information. |
| com.google.storage.v2.ListHmacKeysResponse.Builder | Hmac key list response with next page information. |
| com.google.storage.v2.ListNotificationConfigsRequest | Request message for ListNotifications. |
| com.google.storage.v2.ListNotificationConfigsRequest.Builder | Request message for ListNotifications. |
| com.google.storage.v2.ListNotificationConfigsResponse | The result of a call to ListNotificationConfigs |
| com.google.storage.v2.ListNotificationConfigsResponse.Builder | The result of a call to ListNotificationConfigs |
| com.google.storage.v2.ListObjectsRequest | Request message for ListObjects. |
| com.google.storage.v2.ListObjectsRequest.Builder | Request message for ListObjects. |
| com.google.storage.v2.ListObjectsResponse | The result of a call to Objects.ListObjects |
| com.google.storage.v2.ListObjectsResponse.Builder | The result of a call to Objects.ListObjects |
| com.google.storage.v2.LockBucketRetentionPolicyRequest | Request message for LockBucketRetentionPolicyRequest. |
| com.google.storage.v2.LockBucketRetentionPolicyRequest.Builder | Request message for LockBucketRetentionPolicyRequest. |
| com.google.storage.v2.NotificationConfig | A directive to publish Pub/Sub notifications upon changes to a bucket. |
| com.google.storage.v2.NotificationConfig.Builder | A directive to publish Pub/Sub notifications upon changes to a bucket. |
| com.google.storage.v2.NotificationConfigName | |
| com.google.storage.v2.NotificationConfigName.Builder | Builder for projects/{project}/buckets/{bucket}/notificationConfigs/{notification_config}. |
| com.google.storage.v2.Object | An object. |
| com.google.storage.v2.Object.Builder | An object. |
| com.google.storage.v2.ObjectAccessControl | An access-control entry. |
| com.google.storage.v2.ObjectAccessControl.Builder | An access-control entry. |
| com.google.storage.v2.ObjectChecksums | Message used for storing full (not subrange) object checksums. |
| com.google.storage.v2.ObjectChecksums.Builder | Message used for storing full (not subrange) object checksums. |
| com.google.storage.v2.Owner | The owner of a specific resource. |
| com.google.storage.v2.Owner.Builder | The owner of a specific resource. |
| com.google.storage.v2.ProjectName | |
| com.google.storage.v2.ProjectName.Builder | Builder for projects/{project}. |
| com.google.storage.v2.ProjectTeam | Represents the Viewers, Editors, or Owners of a given project. |
| com.google.storage.v2.ProjectTeam.Builder | Represents the Viewers, Editors, or Owners of a given project. |
| com.google.storage.v2.QueryWriteStatusRequest |
Request object for QueryWriteStatus.
|
| com.google.storage.v2.QueryWriteStatusRequest.Builder |
Request object for QueryWriteStatus.
|
| com.google.storage.v2.QueryWriteStatusResponse |
Response object for QueryWriteStatus.
|
| com.google.storage.v2.QueryWriteStatusResponse.Builder |
Response object for QueryWriteStatus.
|
| com.google.storage.v2.ReadObjectRequest | Request message for ReadObject. |
| com.google.storage.v2.ReadObjectRequest.Builder | Request message for ReadObject. |
| com.google.storage.v2.ReadObjectResponse | Response message for ReadObject. |
| com.google.storage.v2.ReadObjectResponse.Builder | Response message for ReadObject. |
| com.google.storage.v2.RestoreObjectRequest |
Message for restoring an object.
bucket, object, and generation must be set.
|
| com.google.storage.v2.RestoreObjectRequest.Builder |
Message for restoring an object.
bucket, object, and generation must be set.
|
| com.google.storage.v2.RewriteObjectRequest | Request message for RewriteObject. If the source object is encrypted using a Customer-Supplied Encryption Key the key information must be provided in the copy_source_encryption_algorithm, |
| com.google.storage.v2.RewriteObjectRequest.Builder | Request message for RewriteObject. If the source object is encrypted using a Customer-Supplied Encryption Key the key information must be provided in the copy_source_encryption_algorithm, |
| com.google.storage.v2.RewriteResponse | A rewrite response. |
| com.google.storage.v2.RewriteResponse.Builder | A rewrite response. |
| com.google.storage.v2.ServiceAccount | A service account, owned by Cloud Storage, which may be used when taking action on behalf of a given project, for example to publish Pub/Sub notifications or to retrieve security keys. |
| com.google.storage.v2.ServiceAccount.Builder | A service account, owned by Cloud Storage, which may be used when taking action on behalf of a given project, for example to publish Pub/Sub notifications or to retrieve security keys. |
| com.google.storage.v2.ServiceConstants | Shared constants. |
| com.google.storage.v2.ServiceConstants.Builder | Shared constants. |
| com.google.storage.v2.StartResumableWriteRequest | Request message StartResumableWrite. |
| com.google.storage.v2.StartResumableWriteRequest.Builder | Request message StartResumableWrite. |
| com.google.storage.v2.StartResumableWriteResponse |
Response object for StartResumableWrite.
|
| com.google.storage.v2.StartResumableWriteResponse.Builder |
Response object for StartResumableWrite.
|
| com.google.storage.v2.StorageClient.ListBucketsFixedSizeCollection | |
| com.google.storage.v2.StorageClient.ListBucketsPage | |
| com.google.storage.v2.StorageClient.ListBucketsPagedResponse | |
| com.google.storage.v2.StorageClient.ListHmacKeysFixedSizeCollection | |
| com.google.storage.v2.StorageClient.ListHmacKeysPage | |
| com.google.storage.v2.StorageClient.ListHmacKeysPagedResponse | |
| com.google.storage.v2.StorageClient.ListNotificationConfigsFixedSizeCollection | |
| com.google.storage.v2.StorageClient.ListNotificationConfigsPage | |
| com.google.storage.v2.StorageClient.ListNotificationConfigsPagedResponse | |
| com.google.storage.v2.StorageClient.ListObjectsFixedSizeCollection | |
| com.google.storage.v2.StorageClient.ListObjectsPage | |
| com.google.storage.v2.StorageClient.ListObjectsPagedResponse | |
| com.google.storage.v2.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 |
| com.google.storage.v2.StorageGrpc.StorageImplBase | Base class for the server implementation of the service Storage. ## API Overview and Naming Syntax |
| com.google.storage.v2.StorageProto | |
| com.google.storage.v2.StorageSettings.Builder | Builder for StorageSettings. |
| com.google.storage.v2.UpdateBucketRequest | Request for UpdateBucket method. |
| com.google.storage.v2.UpdateBucketRequest.Builder | Request for UpdateBucket method. |
| com.google.storage.v2.UpdateHmacKeyRequest | Request object to update an HMAC key state. HmacKeyMetadata.state is required and the only writable field in UpdateHmacKey operation. Specifying fields other than state will result in an |
| com.google.storage.v2.UpdateHmacKeyRequest.Builder | Request object to update an HMAC key state. HmacKeyMetadata.state is required and the only writable field in UpdateHmacKey operation. Specifying fields other than state will result in an |
| com.google.storage.v2.UpdateObjectRequest | Request message for UpdateObject. |
| com.google.storage.v2.UpdateObjectRequest.Builder | Request message for UpdateObject. |
| com.google.storage.v2.WriteObjectRequest | Request message for WriteObject. |
| com.google.storage.v2.WriteObjectRequest.Builder | Request message for WriteObject. |
| com.google.storage.v2.WriteObjectResponse | Response message for WriteObject. |
| com.google.storage.v2.WriteObjectResponse.Builder | Response message for WriteObject. |
| com.google.storage.v2.WriteObjectSpec | Describes an attempt to insert an object, possibly over multiple requests. |
| com.google.storage.v2.WriteObjectSpec.Builder | Describes an attempt to insert an object, possibly over multiple requests. |