Class SecretManagerServiceStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<SecretManagerServiceStubSettings>
com.google.cloud.secretmanager.v1beta2.stub.SecretManagerServiceStubSettings
@BetaApi
@Generated("by gapic-generator-java")
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 [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of createSecret:
// 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
SecretManagerServiceStubSettings.Builder secretManagerServiceSettingsBuilder =
SecretManagerServiceStubSettings.newBuilder();
secretManagerServiceSettingsBuilder
.createSecretSettings()
.setRetrySettings(
secretManagerServiceSettingsBuilder
.createSecretSettings()
.getRetrySettings()
.toBuilder()
.setInitialRetryDelayDuration(Duration.ofSeconds(1))
.setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
.setMaxAttempts(5)
.setMaxRetryDelayDuration(Duration.ofSeconds(30))
.setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
.setRetryDelayMultiplier(1.3)
.setRpcTimeoutMultiplier(1.5)
.setTotalTimeoutDuration(Duration.ofSeconds(300))
.build());
SecretManagerServiceStubSettings secretManagerServiceSettings =
secretManagerServiceSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
retries.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for SecretManagerServiceStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedSecretManagerServiceStubSettings(SecretManagerServiceStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to accessSecretVersion.Returns the object with the settings used for calls to addSecretVersion.Returns the object with the settings used for calls to createSecret.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderUnaryCallSettings<DeleteSecretRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteSecret.Returns the object with the settings used for calls to destroySecretVersion.Returns the object with the settings used for calls to disableSecretVersion.Returns the object with the settings used for calls to enableSecretVersion.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getIamPolicy.protected LibraryMetadataReturns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getSecret.Returns the object with the settings used for calls to getSecretVersion.Returns the default service name.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, SecretManagerServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListSecretsRequest,ListSecretsResponse, SecretManagerServiceClient.ListSecretsPagedResponse> Returns the object with the settings used for calls to listSecrets.PagedCallSettings<ListSecretVersionsRequest,ListSecretVersionsResponse, SecretManagerServiceClient.ListSecretVersionsPagedResponse> Returns the object with the settings used for calls to listSecretVersions.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateSecret.Methods inherited from class com.google.api.gax.rpc.StubSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString
-
Constructor Details
-
SecretManagerServiceStubSettings
protected SecretManagerServiceStubSettings(SecretManagerServiceStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listSecretsSettings
public PagedCallSettings<ListSecretsRequest,ListSecretsResponse, listSecretsSettings()SecretManagerServiceClient.ListSecretsPagedResponse> Returns the object with the settings used for calls to listSecrets. -
createSecretSettings
Returns the object with the settings used for calls to createSecret. -
addSecretVersionSettings
Returns the object with the settings used for calls to addSecretVersion. -
getSecretSettings
Returns the object with the settings used for calls to getSecret. -
updateSecretSettings
Returns the object with the settings used for calls to updateSecret. -
deleteSecretSettings
Returns the object with the settings used for calls to deleteSecret. -
listSecretVersionsSettings
public PagedCallSettings<ListSecretVersionsRequest,ListSecretVersionsResponse, listSecretVersionsSettings()SecretManagerServiceClient.ListSecretVersionsPagedResponse> Returns the object with the settings used for calls to listSecretVersions. -
getSecretVersionSettings
Returns the object with the settings used for calls to getSecretVersion. -
accessSecretVersionSettings
public UnaryCallSettings<AccessSecretVersionRequest,AccessSecretVersionResponse> accessSecretVersionSettings()Returns the object with the settings used for calls to accessSecretVersion. -
disableSecretVersionSettings
Returns the object with the settings used for calls to disableSecretVersion. -
enableSecretVersionSettings
Returns the object with the settings used for calls to enableSecretVersion. -
destroySecretVersionSettings
Returns the object with the settings used for calls to destroySecretVersion. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()SecretManagerServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<SecretManagerServiceStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultGrpcApiClientHeaderProviderBuilder
-
defaultHttpJsonApiClientHeaderProviderBuilder
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classStubSettings<SecretManagerServiceStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<SecretManagerServiceStubSettings>
-