Send feedback Class StorageSettings (2.52.3) Stay organized with collections Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
public class StorageSettings extends ClientSettings<StorageSettings> 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 RetrySettings of deleteBucket:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
StorageSettings . Builder storageSettingsBuilder = StorageSettings . newBuilder ();
storageSettingsBuilder
. deleteBucketSettings ()
. setRetrySettings (
storageSettingsBuilder
. deleteBucketSettings ()
. getRetrySettings ()
. toBuilder ()
. setInitialRetryDelayDuration ( Duration . ofSeconds ( 1 ))
. setInitialRpcTimeoutDuration ( Duration . ofSeconds ( 5 ))
. setMaxAttempts ( 5 )
. setMaxRetryDelayDuration ( Duration . ofSeconds ( 30 ))
. setMaxRpcTimeoutDuration ( Duration . ofSeconds ( 60 ))
. setRetryDelayMultiplier ( 1.3 )
. setRpcTimeoutMultiplier ( 1.5 )
. setTotalTimeoutDuration ( Duration . ofSeconds ( 300 ))
. build ());
StorageSettings storageSettings = storageSettingsBuilder . build ();
Please refer to the Client Side Retry Guide for additional support in setting retries.
Static Methods create(StorageStubSettings stub)
public static final StorageSettings create ( StorageStubSettings stub )
public static ApiClientHeaderProvider . Builder defaultApiClientHeaderProviderBuilder () defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider . Builder defaultCredentialsProviderBuilder () Returns a builder for the default credentials for this service.
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider . Builder defaultExecutorProviderBuilder () Returns a builder for the default ExecutorProvider for this service.
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider . Builder defaultGrpcTransportProviderBuilder () Returns a builder for the default ChannelProvider for this service.
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider () getDefaultEndpoint()
public static String getDefaultEndpoint () Returns the default service endpoint.
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes () Returns the default service scopes.
newBuilder()
public static StorageSettings . Builder newBuilder () Returns a new builder for this class.
newBuilder(ClientContext clientContext)
public static StorageSettings . Builder newBuilder ( ClientContext clientContext ) Returns a new builder for this class.
Constructors StorageSettings(StorageSettings.Builder settingsBuilder)
protected StorageSettings ( StorageSettings . Builder settingsBuilder ) Methods bidiReadObjectSettings()
public CallSettings<BidiReadObjectRequest , BidiReadObjectResponse > bidiReadObjectSettings () Returns the object with the settings used for calls to bidiReadObject.
bidiWriteObjectSettings()
public CallSettings<BidiWriteObjectRequest , BidiWriteObjectResponse > bidiWriteObjectSettings () Returns the object with the settings used for calls to bidiWriteObject.
cancelResumableWriteSettings()
public UnaryCallSettings<CancelResumableWriteRequest , CancelResumableWriteResponse > cancelResumableWriteSettings () Returns the object with the settings used for calls to cancelResumableWrite.
composeObjectSettings()
public UnaryCallSettings<ComposeObjectRequest , Object > composeObjectSettings () Returns the object with the settings used for calls to composeObject.
createBucketSettings()
public UnaryCallSettings<CreateBucketRequest , Bucket > createBucketSettings () Returns the object with the settings used for calls to createBucket.
deleteBucketSettings()
public UnaryCallSettings<DeleteBucketRequest , Empty > deleteBucketSettings () Returns the object with the settings used for calls to deleteBucket.
deleteObjectSettings()
public UnaryCallSettings<DeleteObjectRequest , Empty > deleteObjectSettings () Returns the object with the settings used for calls to deleteObject.
getBucketSettings()
public UnaryCallSettings<GetBucketRequest , Bucket > getBucketSettings () Returns the object with the settings used for calls to getBucket.
getIamPolicySettings()
public UnaryCallSettings<GetIamPolicyRequest , Policy > getIamPolicySettings () Returns the object with the settings used for calls to getIamPolicy.
Returns Type Description UnaryCallSettings <com.google.iam.v1.GetIamPolicyRequest ,com.google.iam.v1.Policy >
getObjectSettings()
public UnaryCallSettings<GetObjectRequest , Object > getObjectSettings () Returns the object with the settings used for calls to getObject.
listBucketsSettings()
public PagedCallSettings<ListBucketsRequest , ListBucketsResponse , StorageClient . ListBucketsPagedResponse > listBucketsSettings () Returns the object with the settings used for calls to listBuckets.
listObjectsSettings()
public PagedCallSettings<ListObjectsRequest , ListObjectsResponse , StorageClient . ListObjectsPagedResponse > listObjectsSettings () Returns the object with the settings used for calls to listObjects.
lockBucketRetentionPolicySettings()
public UnaryCallSettings<LockBucketRetentionPolicyRequest , Bucket > lockBucketRetentionPolicySettings () Returns the object with the settings used for calls to lockBucketRetentionPolicy.
moveObjectSettings()
public UnaryCallSettings<MoveObjectRequest , Object > moveObjectSettings () Returns the object with the settings used for calls to moveObject.
queryWriteStatusSettings()
public UnaryCallSettings<QueryWriteStatusRequest , QueryWriteStatusResponse > queryWriteStatusSettings () Returns the object with the settings used for calls to queryWriteStatus.
readObjectSettings()
public ServerCallSettings<ReadObjectRequest , ReadObjectResponse > readObjectSettings () Returns the object with the settings used for calls to readObject.
restoreObjectSettings()
public UnaryCallSettings<RestoreObjectRequest , Object > restoreObjectSettings () Returns the object with the settings used for calls to restoreObject.
rewriteObjectSettings()
public UnaryCallSettings<RewriteObjectRequest , RewriteResponse > rewriteObjectSettings () Returns the object with the settings used for calls to rewriteObject.
setIamPolicySettings()
public UnaryCallSettings<SetIamPolicyRequest , Policy > setIamPolicySettings () Returns the object with the settings used for calls to setIamPolicy.
Returns Type Description UnaryCallSettings <com.google.iam.v1.SetIamPolicyRequest ,com.google.iam.v1.Policy >
startResumableWriteSettings()
public UnaryCallSettings<StartResumableWriteRequest , StartResumableWriteResponse > startResumableWriteSettings () Returns the object with the settings used for calls to startResumableWrite.
testIamPermissionsSettings()
public UnaryCallSettings<TestIamPermissionsRequest , TestIamPermissionsResponse > testIamPermissionsSettings () Returns the object with the settings used for calls to testIamPermissions.
Returns Type Description UnaryCallSettings <com.google.iam.v1.TestIamPermissionsRequest ,com.google.iam.v1.TestIamPermissionsResponse >
toBuilder()
public StorageSettings . Builder toBuilder () Returns a builder containing all the values of this settings class.
Overrides updateBucketSettings()
public UnaryCallSettings<UpdateBucketRequest , Bucket > updateBucketSettings () Returns the object with the settings used for calls to updateBucket.
updateObjectSettings()
public UnaryCallSettings<UpdateObjectRequest , Object > updateObjectSettings () Returns the object with the settings used for calls to updateObject.
writeObjectSettings()
public CallSettings<WriteObjectRequest , WriteObjectResponse > writeObjectSettings () Returns the object with the settings used for calls to writeObject.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-05 UTC.
Need to tell us more? [[["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-06-05 UTC."],[],[]]