com.google.storage.v2

Class StorageSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<StorageSettings>

com.google.storage.v2.StorageSettings

@Generated(value="by gapic-generator-java")
public class StorageSettings
extends com.google.api.gax.rpc.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 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()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 StorageSettings storageSettings = storageSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StorageSettings.Builder Builder for StorageSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StorageSettings(StorageSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.UnaryCallSettings<CancelResumableWriteRequest,CancelResumableWriteResponse>	cancelResumableWriteSettings() Returns the object with the settings used for calls to cancelResumableWrite.
com.google.api.gax.rpc.UnaryCallSettings<ComposeObjectRequest,Object>	composeObjectSettings() Returns the object with the settings used for calls to composeObject.
static StorageSettings	create(StorageStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreateBucketRequest,Bucket>	createBucketSettings() Returns the object with the settings used for calls to createBucket.
com.google.api.gax.rpc.UnaryCallSettings<CreateHmacKeyRequest,CreateHmacKeyResponse>	createHmacKeySettings() Returns the object with the settings used for calls to createHmacKey.
com.google.api.gax.rpc.UnaryCallSettings<CreateNotificationConfigRequest,NotificationConfig>	createNotificationConfigSettings() Returns the object with the settings used for calls to createNotificationConfig.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeleteBucketRequest,com.google.protobuf.Empty>	deleteBucketSettings() Returns the object with the settings used for calls to deleteBucket.
com.google.api.gax.rpc.UnaryCallSettings<DeleteHmacKeyRequest,com.google.protobuf.Empty>	deleteHmacKeySettings() Returns the object with the settings used for calls to deleteHmacKey.
com.google.api.gax.rpc.UnaryCallSettings<DeleteNotificationConfigRequest,com.google.protobuf.Empty>	deleteNotificationConfigSettings() Returns the object with the settings used for calls to deleteNotificationConfig.
com.google.api.gax.rpc.UnaryCallSettings<DeleteObjectRequest,com.google.protobuf.Empty>	deleteObjectSettings() Returns the object with the settings used for calls to deleteObject.
com.google.api.gax.rpc.UnaryCallSettings<GetBucketRequest,Bucket>	getBucketSettings() Returns the object with the settings used for calls to getBucket.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetHmacKeyRequest,HmacKeyMetadata>	getHmacKeySettings() Returns the object with the settings used for calls to getHmacKey.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<GetNotificationConfigRequest,NotificationConfig>	getNotificationConfigSettings() Returns the object with the settings used for calls to getNotificationConfig.
com.google.api.gax.rpc.UnaryCallSettings<GetObjectRequest,Object>	getObjectSettings() Returns the object with the settings used for calls to getObject.
com.google.api.gax.rpc.UnaryCallSettings<GetServiceAccountRequest,ServiceAccount>	getServiceAccountSettings() Returns the object with the settings used for calls to getServiceAccount.
com.google.api.gax.rpc.PagedCallSettings<ListBucketsRequest,ListBucketsResponse,StorageClient.ListBucketsPagedResponse>	listBucketsSettings() Returns the object with the settings used for calls to listBuckets.
com.google.api.gax.rpc.PagedCallSettings<ListHmacKeysRequest,ListHmacKeysResponse,StorageClient.ListHmacKeysPagedResponse>	listHmacKeysSettings() Returns the object with the settings used for calls to listHmacKeys.
com.google.api.gax.rpc.PagedCallSettings<ListNotificationConfigsRequest,ListNotificationConfigsResponse,StorageClient.ListNotificationConfigsPagedResponse>	listNotificationConfigsSettings() Returns the object with the settings used for calls to listNotificationConfigs.
com.google.api.gax.rpc.PagedCallSettings<ListObjectsRequest,ListObjectsResponse,StorageClient.ListObjectsPagedResponse>	listObjectsSettings() Returns the object with the settings used for calls to listObjects.
com.google.api.gax.rpc.UnaryCallSettings<LockBucketRetentionPolicyRequest,Bucket>	lockBucketRetentionPolicySettings() Returns the object with the settings used for calls to lockBucketRetentionPolicy.
static StorageSettings.Builder	newBuilder() Returns a new builder for this class.
static StorageSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<QueryWriteStatusRequest,QueryWriteStatusResponse>	queryWriteStatusSettings() Returns the object with the settings used for calls to queryWriteStatus.
com.google.api.gax.rpc.ServerStreamingCallSettings<ReadObjectRequest,ReadObjectResponse>	readObjectSettings() Returns the object with the settings used for calls to readObject.
com.google.api.gax.rpc.UnaryCallSettings<RewriteObjectRequest,RewriteResponse>	rewriteObjectSettings() Returns the object with the settings used for calls to rewriteObject.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<StartResumableWriteRequest,StartResumableWriteResponse>	startResumableWriteSettings() Returns the object with the settings used for calls to startResumableWrite.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
StorageSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UpdateBucketRequest,Bucket>	updateBucketSettings() Returns the object with the settings used for calls to updateBucket.
com.google.api.gax.rpc.UnaryCallSettings<UpdateHmacKeyRequest,HmacKeyMetadata>	updateHmacKeySettings() Returns the object with the settings used for calls to updateHmacKey.
com.google.api.gax.rpc.UnaryCallSettings<UpdateObjectRequest,Object>	updateObjectSettings() Returns the object with the settings used for calls to updateObject.
com.google.api.gax.rpc.StreamingCallSettings<WriteObjectRequest,WriteObjectResponse>	writeObjectSettings() Returns the object with the settings used for calls to writeObject.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StorageSettings

protected StorageSettings(StorageSettings.Builder settingsBuilder)
                   throws IOException

Throws:

IOException

Method Detail

deleteBucketSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteBucketRequest,com.google.protobuf.Empty> deleteBucketSettings()

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

getBucketSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetBucketRequest,Bucket> getBucketSettings()

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

createBucketSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateBucketRequest,Bucket> createBucketSettings()

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

listBucketsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListBucketsRequest,ListBucketsResponse,StorageClient.ListBucketsPagedResponse> listBucketsSettings()

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

lockBucketRetentionPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<LockBucketRetentionPolicyRequest,Bucket> lockBucketRetentionPolicySettings()

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

getIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()

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

setIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()

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

testIamPermissionsSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()

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

updateBucketSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateBucketRequest,Bucket> updateBucketSettings()

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

deleteNotificationConfigSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteNotificationConfigRequest,com.google.protobuf.Empty> deleteNotificationConfigSettings()

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

getNotificationConfigSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetNotificationConfigRequest,NotificationConfig> getNotificationConfigSettings()

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

createNotificationConfigSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateNotificationConfigRequest,NotificationConfig> createNotificationConfigSettings()

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

listNotificationConfigsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListNotificationConfigsRequest,ListNotificationConfigsResponse,StorageClient.ListNotificationConfigsPagedResponse> listNotificationConfigsSettings()

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

composeObjectSettings

public com.google.api.gax.rpc.UnaryCallSettings<ComposeObjectRequest,Object> composeObjectSettings()

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

deleteObjectSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteObjectRequest,com.google.protobuf.Empty> deleteObjectSettings()

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

cancelResumableWriteSettings

public com.google.api.gax.rpc.UnaryCallSettings<CancelResumableWriteRequest,CancelResumableWriteResponse> cancelResumableWriteSettings()

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

getObjectSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetObjectRequest,Object> getObjectSettings()

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

readObjectSettings

public com.google.api.gax.rpc.ServerStreamingCallSettings<ReadObjectRequest,ReadObjectResponse> readObjectSettings()

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

updateObjectSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateObjectRequest,Object> updateObjectSettings()

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

writeObjectSettings

public com.google.api.gax.rpc.StreamingCallSettings<WriteObjectRequest,WriteObjectResponse> writeObjectSettings()

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

listObjectsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListObjectsRequest,ListObjectsResponse,StorageClient.ListObjectsPagedResponse> listObjectsSettings()

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

rewriteObjectSettings

public com.google.api.gax.rpc.UnaryCallSettings<RewriteObjectRequest,RewriteResponse> rewriteObjectSettings()

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

startResumableWriteSettings

public com.google.api.gax.rpc.UnaryCallSettings<StartResumableWriteRequest,StartResumableWriteResponse> startResumableWriteSettings()

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

queryWriteStatusSettings

public com.google.api.gax.rpc.UnaryCallSettings<QueryWriteStatusRequest,QueryWriteStatusResponse> queryWriteStatusSettings()

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

getServiceAccountSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetServiceAccountRequest,ServiceAccount> getServiceAccountSettings()

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

createHmacKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateHmacKeyRequest,CreateHmacKeyResponse> createHmacKeySettings()

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

deleteHmacKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteHmacKeyRequest,com.google.protobuf.Empty> deleteHmacKeySettings()

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

getHmacKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<GetHmacKeyRequest,HmacKeyMetadata> getHmacKeySettings()

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

listHmacKeysSettings

public com.google.api.gax.rpc.PagedCallSettings<ListHmacKeysRequest,ListHmacKeysResponse,StorageClient.ListHmacKeysPagedResponse> listHmacKeysSettings()

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

updateHmacKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateHmacKeyRequest,HmacKeyMetadata> updateHmacKeySettings()

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

create

public static final StorageSettings create(StorageStubSettings stub)
                                    throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static StorageSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static StorageSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public StorageSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<StorageSettings>