Utility to create a remote storage configuration for testing. Storage options can be obtained via
the #getOptions() ()} method. Returned options have custom StorageOptions#getRetrySettings(): RetrySettings#getMaxAttempts() is 10, RetrySettings#getMaxRetryDelay() is 30000, RetrySettings#getTotalTimeout() is
120000 and RetrySettings#getInitialRetryDelay() is 250. HttpTransportOptions#getConnectTimeout() and HttpTransportOptions#getReadTimeout() are
both set to 60000.
Deletes a bucket, even if non-empty. Objects in the bucket are listed and deleted until bucket
deletion succeeds or timeout expires. To allow for the timeout, this method uses a
separate thread to send the delete requests. Use #forceDelete(Storage storage, String
bucket) if spawning an additional thread is undesirable, such as in the App Engine production
runtime.
Deletes a bucket, even if non-empty. Objects in the bucket are listed and deleted until bucket
deletion succeeds or timeout expires. To allow for the timeout, this method uses a
separate thread to send the delete requests. Use #forceDelete(Storage storage, String
bucket) if spawning an additional thread is undesirable, such as in the App Engine production
runtime.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-16 UTC."],[],[],null,["# Class RemoteStorageHelper (2.55.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.55.0 (latest)](/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.54.0](/java/docs/reference/google-cloud-storage/2.54.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.53.3](/java/docs/reference/google-cloud-storage/2.53.3/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.52.3](/java/docs/reference/google-cloud-storage/2.52.3/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.50.0](/java/docs/reference/google-cloud-storage/2.50.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.49.0](/java/docs/reference/google-cloud-storage/2.49.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.48.2](/java/docs/reference/google-cloud-storage/2.48.2/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.47.0](/java/docs/reference/google-cloud-storage/2.47.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.46.0](/java/docs/reference/google-cloud-storage/2.46.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.45.0](/java/docs/reference/google-cloud-storage/2.45.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.44.1](/java/docs/reference/google-cloud-storage/2.44.1/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.43.2](/java/docs/reference/google-cloud-storage/2.43.2/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.42.0](/java/docs/reference/google-cloud-storage/2.42.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.41.0](/java/docs/reference/google-cloud-storage/2.41.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.40.1](/java/docs/reference/google-cloud-storage/2.40.1/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.39.0](/java/docs/reference/google-cloud-storage/2.39.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.38.0](/java/docs/reference/google-cloud-storage/2.38.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.37.0](/java/docs/reference/google-cloud-storage/2.37.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.36.1](/java/docs/reference/google-cloud-storage/2.36.1/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.34.0](/java/docs/reference/google-cloud-storage/2.34.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.33.0](/java/docs/reference/google-cloud-storage/2.33.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.32.1](/java/docs/reference/google-cloud-storage/2.32.1/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.30.1](/java/docs/reference/google-cloud-storage/2.30.1/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.29.1](/java/docs/reference/google-cloud-storage/2.29.1/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.28.0](/java/docs/reference/google-cloud-storage/2.28.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.27.1](/java/docs/reference/google-cloud-storage/2.27.1/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.24.0](/java/docs/reference/google-cloud-storage/2.24.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.23.0](/java/docs/reference/google-cloud-storage/2.23.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.22.6](/java/docs/reference/google-cloud-storage/2.22.6/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.21.0](/java/docs/reference/google-cloud-storage/2.21.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.20.2](/java/docs/reference/google-cloud-storage/2.20.2/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.19.0](/java/docs/reference/google-cloud-storage/2.19.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.18.0](/java/docs/reference/google-cloud-storage/2.18.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.17.2](/java/docs/reference/google-cloud-storage/2.17.2/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.16.0](/java/docs/reference/google-cloud-storage/2.16.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.15.1](/java/docs/reference/google-cloud-storage/2.15.1/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.14.0](/java/docs/reference/google-cloud-storage/2.14.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.13.1](/java/docs/reference/google-cloud-storage/2.13.1/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.12.0](/java/docs/reference/google-cloud-storage/2.12.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.11.3](/java/docs/reference/google-cloud-storage/2.11.3/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.10.0](/java/docs/reference/google-cloud-storage/2.10.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.9.3](/java/docs/reference/google-cloud-storage/2.9.3/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.8.1](/java/docs/reference/google-cloud-storage/2.8.1/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.7.1](/java/docs/reference/google-cloud-storage/2.7.1/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.6.1](/java/docs/reference/google-cloud-storage/2.6.1/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.5.1](/java/docs/reference/google-cloud-storage/2.5.1/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.4.5](/java/docs/reference/google-cloud-storage/2.4.5/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.3.0](/java/docs/reference/google-cloud-storage/2.3.0/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.2.3](/java/docs/reference/google-cloud-storage/2.2.3/com.google.cloud.storage.testing.RemoteStorageHelper)\n- [2.1.10](/java/docs/reference/google-cloud-storage/2.1.10/com.google.cloud.storage.testing.RemoteStorageHelper) \n\n public class RemoteStorageHelper\n\nUtility to create a remote storage configuration for testing. Storage options can be obtained via\nthe [#getOptions()](/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.testing.RemoteStorageHelper#com_google_cloud_storage_testing_RemoteStorageHelper_getOptions__) ()} method. Returned options have custom StorageOptions#getRetrySettings(): RetrySettings#getMaxAttempts() is `10`, RetrySettings#getMaxRetryDelay() is `30000`, RetrySettings#getTotalTimeout() is\n`120000` and RetrySettings#getInitialRetryDelay() is `250`. HttpTransportOptions#getConnectTimeout() and HttpTransportOptions#getReadTimeout() are\nboth set to `60000`. \n\nInheritance\n-----------\n\n[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \\\u003e RemoteStorageHelper \n\nInherited Members\n-----------------\n\n[Object.clone()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--) \n[Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-) \n[Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) \n[Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) \n[Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--) \n[Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) \n[Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) \n[Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) \n[Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) \n[Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) \n[Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)\n\nStatic Methods\n--------------\n\n### cleanBuckets(Storage storage, long olderThan, long timeoutMs)\n\n public static void cleanBuckets(Storage storage, long olderThan, long timeoutMs)\n\n### create()\n\n public static RemoteStorageHelper create()\n\nCreates a `RemoteStorageHelper` object using default project id and authentication\ncredentials.\n\n### create(String projectId, InputStream keyStream)\n\n public static RemoteStorageHelper create(String projectId, InputStream keyStream)\n\nCreates a `RemoteStorageHelper` object for the given project id and JSON key input\nstream.\n\n### forceDelete(Storage storage, String bucket)\n\n public static void forceDelete(Storage storage, String bucket)\n\nDeletes a bucket, even if non-empty. This method blocks until the deletion completes or fails.\n\n### forceDelete(Storage storage, String bucket, long timeout, TimeUnit unit)\n\n public static Boolean forceDelete(Storage storage, String bucket, long timeout, TimeUnit unit)\n\nDeletes a bucket, even if non-empty. Objects in the bucket are listed and deleted until bucket\ndeletion succeeds or `timeout` expires. To allow for the timeout, this method uses a\nseparate thread to send the delete requests. Use #forceDelete(Storage storage, String bucket) if spawning an additional thread is undesirable, such as in the App Engine production\nruntime.\n\n### forceDelete(Storage storage, String bucket, long timeout, TimeUnit unit, String userProject)\n\n public static Boolean forceDelete(Storage storage, String bucket, long timeout, TimeUnit unit, String userProject)\n\nDeletes a bucket, even if non-empty. Objects in the bucket are listed and deleted until bucket\ndeletion succeeds or `timeout` expires. To allow for the timeout, this method uses a\nseparate thread to send the delete requests. Use #forceDelete(Storage storage, String bucket) if spawning an additional thread is undesirable, such as in the App Engine production\nruntime.\n\n### generateBucketName()\n\n public static String generateBucketName()\n\nReturns a bucket name generated using a random UUID.\n\nMethods\n-------\n\n### getOptions()\n\n public StorageOptions getOptions()\n\nReturns a [StorageOptions](/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.StorageOptions) object to be used for testing."]]
