Class SecretManagerServiceGrpc.SecretManagerServiceFutureStub (2.76.0)
public static final class SecretManagerServiceGrpc.SecretManagerServiceFutureStub extends AbstractFutureStub<SecretManagerServiceGrpc.SecretManagerServiceFutureStub>
A stub to allow clients to do ListenableFuture-style rpc calls to service SecretManagerService.
Secret Manager Service
Manages secrets and operations using those secrets. Implements a REST
model with the following objects:
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractFutureStub >
SecretManagerServiceGrpc.SecretManagerServiceFutureStub
Inherited Members
io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.getCallOptions()
io.grpc.stub.AbstractStub.getChannel()
io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)
io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)
io.grpc.stub.AbstractStub.withCompression(java.lang.String)
io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)
io.grpc.stub.AbstractStub.withDeadlineAfter(java.time.Duration)
io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)
io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)
io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)
io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)
io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)
io.grpc.stub.AbstractStub.withOnReadyThreshold(int)
io.grpc.stub.AbstractStub.withWaitForReady()
Methods
accessSecretVersion(AccessSecretVersionRequest request)
public ListenableFuture<AccessSecretVersionResponse> accessSecretVersion(AccessSecretVersionRequest request)
Accesses a SecretVersion.
This call returns the secret data.
projects/*/secrets/*/versions/latest
is an alias to the most recently
created SecretVersion.
addSecretVersion(AddSecretVersionRequest request)
public ListenableFuture<SecretVersion> addSecretVersion(AddSecretVersionRequest request)
Creates a new SecretVersion
containing secret data and attaches it to an existing
Secret.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<SecretVersion> |
|
build(Channel channel, CallOptions callOptions)
protected SecretManagerServiceGrpc.SecretManagerServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters |
Name |
Description |
channel |
io.grpc.Channel
|
callOptions |
io.grpc.CallOptions
|
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
createSecret(CreateSecretRequest request)
public ListenableFuture<Secret> createSecret(CreateSecretRequest request)
Creates a new Secret containing no
SecretVersions.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Secret> |
|
deleteSecret(DeleteSecretRequest request)
public ListenableFuture<Empty> deleteSecret(DeleteSecretRequest request)
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Empty> |
|
destroySecretVersion(DestroySecretVersionRequest request)
public ListenableFuture<SecretVersion> destroySecretVersion(DestroySecretVersionRequest request)
Destroys a SecretVersion.
Sets the state of the
SecretVersion to
DESTROYED
and irrevocably destroys the secret data.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<SecretVersion> |
|
disableSecretVersion(DisableSecretVersionRequest request)
public ListenableFuture<SecretVersion> disableSecretVersion(DisableSecretVersionRequest request)
Disables a SecretVersion.
Sets the state of the
SecretVersion to
DISABLED.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<SecretVersion> |
|
enableSecretVersion(EnableSecretVersionRequest request)
public ListenableFuture<SecretVersion> enableSecretVersion(EnableSecretVersionRequest request)
Enables a SecretVersion.
Sets the state of the
SecretVersion to
ENABLED.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<SecretVersion> |
|
getIamPolicy(GetIamPolicyRequest request)
public ListenableFuture<Policy> getIamPolicy(GetIamPolicyRequest request)
Gets the access control policy for a secret.
Returns empty policy if the secret exists and does not have a policy set.
Parameter |
Name |
Description |
request |
com.google.iam.v1.GetIamPolicyRequest
|
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy> |
|
getSecret(GetSecretRequest request)
public ListenableFuture<Secret> getSecret(GetSecretRequest request)
Gets metadata for a given Secret.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Secret> |
|
getSecretVersion(GetSecretVersionRequest request)
public ListenableFuture<SecretVersion> getSecretVersion(GetSecretVersionRequest request)
Gets metadata for a
SecretVersion.
projects/*/secrets/*/versions/latest
is an alias to the most recently
created SecretVersion.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<SecretVersion> |
|
listSecretVersions(ListSecretVersionsRequest request)
public ListenableFuture<ListSecretVersionsResponse> listSecretVersions(ListSecretVersionsRequest request)
Lists SecretVersions. This
call does not return secret data.
listSecrets(ListSecretsRequest request)
public ListenableFuture<ListSecretsResponse> listSecrets(ListSecretsRequest request)
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<ListSecretsResponse> |
|
setIamPolicy(SetIamPolicyRequest request)
public ListenableFuture<Policy> setIamPolicy(SetIamPolicyRequest request)
Sets the access control policy on the specified secret. Replaces any
existing policy.
Permissions on
SecretVersions are enforced
according to the policy set on the associated
Secret.
Parameter |
Name |
Description |
request |
com.google.iam.v1.SetIamPolicyRequest
|
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy> |
|
testIamPermissions(TestIamPermissionsRequest request)
public ListenableFuture<TestIamPermissionsResponse> testIamPermissions(TestIamPermissionsRequest request)
Returns permissions that a caller has for the specified secret.
If the secret does not exist, this call returns an empty set of
permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware
UIs and command-line tools, not for authorization checking. This operation
may "fail open" without warning.
Parameter |
Name |
Description |
request |
com.google.iam.v1.TestIamPermissionsRequest
|
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.TestIamPermissionsResponse> |
|
updateSecret(UpdateSecretRequest request)
public ListenableFuture<Secret> updateSecret(UpdateSecretRequest request)
Updates metadata of an existing
Secret.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Secret> |
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-11 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-11 UTC."],[],[]]