Class SecretManagerServiceSettings (2.7.0)

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:


 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

Static Methods

create(SecretManagerServiceStubSettings stub)

public static final SecretManagerServiceSettings create(SecretManagerServiceStubSettings stub)
Parameter
NameDescription
stubSecretManagerServiceStubSettings
Returns
TypeDescription
SecretManagerServiceSettings
Exceptions
TypeDescription
IOException

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

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static SecretManagerServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
SecretManagerServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static SecretManagerServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
SecretManagerServiceSettings.Builder

Constructors

SecretManagerServiceSettings(SecretManagerServiceSettings.Builder settingsBuilder)

protected SecretManagerServiceSettings(SecretManagerServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderSecretManagerServiceSettings.Builder

Methods

accessSecretVersionSettings()

public UnaryCallSettings<AccessSecretVersionRequest,AccessSecretVersionResponse> accessSecretVersionSettings()

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

Returns
TypeDescription
UnaryCallSettings<AccessSecretVersionRequest,AccessSecretVersionResponse>

addSecretVersionSettings()

public UnaryCallSettings<AddSecretVersionRequest,SecretVersion> addSecretVersionSettings()

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

Returns
TypeDescription
UnaryCallSettings<AddSecretVersionRequest,SecretVersion>

createSecretSettings()

public UnaryCallSettings<CreateSecretRequest,Secret> createSecretSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateSecretRequest,Secret>

deleteSecretSettings()

public UnaryCallSettings<DeleteSecretRequest,Empty> deleteSecretSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteSecretRequest,Empty>

destroySecretVersionSettings()

public UnaryCallSettings<DestroySecretVersionRequest,SecretVersion> destroySecretVersionSettings()

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

Returns
TypeDescription
UnaryCallSettings<DestroySecretVersionRequest,SecretVersion>

disableSecretVersionSettings()

public UnaryCallSettings<DisableSecretVersionRequest,SecretVersion> disableSecretVersionSettings()

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

Returns
TypeDescription
UnaryCallSettings<DisableSecretVersionRequest,SecretVersion>

enableSecretVersionSettings()

public UnaryCallSettings<EnableSecretVersionRequest,SecretVersion> enableSecretVersionSettings()

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

Returns
TypeDescription
UnaryCallSettings<EnableSecretVersionRequest,SecretVersion>

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>

getSecretSettings()

public UnaryCallSettings<GetSecretRequest,Secret> getSecretSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetSecretRequest,Secret>

getSecretVersionSettings()

public UnaryCallSettings<GetSecretVersionRequest,SecretVersion> getSecretVersionSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetSecretVersionRequest,SecretVersion>

listSecretVersionsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListSecretVersionsRequest,ListSecretVersionsResponse,ListSecretVersionsPagedResponse>

listSecretsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListSecretsRequest,ListSecretsResponse,ListSecretsPagedResponse>

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>

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

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

Returns
TypeDescription
SecretManagerServiceSettings.Builder
Overrides

updateSecretSettings()

public UnaryCallSettings<UpdateSecretRequest,Secret> updateSecretSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateSecretRequest,Secret>