Package com.google.storage.v2 (2.4.5)

A bucket.

Protobuf type google.storage.v2.Bucket

Billing properties of a bucket.

Protobuf type google.storage.v2.Bucket.Billing

Billing properties of a bucket.

Protobuf type google.storage.v2.Bucket.Billing

A bucket.

Protobuf type google.storage.v2.Bucket

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. For more on CORS in general, see https://tools.ietf.org/html/rfc6454.

Protobuf type 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. For more on CORS in general, see https://tools.ietf.org/html/rfc6454.

Protobuf type google.storage.v2.Bucket.Cors

Configuration for Custom Dual Regions. It should specify precisely two eligible regions within the same Multiregion.

Protobuf type google.storage.v2.Bucket.CustomPlacementConfig

Configuration for Custom Dual Regions. It should specify precisely two eligible regions within the same Multiregion.

Protobuf type google.storage.v2.Bucket.CustomPlacementConfig

Encryption properties of a bucket.

Protobuf type google.storage.v2.Bucket.Encryption

Encryption properties of a bucket.

Protobuf type google.storage.v2.Bucket.Encryption

Bucket restriction options.

Protobuf type google.storage.v2.Bucket.IamConfig

Bucket restriction options.

Protobuf type google.storage.v2.Bucket.IamConfig

Settings for Uniform Bucket level access. See https://cloud.google.com/storage/docs/uniform-bucket-level-access.

Protobuf type google.storage.v2.Bucket.IamConfig.UniformBucketLevelAccess

Settings for Uniform Bucket level access. See https://cloud.google.com/storage/docs/uniform-bucket-level-access.

Protobuf type google.storage.v2.Bucket.IamConfig.UniformBucketLevelAccess

Lifecycle properties of a bucket. For more information, see https://cloud.google.com/storage/docs/lifecycle.

Protobuf type google.storage.v2.Bucket.Lifecycle

Lifecycle properties of a bucket. For more information, see https://cloud.google.com/storage/docs/lifecycle.

Protobuf type google.storage.v2.Bucket.Lifecycle

A lifecycle Rule, combining an action to take on an object and a condition which will trigger that action.

Protobuf type google.storage.v2.Bucket.Lifecycle.Rule

An action to take on an object.

Protobuf type google.storage.v2.Bucket.Lifecycle.Rule.Action

An action to take on an object.

Protobuf type google.storage.v2.Bucket.Lifecycle.Rule.Action

A lifecycle Rule, combining an action to take on an object and a condition which will trigger that action.

Protobuf type google.storage.v2.Bucket.Lifecycle.Rule

A condition of an object which triggers some action.

Protobuf type google.storage.v2.Bucket.Lifecycle.Rule.Condition

A condition of an object which triggers some action.

Protobuf type google.storage.v2.Bucket.Lifecycle.Rule.Condition

Logging-related properties of a bucket.

Protobuf type google.storage.v2.Bucket.Logging

Logging-related properties of a bucket.

Protobuf type google.storage.v2.Bucket.Logging

Retention policy properties of a bucket.

Protobuf type google.storage.v2.Bucket.RetentionPolicy

Retention policy properties of a bucket.

Protobuf type google.storage.v2.Bucket.RetentionPolicy

Properties of a bucket related to versioning. For more on Cloud Storage versioning, see https://cloud.google.com/storage/docs/object-versioning.

Protobuf type 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.

Protobuf type google.storage.v2.Bucket.Versioning

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.

Protobuf type 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.

Protobuf type google.storage.v2.Bucket.Website

An access-control entry.

Protobuf type google.storage.v2.BucketAccessControl

An access-control entry.

Protobuf type google.storage.v2.BucketAccessControl

Builder for projects/{project}/buckets/{bucket}.

Message used to convey content being read or written, along with an optional checksum.

Protobuf type google.storage.v2.ChecksummedData

Message used to convey content being read or written, along with an optional checksum.

Protobuf type google.storage.v2.ChecksummedData

Parameters that can be passed to any object request.

Protobuf type google.storage.v2.CommonObjectRequestParams

Parameters that can be passed to any object request.

Protobuf type google.storage.v2.CommonObjectRequestParams

