Class StorageStubSettings (2.20.1)

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();
 

Inheritance

java.lang.Object > StubSettings > StorageStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static StorageStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
StorageStubSettings.Builder

newBuilder(ClientContext clientContext)

public static StorageStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
StorageStubSettings.Builder

Constructors

StorageStubSettings(StorageStubSettings.Builder settingsBuilder)

protected StorageStubSettings(StorageStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderStorageStubSettings.Builder

Methods

cancelResumableWriteSettings()

public UnaryCallSettings<CancelResumableWriteRequest,CancelResumableWriteResponse> cancelResumableWriteSettings()

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

Returns
TypeDescription
UnaryCallSettings<CancelResumableWriteRequest,CancelResumableWriteResponse>

composeObjectSettings()

public UnaryCallSettings<ComposeObjectRequest,Object> composeObjectSettings()

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

Returns
TypeDescription
UnaryCallSettings<ComposeObjectRequest,Object>

createBucketSettings()

public UnaryCallSettings<CreateBucketRequest,Bucket> createBucketSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateBucketRequest,Bucket>

createHmacKeySettings()

public UnaryCallSettings<CreateHmacKeyRequest,CreateHmacKeyResponse> createHmacKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateHmacKeyRequest,CreateHmacKeyResponse>

createNotificationConfigSettings()

public UnaryCallSettings<CreateNotificationConfigRequest,NotificationConfig> createNotificationConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateNotificationConfigRequest,NotificationConfig>

createStub()

public StorageStub createStub()
Returns
TypeDescription
StorageStub
Exceptions
TypeDescription
IOException

deleteBucketSettings()

public UnaryCallSettings<DeleteBucketRequest,Empty> deleteBucketSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteBucketRequest,Empty>

deleteHmacKeySettings()

public UnaryCallSettings<DeleteHmacKeyRequest,Empty> deleteHmacKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteHmacKeyRequest,Empty>

deleteNotificationConfigSettings()

public UnaryCallSettings<DeleteNotificationConfigRequest,Empty> deleteNotificationConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteNotificationConfigRequest,Empty>

deleteObjectSettings()

public UnaryCallSettings<DeleteObjectRequest,Empty> deleteObjectSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteObjectRequest,Empty>

getBucketSettings()

public UnaryCallSettings<GetBucketRequest,Bucket> getBucketSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetBucketRequest,Bucket>

getHmacKeySettings()

public UnaryCallSettings<GetHmacKeyRequest,HmacKeyMetadata> getHmacKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<GetHmacKeyRequest,HmacKeyMetadata>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getNotificationConfigSettings()

public UnaryCallSettings<GetNotificationConfigRequest,NotificationConfig> getNotificationConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetNotificationConfigRequest,NotificationConfig>

getObjectSettings()

public UnaryCallSettings<GetObjectRequest,Object> getObjectSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetObjectRequest,Object>

getServiceAccountSettings()

public UnaryCallSettings<GetServiceAccountRequest,ServiceAccount> getServiceAccountSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetServiceAccountRequest,ServiceAccount>

listBucketsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListBucketsRequest,ListBucketsResponse,ListBucketsPagedResponse>

listHmacKeysSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListHmacKeysRequest,ListHmacKeysResponse,ListHmacKeysPagedResponse>

listNotificationConfigsSettings()

public PagedCallSettings<ListNotificationConfigsRequest,ListNotificationConfigsResponse,StorageClient.ListNotificationConfigsPagedResponse> listNotificationConfigsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListNotificationConfigsRequest,ListNotificationConfigsResponse,ListNotificationConfigsPagedResponse>

listObjectsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListObjectsRequest,ListObjectsResponse,ListObjectsPagedResponse>

lockBucketRetentionPolicySettings()

public UnaryCallSettings<LockBucketRetentionPolicyRequest,Bucket> lockBucketRetentionPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<LockBucketRetentionPolicyRequest,Bucket>

queryWriteStatusSettings()

public UnaryCallSettings<QueryWriteStatusRequest,QueryWriteStatusResponse> queryWriteStatusSettings()

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

Returns
TypeDescription
UnaryCallSettings<QueryWriteStatusRequest,QueryWriteStatusResponse>

readObjectSettings()

public ServerStreamingCallSettings<ReadObjectRequest,ReadObjectResponse> readObjectSettings()

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

Returns
TypeDescription
ServerStreamingCallSettings<ReadObjectRequest,ReadObjectResponse>

rewriteObjectSettings()

public UnaryCallSettings<RewriteObjectRequest,RewriteResponse> rewriteObjectSettings()

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

Returns
TypeDescription
UnaryCallSettings<RewriteObjectRequest,RewriteResponse>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
TypeDescription
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
TypeDescription
UnaryCallSettings<StartResumableWriteRequest,StartResumableWriteResponse>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
TypeDescription
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
TypeDescription
StorageStubSettings.Builder
Overrides

updateBucketSettings()

public UnaryCallSettings<UpdateBucketRequest,Bucket> updateBucketSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateBucketRequest,Bucket>

updateHmacKeySettings()

public UnaryCallSettings<UpdateHmacKeyRequest,HmacKeyMetadata> updateHmacKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateHmacKeyRequest,HmacKeyMetadata>

updateObjectSettings()

public UnaryCallSettings<UpdateObjectRequest,Object> updateObjectSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateObjectRequest,Object>

writeObjectSettings()

public StreamingCallSettings<WriteObjectRequest,WriteObjectResponse> writeObjectSettings()

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

Returns
TypeDescription
StreamingCallSettings<WriteObjectRequest,WriteObjectResponse>