Class SecretManagerServiceSettings (2.47.0)

Version 2.47.0

• 2.53.0 (latest)
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.10
• 2.2.0
• 2.1.7
• 2.0.7

public class SecretManagerServiceSettings extends ClientSettings<SecretManagerServiceSettings>

Settings class to configure an instance of SecretManagerServiceClient.

The default instance has everything set to sensible defaults:

• The default service address (secretmanager.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 createSecret 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
 SecretManagerServiceSettings.Builder secretManagerServiceSettingsBuilder =
     SecretManagerServiceSettings.newBuilder();
 secretManagerServiceSettingsBuilder
     .createSecretSettings()
     .setRetrySettings(
         secretManagerServiceSettingsBuilder
             .createSecretSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 SecretManagerServiceSettings secretManagerServiceSettings =
     secretManagerServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > SecretManagerServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogCheckIntervalDuration()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(SecretManagerServiceStubSettings stub)

public static final SecretManagerServiceSettings create(SecretManagerServiceStubSettings stub)

Parameter
Name	Description
stub	SecretManagerServiceStubSettings

Returns
Type	Description
SecretManagerServiceSettings

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

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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 SecretManagerServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
SecretManagerServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static SecretManagerServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
SecretManagerServiceSettings.Builder

newHttpJsonBuilder()

public static SecretManagerServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
SecretManagerServiceSettings.Builder

Constructors

SecretManagerServiceSettings(SecretManagerServiceSettings.Builder settingsBuilder)

protected SecretManagerServiceSettings(SecretManagerServiceSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	SecretManagerServiceSettings.Builder

Methods

accessSecretVersionSettings()

public UnaryCallSettings<AccessSecretVersionRequest,AccessSecretVersionResponse> accessSecretVersionSettings()

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

Returns
Type	Description
UnaryCallSettings<AccessSecretVersionRequest,AccessSecretVersionResponse>

addSecretVersionSettings()

public UnaryCallSettings<AddSecretVersionRequest,SecretVersion> addSecretVersionSettings()

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

Returns
Type	Description
UnaryCallSettings<AddSecretVersionRequest,SecretVersion>

createSecretSettings()

public UnaryCallSettings<CreateSecretRequest,Secret> createSecretSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateSecretRequest,Secret>

deleteSecretSettings()

public UnaryCallSettings<DeleteSecretRequest,Empty> deleteSecretSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteSecretRequest,Empty>

destroySecretVersionSettings()

public UnaryCallSettings<DestroySecretVersionRequest,SecretVersion> destroySecretVersionSettings()

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

Returns
Type	Description
UnaryCallSettings<DestroySecretVersionRequest,SecretVersion>

disableSecretVersionSettings()

public UnaryCallSettings<DisableSecretVersionRequest,SecretVersion> disableSecretVersionSettings()

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

Returns
Type	Description
UnaryCallSettings<DisableSecretVersionRequest,SecretVersion>

enableSecretVersionSettings()

public UnaryCallSettings<EnableSecretVersionRequest,SecretVersion> enableSecretVersionSettings()

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

Returns
Type	Description
UnaryCallSettings<EnableSecretVersionRequest,SecretVersion>

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>

getSecretSettings()

public UnaryCallSettings<GetSecretRequest,Secret> getSecretSettings()

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

Returns
Type	Description
UnaryCallSettings<GetSecretRequest,Secret>

getSecretVersionSettings()

public UnaryCallSettings<GetSecretVersionRequest,SecretVersion> getSecretVersionSettings()

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

Returns
Type	Description
UnaryCallSettings<GetSecretVersionRequest,SecretVersion>

listSecretVersionsSettings()

public PagedCallSettings<ListSecretVersionsRequest,ListSecretVersionsResponse,SecretManagerServiceClient.ListSecretVersionsPagedResponse> listSecretVersionsSettings()

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

Returns
Type	Description
PagedCallSettings<ListSecretVersionsRequest,ListSecretVersionsResponse,ListSecretVersionsPagedResponse>

listSecretsSettings()

public PagedCallSettings<ListSecretsRequest,ListSecretsResponse,SecretManagerServiceClient.ListSecretsPagedResponse> listSecretsSettings()

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

Returns
Type	Description
PagedCallSettings<ListSecretsRequest,ListSecretsResponse,ListSecretsPagedResponse>

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>

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 SecretManagerServiceSettings.Builder toBuilder()

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

Returns
Type	Description
SecretManagerServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateSecretSettings()

public UnaryCallSettings<UpdateSecretRequest,Secret> updateSecretSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateSecretRequest,Secret>