public class StorageStubSettings extends StubSettings<StorageStubSettings>Settings class to configure an instance of StorageStub.
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
StorageStubSettings.Builder storageSettingsBuilder = StorageStubSettings.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());
StorageStubSettings storageSettings = storageSettingsBuilder.build();
Please refer to the Client Side Retry Guide for additional support in setting retries.
Static Methods
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 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 |
|
getDefaultMtlsEndpoint()
public static String getDefaultMtlsEndpoint()Returns the default mTLS 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 StorageStubSettings.Builder newBuilder()Returns a new builder for this class.
| Returns | |
|---|---|
| Type | Description |
StorageStubSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static StorageStubSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
StorageStubSettings.Builder |
|
Constructors
StorageStubSettings(StorageStubSettings.Builder settingsBuilder)
protected StorageStubSettings(StorageStubSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
StorageStubSettings.Builder |
Methods
bidiWriteObjectSettings()
public StreamingCallSettings<BidiWriteObjectRequest,BidiWriteObjectResponse> bidiWriteObjectSettings()Returns the object with the settings used for calls to bidiWriteObject.
| Returns | |
|---|---|
| Type | Description |
StreamingCallSettings<BidiWriteObjectRequest,BidiWriteObjectResponse> |
|
cancelResumableWriteSettings()
public UnaryCallSettings<CancelResumableWriteRequest,CancelResumableWriteResponse> cancelResumableWriteSettings()Returns the object with the settings used for calls to cancelResumableWrite.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CancelResumableWriteRequest,CancelResumableWriteResponse> |
|
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() (deprecated)
public UnaryCallSettings<CreateHmacKeyRequest,CreateHmacKeyResponse> createHmacKeySettings()Deprecated. This method is deprecated and will be removed in the next major version update.
Returns the object with the settings used for calls to createHmacKey.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateHmacKeyRequest,CreateHmacKeyResponse> |
|
createNotificationConfigSettings() (deprecated)
public UnaryCallSettings<CreateNotificationConfigRequest,NotificationConfig> createNotificationConfigSettings()Deprecated. This method is deprecated and will be removed in the next major version update.
Returns the object with the settings used for calls to createNotificationConfig.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateNotificationConfigRequest,NotificationConfig> |
|
createStub()
public StorageStub createStub()| Returns | |
|---|---|
| Type | Description |
StorageStub |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
deleteBucketSettings()
public UnaryCallSettings<DeleteBucketRequest,Empty> deleteBucketSettings()Returns the object with the settings used for calls to deleteBucket.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteBucketRequest,Empty> |
|
deleteHmacKeySettings() (deprecated)
public UnaryCallSettings<DeleteHmacKeyRequest,Empty> deleteHmacKeySettings()Deprecated. This method is deprecated and will be removed in the next major version update.
Returns the object with the settings used for calls to deleteHmacKey.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteHmacKeyRequest,Empty> |
|
deleteNotificationConfigSettings() (deprecated)
public UnaryCallSettings<DeleteNotificationConfigRequest,Empty> deleteNotificationConfigSettings()Deprecated. This method is deprecated and will be removed in the next major version update.
Returns the object with the settings used for calls to deleteNotificationConfig.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteNotificationConfigRequest,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() (deprecated)
public UnaryCallSettings<GetHmacKeyRequest,HmacKeyMetadata> getHmacKeySettings()Deprecated. This method is deprecated and will be removed in the next major version update.
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> |
|
getNotificationConfigSettings() (deprecated)
public UnaryCallSettings<GetNotificationConfigRequest,NotificationConfig> getNotificationConfigSettings()Deprecated. This method is deprecated and will be removed in the next major version update.
Returns the object with the settings used for calls to getNotificationConfig.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetNotificationConfigRequest,NotificationConfig> |
|
getObjectSettings()
public UnaryCallSettings<GetObjectRequest,Object> getObjectSettings()Returns the object with the settings used for calls to getObject.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetObjectRequest,Object> |
|
getServiceAccountSettings() (deprecated)
public UnaryCallSettings<GetServiceAccountRequest,ServiceAccount> getServiceAccountSettings()Deprecated. This method is deprecated and will be removed in the next major version update.
Returns the object with the settings used for calls to getServiceAccount.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetServiceAccountRequest,ServiceAccount> |
|
getServiceName()
public String getServiceName()Returns the default service name.
| Returns | |
|---|---|
| Type | Description |
String |
|
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() (deprecated)
public PagedCallSettings<ListHmacKeysRequest,ListHmacKeysResponse,StorageClient.ListHmacKeysPagedResponse> listHmacKeysSettings()Deprecated. This method is deprecated and will be removed in the next major version update.
Returns the object with the settings used for calls to listHmacKeys.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListHmacKeysRequest,ListHmacKeysResponse,ListHmacKeysPagedResponse> |
|
listNotificationConfigsSettings() (deprecated)
public PagedCallSettings<ListNotificationConfigsRequest,ListNotificationConfigsResponse,StorageClient.ListNotificationConfigsPagedResponse> listNotificationConfigsSettings()Deprecated. This method is deprecated and will be removed in the next major version update.
Returns the object with the settings used for calls to listNotificationConfigs.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListNotificationConfigsRequest,ListNotificationConfigsResponse,ListNotificationConfigsPagedResponse> |
|
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> |
|
restoreObjectSettings()
public UnaryCallSettings<RestoreObjectRequest,Object> restoreObjectSettings()Returns the object with the settings used for calls to restoreObject.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<RestoreObjectRequest,Object> |
|
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 StorageStubSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
StorageStubSettings.Builder |
|
updateBucketSettings()
public UnaryCallSettings<UpdateBucketRequest,Bucket> updateBucketSettings()Returns the object with the settings used for calls to updateBucket.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateBucketRequest,Bucket> |
|
updateHmacKeySettings() (deprecated)
public UnaryCallSettings<UpdateHmacKeyRequest,HmacKeyMetadata> updateHmacKeySettings()Deprecated. This method is deprecated and will be removed in the next major version update.
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> |
|