Parameters that can be passed to any request.

Protobuf type google.storage.v2.CommonRequestParams

Parameters that can be passed to any request.

Protobuf type google.storage.v2.CommonRequestParams

Request message for ComposeObject.

Protobuf type google.storage.v2.ComposeObjectRequest

Request message for ComposeObject.

Protobuf type google.storage.v2.ComposeObjectRequest

Description of a source object for a composition request.

Protobuf type google.storage.v2.ComposeObjectRequest.SourceObject

Description of a source object for a composition request.

Protobuf type google.storage.v2.ComposeObjectRequest.SourceObject

Preconditions for a source object of a composition request.

Protobuf type google.storage.v2.ComposeObjectRequest.SourceObject.ObjectPreconditions

Preconditions for a source object of a composition request.

Protobuf type google.storage.v2.ComposeObjectRequest.SourceObject.ObjectPreconditions

Specifies a requested range of bytes to download.

Protobuf type google.storage.v2.ContentRange

Specifies a requested range of bytes to download.

Protobuf type google.storage.v2.ContentRange

Request message for CreateBucket.

Protobuf type google.storage.v2.CreateBucketRequest

Request message for CreateBucket.

Protobuf type google.storage.v2.CreateBucketRequest

Request message for CreateHmacKey.

Protobuf type google.storage.v2.CreateHmacKeyRequest

Request message for CreateHmacKey.

Protobuf type google.storage.v2.CreateHmacKeyRequest

Create hmac response. The only time the secret for an HMAC will be returned.

Protobuf type google.storage.v2.CreateHmacKeyResponse

Create hmac response. The only time the secret for an HMAC will be returned.

Protobuf type google.storage.v2.CreateHmacKeyResponse

Request message for CreateNotification.

Protobuf type google.storage.v2.CreateNotificationRequest

Request message for CreateNotification.

Protobuf type google.storage.v2.CreateNotificationRequest

Builder for projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

Describes the Customer-Supplied Encryption Key mechanism used to store an Object's data at rest.

Protobuf type google.storage.v2.CustomerEncryption

Describes the Customer-Supplied Encryption Key mechanism used to store an Object's data at rest.

Protobuf type google.storage.v2.CustomerEncryption

Request message for DeleteBucket.

Protobuf type google.storage.v2.DeleteBucketRequest

Request message for DeleteBucket.

Protobuf type google.storage.v2.DeleteBucketRequest

Request object to delete a given HMAC key.

Protobuf type google.storage.v2.DeleteHmacKeyRequest

Request object to delete a given HMAC key.

Protobuf type google.storage.v2.DeleteHmacKeyRequest

Request message for DeleteNotification.

Protobuf type google.storage.v2.DeleteNotificationRequest

Request message for DeleteNotification.

Protobuf type google.storage.v2.DeleteNotificationRequest

Message for deleting an object. Either bucket and object or upload_id must be set (but not both).

Protobuf type google.storage.v2.DeleteObjectRequest

Message for deleting an object. Either bucket and object or upload_id must be set (but not both).

Protobuf type google.storage.v2.DeleteObjectRequest

Request message for GetBucket.

Protobuf type google.storage.v2.GetBucketRequest

Request message for GetBucket.

Protobuf type google.storage.v2.GetBucketRequest

Request object to get metadata on a given HMAC key.

Protobuf type google.storage.v2.GetHmacKeyRequest

Request object to get metadata on a given HMAC key.

Protobuf type google.storage.v2.GetHmacKeyRequest

Request message for GetNotification.

Protobuf type google.storage.v2.GetNotificationRequest

Request message for GetNotification.

Protobuf type google.storage.v2.GetNotificationRequest

Request message for GetObject.

Protobuf type google.storage.v2.GetObjectRequest

Request message for GetObject.

Protobuf type google.storage.v2.GetObjectRequest

Request message for GetServiceAccount.

Protobuf type google.storage.v2.GetServiceAccountRequest

Request message for GetServiceAccount.

Protobuf type google.storage.v2.GetServiceAccountRequest

Hmac Key Metadata, which includes all information other than the secret.

Protobuf type google.storage.v2.HmacKeyMetadata

