Class SecretManagerServiceGrpc.SecretManagerServiceFutureStub (2.3.0)

public static final class SecretManagerServiceGrpc.SecretManagerServiceFutureStub extends AbstractFutureStub<SecretManagerServiceGrpc.SecretManagerServiceFutureStub>

Secret Manager Service Manages secrets and operations using those secrets. Implements a REST model with the following objects:

Secret
SecretVersion

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

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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 latest SecretVersion.

Parameter

Name	Description
request	`AccessSecretVersionRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<AccessSecretVersionResponse>

addSecretVersion(AddSecretVersionRequest request)

public ListenableFuture<SecretVersion> addSecretVersion(AddSecretVersionRequest request)

Creates a new SecretVersion containing secret data and attaches it to an existing Secret.

Parameter

Name	Description
request	`AddSecretVersionRequest`

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`

Returns

Type	Description
SecretManagerServiceGrpc.SecretManagerServiceFutureStub

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.

Parameter

Name	Description
request	`CreateSecretRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Secret>

deleteSecret(DeleteSecretRequest request)

public ListenableFuture<Empty> deleteSecret(DeleteSecretRequest request)

Deletes a Secret.

Parameter

Name	Description
request	`DeleteSecretRequest`

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.

Parameter

Name	Description
request	`DestroySecretVersionRequest`

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.

Parameter

Name	Description
request	`DisableSecretVersionRequest`

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.

Parameter

Name	Description
request	`EnableSecretVersionRequest`

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.

Parameter

Name	Description
request	`GetSecretRequest`

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 latest SecretVersion.

Parameter

Name	Description
request	`GetSecretVersionRequest`

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.

Parameter

Name	Description
request	`ListSecretVersionsRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<ListSecretVersionsResponse>

listSecrets(ListSecretsRequest request)

public ListenableFuture<ListSecretsResponse> listSecrets(ListSecretsRequest request)

Lists Secrets.

Parameter

Name	Description
request	`ListSecretsRequest`

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.

Parameter

Name	Description
request	`UpdateSecretRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Secret>