Class SecretManagerServiceStubSettings (2.14.0)

public class SecretManagerServiceStubSettings extends StubSettings<SecretManagerServiceStubSettings>

Settings class to configure an instance of SecretManagerServiceStub.

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:


 SecretManagerServiceStubSettings.Builder secretManagerServiceSettingsBuilder =
     SecretManagerServiceStubSettings.newBuilder();
 secretManagerServiceSettingsBuilder
     .createSecretSettings()
     .setRetrySettings(
         secretManagerServiceSettingsBuilder
             .createSecretSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 SecretManagerServiceStubSettings secretManagerServiceSettings =
     secretManagerServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > SecretManagerServiceStubSettings

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

Returns a new builder for this class.

newBuilder(ClientContext clientContext)

public static SecretManagerServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext

Constructors

SecretManagerServiceStubSettings(SecretManagerServiceStubSettings.Builder settingsBuilder)

protected SecretManagerServiceStubSettings(SecretManagerServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderSecretManagerServiceStubSettings.Builder

Methods

accessSecretVersionSettings()

public UnaryCallSettings<AccessSecretVersionRequest,AccessSecretVersionResponse> accessSecretVersionSettings()

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

addSecretVersionSettings()

public UnaryCallSettings<AddSecretVersionRequest,SecretVersion> addSecretVersionSettings()

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

createSecretSettings()

public UnaryCallSettings<CreateSecretRequest,Secret> createSecretSettings()

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

createStub()

public SecretManagerServiceStub createStub()
Returns
TypeDescription
SecretManagerServiceStub
Exceptions
TypeDescription
IOException

deleteSecretSettings()

public UnaryCallSettings<DeleteSecretRequest,Empty> deleteSecretSettings()

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

destroySecretVersionSettings()

public UnaryCallSettings<DestroySecretVersionRequest,SecretVersion> destroySecretVersionSettings()

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

disableSecretVersionSettings()

public UnaryCallSettings<DisableSecretVersionRequest,SecretVersion> disableSecretVersionSettings()

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

enableSecretVersionSettings()

public UnaryCallSettings<EnableSecretVersionRequest,SecretVersion> enableSecretVersionSettings()

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

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.

getSecretVersionSettings()

public UnaryCallSettings<GetSecretVersionRequest,SecretVersion> getSecretVersionSettings()

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

listSecretVersionsSettings()

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

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

listSecretsSettings()

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

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

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

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

Overrides

updateSecretSettings()

public UnaryCallSettings<UpdateSecretRequest,Secret> updateSecretSettings()

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