Hmac Key Metadata, which includes all information other than the secret.

Protobuf type google.storage.v2.HmacKeyMetadata

Request message for ListBuckets.

Protobuf type google.storage.v2.ListBucketsRequest

Request message for ListBuckets.

Protobuf type google.storage.v2.ListBucketsRequest

The result of a call to Buckets.ListBuckets

Protobuf type google.storage.v2.ListBucketsResponse

The result of a call to Buckets.ListBuckets

Protobuf type google.storage.v2.ListBucketsResponse

Request to fetch a list of HMAC keys under a given project.

Protobuf type google.storage.v2.ListHmacKeysRequest

Request to fetch a list of HMAC keys under a given project.

Protobuf type google.storage.v2.ListHmacKeysRequest

Hmac key list response with next page information.

Protobuf type google.storage.v2.ListHmacKeysResponse

Hmac key list response with next page information.

Protobuf type google.storage.v2.ListHmacKeysResponse

Request message for ListNotifications.

Protobuf type google.storage.v2.ListNotificationsRequest

Request message for ListNotifications.

Protobuf type google.storage.v2.ListNotificationsRequest

The result of a call to Notifications.ListNotifications

Protobuf type google.storage.v2.ListNotificationsResponse

The result of a call to Notifications.ListNotifications

Protobuf type google.storage.v2.ListNotificationsResponse

Request message for ListObjects.

Protobuf type google.storage.v2.ListObjectsRequest

Request message for ListObjects.

Protobuf type google.storage.v2.ListObjectsRequest

The result of a call to Objects.ListObjects

Protobuf type google.storage.v2.ListObjectsResponse

The result of a call to Objects.ListObjects

Protobuf type google.storage.v2.ListObjectsResponse

Request message for LockBucketRetentionPolicyRequest.

Protobuf type google.storage.v2.LockBucketRetentionPolicyRequest

Request message for LockBucketRetentionPolicyRequest.

Protobuf type google.storage.v2.LockBucketRetentionPolicyRequest

A directive to publish Pub/Sub notifications upon changes to a bucket.

Protobuf type google.storage.v2.Notification

A directive to publish Pub/Sub notifications upon changes to a bucket.

Protobuf type google.storage.v2.Notification

Builder for projects/{project}/buckets/{bucket}/notificationConfigs/{notification}.

An object.

Protobuf type google.storage.v2.Object

An object.

Protobuf type google.storage.v2.Object

An access-control entry.

Protobuf type google.storage.v2.ObjectAccessControl

An access-control entry.

Protobuf type google.storage.v2.ObjectAccessControl

Message used for storing full (not subrange) object checksums.

Protobuf type google.storage.v2.ObjectChecksums

Message used for storing full (not subrange) object checksums.

Protobuf type google.storage.v2.ObjectChecksums

The owner of a specific resource.

Protobuf type google.storage.v2.Owner

The owner of a specific resource.

Protobuf type google.storage.v2.Owner

Builder for projects/{project}.

Represents the Viewers, Editors, or Owners of a given project.

Protobuf type google.storage.v2.ProjectTeam

Represents the Viewers, Editors, or Owners of a given project.

Protobuf type google.storage.v2.ProjectTeam

Request object for QueryWriteStatus.

Protobuf type google.storage.v2.QueryWriteStatusRequest

Request object for QueryWriteStatus.

Protobuf type google.storage.v2.QueryWriteStatusRequest

Response object for QueryWriteStatus.

Protobuf type google.storage.v2.QueryWriteStatusResponse

Response object for QueryWriteStatus.

Protobuf type google.storage.v2.QueryWriteStatusResponse

Request message for ReadObject.

Protobuf type google.storage.v2.ReadObjectRequest

Request message for ReadObject.

Protobuf type google.storage.v2.ReadObjectRequest

Response message for GetObject.

Protobuf type google.storage.v2.ReadObjectResponse

Response message for GetObject.

Protobuf type google.storage.v2.ReadObjectResponse

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, copy_source_encryption_key_bytes, and copy_source_encryption_key_sha256_bytes fields. If the destination object should be encrypted the keying information should be provided in the encryption_algorithm, encryption_key_bytes, and encryption_key_sha256_bytes fields of the common_object_request_params.customer_encryption field.

