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 total timeout of deleteBucket to 30 seconds:
// 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()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
StorageStubSettings storageSettings = storageSettingsBuilder.build();
Static Methods
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.
Returns
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.
Returns
public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.
Returns
public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.
Returns
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()
Returns
getDefaultEndpoint()
public static String getDefaultEndpoint()
Returns the default service endpoint.
Returns
getDefaultMtlsEndpoint()
public static String getDefaultMtlsEndpoint()
Returns the default mTLS service endpoint.
Returns
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()
Returns the default service scopes.
Returns
newBuilder()
public static StorageStubSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
Returns
newBuilder(ClientContext clientContext)
public static StorageStubSettings.Builder newBuilder(ClientContext clientContext)
Returns a new builder for this class.
Parameter
Returns
newHttpJsonBuilder()
public static StorageStubSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
Returns
Constructors
StorageStubSettings(StorageStubSettings.Builder settingsBuilder)
protected StorageStubSettings(StorageStubSettings.Builder settingsBuilder)
Parameter
Methods
cancelResumableWriteSettings()
public UnaryCallSettings<CancelResumableWriteRequest,CancelResumableWriteResponse> cancelResumableWriteSettings()
Returns the object with the settings used for calls to cancelResumableWrite.
Returns
composeObjectSettings()
public UnaryCallSettings<ComposeObjectRequest,Object> composeObjectSettings()
Returns the object with the settings used for calls to composeObject.
Returns
createBucketSettings()
public UnaryCallSettings<CreateBucketRequest,Bucket> createBucketSettings()
Returns the object with the settings used for calls to createBucket.
Returns
createHmacKeySettings()
public UnaryCallSettings<CreateHmacKeyRequest,CreateHmacKeyResponse> createHmacKeySettings()
Returns the object with the settings used for calls to createHmacKey.
Returns
createNotificationSettings()
public UnaryCallSettings<CreateNotificationRequest,Notification> createNotificationSettings()
Returns the object with the settings used for calls to createNotification.
Returns
createStub()
public StorageStub createStub()
Returns
Exceptions
deleteBucketSettings()
public UnaryCallSettings<DeleteBucketRequest,Empty> deleteBucketSettings()
Returns the object with the settings used for calls to deleteBucket.
Returns
deleteHmacKeySettings()
public UnaryCallSettings<DeleteHmacKeyRequest,Empty> deleteHmacKeySettings()
Returns the object with the settings used for calls to deleteHmacKey.
Returns
deleteNotificationSettings()
public UnaryCallSettings<DeleteNotificationRequest,Empty> deleteNotificationSettings()
Returns the object with the settings used for calls to deleteNotification.
Returns
deleteObjectSettings()
public UnaryCallSettings<DeleteObjectRequest,Empty> deleteObjectSettings()
Returns the object with the settings used for calls to deleteObject.
Returns
getBucketSettings()
public UnaryCallSettings<GetBucketRequest,Bucket> getBucketSettings()
Returns the object with the settings used for calls to getBucket.
Returns
getHmacKeySettings()
public UnaryCallSettings<GetHmacKeyRequest,HmacKeyMetadata> getHmacKeySettings()
Returns the object with the settings used for calls to getHmacKey.
Returns
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
getObjectSettings()
public UnaryCallSettings<GetObjectRequest,Object> getObjectSettings()
Returns the object with the settings used for calls to getObject.
Returns
getServiceAccountSettings()
public UnaryCallSettings<GetServiceAccountRequest,ServiceAccount> getServiceAccountSettings()
Returns the object with the settings used for calls to getServiceAccount.
Returns
listBucketsSettings()
public PagedCallSettings<ListBucketsRequest,ListBucketsResponse,StorageClient.ListBucketsPagedResponse> listBucketsSettings()
Returns the object with the settings used for calls to listBuckets.
Returns
listHmacKeysSettings()
public PagedCallSettings<ListHmacKeysRequest,ListHmacKeysResponse,StorageClient.ListHmacKeysPagedResponse> listHmacKeysSettings()
Returns the object with the settings used for calls to listHmacKeys.
Returns
listNotificationsSettings()
public PagedCallSettings<ListNotificationsRequest,ListNotificationsResponse,StorageClient.ListNotificationsPagedResponse> listNotificationsSettings()
Returns the object with the settings used for calls to listNotifications.
Returns
listObjectsSettings()
public PagedCallSettings<ListObjectsRequest,ListObjectsResponse,StorageClient.ListObjectsPagedResponse> listObjectsSettings()
Returns the object with the settings used for calls to listObjects.
Returns
lockBucketRetentionPolicySettings()
public UnaryCallSettings<LockBucketRetentionPolicyRequest,Bucket> lockBucketRetentionPolicySettings()
Returns the object with the settings used for calls to lockBucketRetentionPolicy.
Returns
queryWriteStatusSettings()
public UnaryCallSettings<QueryWriteStatusRequest,QueryWriteStatusResponse> queryWriteStatusSettings()
Returns the object with the settings used for calls to queryWriteStatus.
Returns
readObjectSettings()
public ServerStreamingCallSettings<ReadObjectRequest,ReadObjectResponse> readObjectSettings()
Returns the object with the settings used for calls to readObject.
Returns
rewriteObjectSettings()
public UnaryCallSettings<RewriteObjectRequest,RewriteResponse> rewriteObjectSettings()
Returns the object with the settings used for calls to rewriteObject.
Returns
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
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
Overrides
updateBucketSettings()
public UnaryCallSettings<UpdateBucketRequest,Bucket> updateBucketSettings()
Returns the object with the settings used for calls to updateBucket.
Returns
updateHmacKeySettings()
public UnaryCallSettings<UpdateHmacKeyRequest,HmacKeyMetadata> updateHmacKeySettings()
Returns the object with the settings used for calls to updateHmacKey.
Returns
updateObjectSettings()
public UnaryCallSettings<UpdateObjectRequest,Object> updateObjectSettings()
Returns the object with the settings used for calls to updateObject.
Returns
writeObjectSettings()
public StreamingCallSettings<WriteObjectRequest,WriteObjectResponse> writeObjectSettings()
Returns the object with the settings used for calls to writeObject.
Returns