Class StorageSettings (2.9.3) 

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 total timeout of deleteBucket to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 StorageSettings.Builder storageSettingsBuilder = StorageSettings.newBuilder();
 storageSettingsBuilder
     .deleteBucketSettings()
     .setRetrySettings(
         storageSettingsBuilder
             .deleteBucketSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 StorageSettings storageSettings = storageSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > StorageSettings

Static Methods

create(StorageStubSettings stub)

public static final StorageSettings create(StorageStubSettings stub)
Parameter
Name Description
stub StorageStubSettings
Returns
Type Description
StorageSettings
Exceptions
Type Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static StorageSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
StorageSettings.Builder

newBuilder(ClientContext clientContext)

public static StorageSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
StorageSettings.Builder

newHttpJsonBuilder()

public static StorageSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
StorageSettings.Builder

Constructors

StorageSettings(StorageSettings.Builder settingsBuilder)

protected StorageSettings(StorageSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder StorageSettings.Builder

Methods

composeObjectSettings()

public UnaryCallSettings<ComposeObjectRequest,Object> composeObjectSettings()

Returns the object with the settings used for calls to composeObject.

Returns
Type Description
UnaryCallSettings<ComposeObjectRequest,Object>

createBucketSettings()

public UnaryCallSettings<CreateBucketRequest,Bucket> createBucketSettings()

Returns the object with the settings used for calls to createBucket.

Returns
Type Description
UnaryCallSettings<CreateBucketRequest,Bucket>

createHmacKeySettings()

public UnaryCallSettings<CreateHmacKeyRequest,CreateHmacKeyResponse> createHmacKeySettings()

Returns the object with the settings used for calls to createHmacKey.

Returns
Type Description
UnaryCallSettings<CreateHmacKeyRequest,CreateHmacKeyResponse>

createNotificationSettings()

public UnaryCallSettings<CreateNotificationRequest,Notification> createNotificationSettings()

Returns the object with the settings used for calls to createNotification.

Returns
Type Description
UnaryCallSettings<CreateNotificationRequest,Notification>

deleteBucketSettings()

public UnaryCallSettings<DeleteBucketRequest,Empty> deleteBucketSettings()

Returns the object with the settings used for calls to deleteBucket.

Returns
Type Description
UnaryCallSettings<DeleteBucketRequest,Empty>

deleteHmacKeySettings()

public UnaryCallSettings<DeleteHmacKeyRequest,Empty> deleteHmacKeySettings()

Returns the object with the settings used for calls to deleteHmacKey.

Returns
Type Description
UnaryCallSettings<DeleteHmacKeyRequest,Empty>

deleteNotificationSettings()

public UnaryCallSettings<DeleteNotificationRequest,Empty> deleteNotificationSettings()

Returns the object with the settings used for calls to deleteNotification.

Returns
Type Description
UnaryCallSettings<DeleteNotificationRequest,Empty>

deleteObjectSettings()

public UnaryCallSettings<DeleteObjectRequest,Empty> deleteObjectSettings()

Returns the object with the settings used for calls to deleteObject.

Returns
Type Description
UnaryCallSettings<DeleteObjectRequest,Empty>

getBucketSettings()

public UnaryCallSettings<GetBucketRequest,Bucket> getBucketSettings()

Returns the object with the settings used for calls to getBucket.

Returns
Type Description
UnaryCallSettings<GetBucketRequest,Bucket>

getHmacKeySettings()

public UnaryCallSettings<GetHmacKeyRequest,HmacKeyMetadata> getHmacKeySettings()

Returns the object with the settings used for calls to getHmacKey.

Returns
Type Description
UnaryCallSettings<GetHmacKeyRequest,HmacKeyMetadata>

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>

getNotificationSettings()

public UnaryCallSettings<GetNotificationRequest,Notification> getNotificationSettings()

Returns the object with the settings used for calls to getNotification.

Returns
Type Description
UnaryCallSettings<GetNotificationRequest,Notification>

getObjectSettings()

public UnaryCallSettings<GetObjectRequest,Object> getObjectSettings()

Returns the object with the settings used for calls to getObject.

Returns
Type Description
UnaryCallSettings<GetObjectRequest,Object>

getServiceAccountSettings()

public UnaryCallSettings<GetServiceAccountRequest,ServiceAccount> getServiceAccountSettings()

Returns the object with the settings used for calls to getServiceAccount.

Returns
Type Description
UnaryCallSettings<GetServiceAccountRequest,ServiceAccount>

listBucketsSettings()

public PagedCallSettings<ListBucketsRequest,ListBucketsResponse,StorageClient.ListBucketsPagedResponse> listBucketsSettings()

Returns the object with the settings used for calls to listBuckets.

Returns
Type Description
PagedCallSettings<ListBucketsRequest,ListBucketsResponse,ListBucketsPagedResponse>

listHmacKeysSettings()

public PagedCallSettings<ListHmacKeysRequest,ListHmacKeysResponse,StorageClient.ListHmacKeysPagedResponse> listHmacKeysSettings()

Returns the object with the settings used for calls to listHmacKeys.

Returns
Type Description
PagedCallSettings<ListHmacKeysRequest,ListHmacKeysResponse,ListHmacKeysPagedResponse>

listNotificationsSettings()

public PagedCallSettings<ListNotificationsRequest,ListNotificationsResponse,StorageClient.ListNotificationsPagedResponse> listNotificationsSettings()

Returns the object with the settings used for calls to listNotifications.

Returns
Type Description
PagedCallSettings<ListNotificationsRequest,ListNotificationsResponse,ListNotificationsPagedResponse>

listObjectsSettings()

public PagedCallSettings<ListObjectsRequest,ListObjectsResponse,StorageClient.ListObjectsPagedResponse> listObjectsSettings()

Returns the object with the settings used for calls to listObjects.

Returns
Type Description
PagedCallSettings<ListObjectsRequest,ListObjectsResponse,ListObjectsPagedResponse>

lockBucketRetentionPolicySettings()

public UnaryCallSettings<LockBucketRetentionPolicyRequest,Bucket> lockBucketRetentionPolicySettings()

Returns the object with the settings used for calls to lockBucketRetentionPolicy.

Returns
Type Description
UnaryCallSettings<LockBucketRetentionPolicyRequest,Bucket>

queryWriteStatusSettings()

public UnaryCallSettings<QueryWriteStatusRequest,QueryWriteStatusResponse> queryWriteStatusSettings()

Returns the object with the settings used for calls to queryWriteStatus.

Returns
Type Description
UnaryCallSettings<QueryWriteStatusRequest,QueryWriteStatusResponse>

readObjectSettings()

public ServerStreamingCallSettings<ReadObjectRequest,ReadObjectResponse> readObjectSettings()

Returns the object with the settings used for calls to readObject.

Returns
Type Description
ServerStreamingCallSettings<ReadObjectRequest,ReadObjectResponse>

rewriteObjectSettings()

public UnaryCallSettings<RewriteObjectRequest,RewriteResponse> rewriteObjectSettings()

Returns the object with the settings used for calls to rewriteObject.

Returns
Type Description
UnaryCallSettings<RewriteObjectRequest,RewriteResponse>

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.

Returns
Type Description
UnaryCallSettings<StartResumableWriteRequest,StartResumableWriteResponse>

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.

Returns
Type Description
StorageSettings.Builder
Overrides

updateBucketSettings()

public UnaryCallSettings<UpdateBucketRequest,Bucket> updateBucketSettings()

Returns the object with the settings used for calls to updateBucket.

Returns
Type Description
UnaryCallSettings<UpdateBucketRequest,Bucket>

updateHmacKeySettings()

public UnaryCallSettings<UpdateHmacKeyRequest,HmacKeyMetadata> updateHmacKeySettings()

Returns the object with the settings used for calls to updateHmacKey.

Returns
Type Description
UnaryCallSettings<UpdateHmacKeyRequest,HmacKeyMetadata>

updateObjectSettings()

public UnaryCallSettings<UpdateObjectRequest,Object> updateObjectSettings()

Returns the object with the settings used for calls to updateObject.

Returns
Type Description
UnaryCallSettings<UpdateObjectRequest,Object>

writeObjectSettings()

public StreamingCallSettings<WriteObjectRequest,WriteObjectResponse> writeObjectSettings()

Returns the object with the settings used for calls to writeObject.

Returns
Type Description
StreamingCallSettings<WriteObjectRequest,WriteObjectResponse>