Protobuf type 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, copy_source_encryption_key_bytes, and copy_source_encryption_key_sha256_bytes fields. If the destination object should be encrypted the keying information should be provided in the encryption_algorithm, encryption_key_bytes, and encryption_key_sha256_bytes fields of the common_object_request_params.customer_encryption field.

Protobuf type google.storage.v2.RewriteObjectRequest

A rewrite response.

Protobuf type google.storage.v2.RewriteResponse

A rewrite response.

Protobuf type google.storage.v2.RewriteResponse

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.

Protobuf type 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.

Protobuf type google.storage.v2.ServiceAccount

Shared constants.

Protobuf type google.storage.v2.ServiceConstants

Shared constants.

Protobuf type google.storage.v2.ServiceConstants

Request message StartResumableWrite.

Protobuf type google.storage.v2.StartResumableWriteRequest

Request message StartResumableWrite.

Protobuf type google.storage.v2.StartResumableWriteRequest

Response object for StartResumableWrite.

Protobuf type google.storage.v2.StartResumableWriteResponse

Response object for StartResumableWrite.

Protobuf type google.storage.v2.StartResumableWriteResponse

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

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 try (StorageClient storageClient = StorageClient.create()) {
   BucketName name = BucketName.of("[PROJECT]", "[BUCKET]");
   storageClient.deleteBucket(name);
 }
 

Note: close() needs to be called on the StorageClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of StorageSettings to create(). For example:

To customize credentials:

 StorageSettings storageSettings =
     StorageSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 StorageClient storageClient = StorageClient.create(storageSettings);
 

To customize the endpoint:

 StorageSettings storageSettings = StorageSettings.newBuilder().setEndpoint(myEndpoint).build();
 StorageClient storageClient = StorageClient.create(storageSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

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

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

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

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

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

Settings class to configure an instance of StorageClient.

The default instance has everything set to sensible defaults:

• The default service address (storage.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of deleteBucket to 30 seconds:

 StorageSettings.Builder storageSettingsBuilder = StorageSettings.newBuilder();
 storageSettingsBuilder
     .deleteBucketSettings()
     .setRetrySettings(
         storageSettingsBuilder
             .deleteBucketSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 StorageSettings storageSettings = storageSettingsBuilder.build();
 

Builder for StorageSettings.

Request for UpdateBucket method.

Protobuf type google.storage.v2.UpdateBucketRequest

Request for UpdateBucket method.

Protobuf type google.storage.v2.UpdateBucketRequest

Request object to update an HMAC key state.

Protobuf type google.storage.v2.UpdateHmacKeyRequest

Request object to update an HMAC key state.

Protobuf type google.storage.v2.UpdateHmacKeyRequest

Request message for UpdateObject.

Protobuf type google.storage.v2.UpdateObjectRequest

Request message for UpdateObject.

Protobuf type google.storage.v2.UpdateObjectRequest

Request message for WriteObject.

Protobuf type google.storage.v2.WriteObjectRequest

Request message for WriteObject.

Protobuf type google.storage.v2.WriteObjectRequest

Response message for WriteObject.

Protobuf type google.storage.v2.WriteObjectResponse

Response message for WriteObject.

Protobuf type google.storage.v2.WriteObjectResponse

Describes an attempt to insert an object, possibly over multiple requests.

Protobuf type google.storage.v2.WriteObjectSpec

Describes an attempt to insert an object, possibly over multiple requests.

Protobuf type google.storage.v2.WriteObjectSpec

Public Access Prevention config values.

Protobuf enum google.storage.v2.Bucket.IamConfig.PublicAccessPrevention

A set of predefined, or "canned," ACLs that can be set on a bucket instead of manually specifying a complete ACL.

Protobuf enum google.storage.v2.PredefinedBucketAcl

Predefined or "canned" aliases for sets of specific object ACL entries.

Protobuf enum google.storage.v2.PredefinedObjectAcl

A collection of constant values meaningful to the Storage API.

Protobuf enum google.storage.v2.ServiceConstants.Values