- 2.53.0 (latest)
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.10
- 2.2.0
- 2.1.7
- 2.0.7
public class SecretManagerServiceClient implements BackgroundResource
Service Description: Secret Manager Service
Manages secrets and operations using those secrets. Implements a REST model with the following objects:
- Secret
- SecretVersion
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
ProjectName parent = ProjectName.of("[PROJECT]");
String secretId = "secretId945974251";
Secret secret = Secret.newBuilder().build();
Secret response = secretManagerServiceClient.createSecret(parent, secretId, secret);
}
Note: close() needs to be called on the SecretManagerServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of SecretManagerServiceSettings to create(). For example:
To customize credentials:
SecretManagerServiceSettings secretManagerServiceSettings =
SecretManagerServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create(secretManagerServiceSettings);
To customize the endpoint:
SecretManagerServiceSettings secretManagerServiceSettings =
SecretManagerServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create(secretManagerServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final SecretManagerServiceClient create()
Constructs an instance of SecretManagerServiceClient with default settings.
Type | Description |
SecretManagerServiceClient |
Type | Description |
IOException |
create(SecretManagerServiceSettings settings)
public static final SecretManagerServiceClient create(SecretManagerServiceSettings settings)
Constructs an instance of SecretManagerServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Name | Description |
settings | SecretManagerServiceSettings |
Type | Description |
SecretManagerServiceClient |
Type | Description |
IOException |
create(SecretManagerServiceStub stub)
public static final SecretManagerServiceClient create(SecretManagerServiceStub stub)
Constructs an instance of SecretManagerServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(SecretManagerServiceSettings).
Name | Description |
stub | SecretManagerServiceStub |
Type | Description |
SecretManagerServiceClient |
Constructors
SecretManagerServiceClient(SecretManagerServiceSettings settings)
protected SecretManagerServiceClient(SecretManagerServiceSettings settings)
Constructs an instance of SecretManagerServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
Name | Description |
settings | SecretManagerServiceSettings |
SecretManagerServiceClient(SecretManagerServiceStub stub)
protected SecretManagerServiceClient(SecretManagerServiceStub stub)
Name | Description |
stub | SecretManagerServiceStub |
Methods
accessSecretVersion(AccessSecretVersionRequest request)
public final 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.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
AccessSecretVersionRequest request =
AccessSecretVersionRequest.newBuilder()
.setName(SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString())
.build();
AccessSecretVersionResponse response =
secretManagerServiceClient.accessSecretVersion(request);
}
Name | Description |
request | AccessSecretVersionRequest The request object containing all of the parameters for the API call. |
Type | Description |
AccessSecretVersionResponse |
accessSecretVersion(SecretVersionName name)
public final AccessSecretVersionResponse accessSecretVersion(SecretVersionName name)
Accesses a SecretVersion. This call returns the secret data.
projects/*/secrets/*/versions/latest
is an alias to the most recently created
SecretVersion.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
SecretVersionName name = SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]");
AccessSecretVersionResponse response = secretManagerServiceClient.accessSecretVersion(name);
}
Name | Description |
name | SecretVersionName Required. The resource name of the
SecretVersion in the format
|
Type | Description |
AccessSecretVersionResponse |
accessSecretVersion(String name)
public final AccessSecretVersionResponse accessSecretVersion(String name)
Accesses a SecretVersion. This call returns the secret data.
projects/*/secrets/*/versions/latest
is an alias to the most recently created
SecretVersion.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
String name = SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString();
AccessSecretVersionResponse response = secretManagerServiceClient.accessSecretVersion(name);
}
Name | Description |
name | String Required. The resource name of the
SecretVersion in the format
|
Type | Description |
AccessSecretVersionResponse |
accessSecretVersionCallable()
public final UnaryCallable<AccessSecretVersionRequest,AccessSecretVersionResponse> accessSecretVersionCallable()
Accesses a SecretVersion. This call returns the secret data.
projects/*/secrets/*/versions/latest
is an alias to the most recently created
SecretVersion.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
AccessSecretVersionRequest request =
AccessSecretVersionRequest.newBuilder()
.setName(SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString())
.build();
ApiFuture<AccessSecretVersionResponse> future =
secretManagerServiceClient.accessSecretVersionCallable().futureCall(request);
// Do something.
AccessSecretVersionResponse response = future.get();
}
Type | Description |
UnaryCallable<AccessSecretVersionRequest,AccessSecretVersionResponse> |
addSecretVersion(AddSecretVersionRequest request)
public final SecretVersion addSecretVersion(AddSecretVersionRequest request)
Creates a new SecretVersion containing secret data and attaches it to an existing Secret.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
AddSecretVersionRequest request =
AddSecretVersionRequest.newBuilder()
.setParent(SecretName.of("[PROJECT]", "[SECRET]").toString())
.setPayload(SecretPayload.newBuilder().build())
.build();
SecretVersion response = secretManagerServiceClient.addSecretVersion(request);
}
Name | Description |
request | AddSecretVersionRequest The request object containing all of the parameters for the API call. |
Type | Description |
SecretVersion |
addSecretVersion(SecretName parent, SecretPayload payload)
public final SecretVersion addSecretVersion(SecretName parent, SecretPayload payload)
Creates a new SecretVersion containing secret data and attaches it to an existing Secret.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
SecretName parent = SecretName.of("[PROJECT]", "[SECRET]");
SecretPayload payload = SecretPayload.newBuilder().build();
SecretVersion response = secretManagerServiceClient.addSecretVersion(parent, payload);
}
Name | Description |
parent | SecretName Required. The resource name of the Secret
to associate with the SecretVersion in the
format |
payload | SecretPayload Required. The secret payload of the SecretVersion. |
Type | Description |
SecretVersion |
addSecretVersion(String parent, SecretPayload payload)
public final SecretVersion addSecretVersion(String parent, SecretPayload payload)
Creates a new SecretVersion containing secret data and attaches it to an existing Secret.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
String parent = SecretName.of("[PROJECT]", "[SECRET]").toString();
SecretPayload payload = SecretPayload.newBuilder().build();
SecretVersion response = secretManagerServiceClient.addSecretVersion(parent, payload);
}
Name | Description |
parent | String Required. The resource name of the Secret
to associate with the SecretVersion in the
format |
payload | SecretPayload Required. The secret payload of the SecretVersion. |
Type | Description |
SecretVersion |
addSecretVersionCallable()
public final UnaryCallable<AddSecretVersionRequest,SecretVersion> addSecretVersionCallable()
Creates a new SecretVersion containing secret data and attaches it to an existing Secret.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
AddSecretVersionRequest request =
AddSecretVersionRequest.newBuilder()
.setParent(SecretName.of("[PROJECT]", "[SECRET]").toString())
.setPayload(SecretPayload.newBuilder().build())
.build();
ApiFuture<SecretVersion> future =
secretManagerServiceClient.addSecretVersionCallable().futureCall(request);
// Do something.
SecretVersion response = future.get();
}
Type | Description |
UnaryCallable<AddSecretVersionRequest,SecretVersion> |
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
InterruptedException |
close()
public final void close()
createSecret(CreateSecretRequest request)
public final Secret createSecret(CreateSecretRequest request)
Creates a new Secret containing no SecretVersions.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
CreateSecretRequest request =
CreateSecretRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setSecretId("secretId945974251")
.setSecret(Secret.newBuilder().build())
.build();
Secret response = secretManagerServiceClient.createSecret(request);
}
Name | Description |
request | CreateSecretRequest The request object containing all of the parameters for the API call. |
Type | Description |
Secret |
createSecret(ProjectName parent, String secretId, Secret secret)
public final Secret createSecret(ProjectName parent, String secretId, Secret secret)
Creates a new Secret containing no SecretVersions.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
ProjectName parent = ProjectName.of("[PROJECT]");
String secretId = "secretId945974251";
Secret secret = Secret.newBuilder().build();
Secret response = secretManagerServiceClient.createSecret(parent, secretId, secret);
}
Name | Description |
parent | ProjectName Required. The resource name of the project to associate with the
Secret, in the format |
secretId | String Required. This must be unique within the project. A secret ID is a string with a maximum length of 255 characters and can contain
uppercase and lowercase letters, numerals, and the hyphen ( |
secret | Secret Required. A Secret with initial field values. |
Type | Description |
Secret |
createSecret(String parent, String secretId, Secret secret)
public final Secret createSecret(String parent, String secretId, Secret secret)
Creates a new Secret containing no SecretVersions.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
String parent = ProjectName.of("[PROJECT]").toString();
String secretId = "secretId945974251";
Secret secret = Secret.newBuilder().build();
Secret response = secretManagerServiceClient.createSecret(parent, secretId, secret);
}
Name | Description |
parent | String Required. The resource name of the project to associate with the
Secret, in the format |
secretId | String Required. This must be unique within the project. A secret ID is a string with a maximum length of 255 characters and can contain
uppercase and lowercase letters, numerals, and the hyphen ( |
secret | Secret Required. A Secret with initial field values. |
Type | Description |
Secret |
createSecretCallable()
public final UnaryCallable<CreateSecretRequest,Secret> createSecretCallable()
Creates a new Secret containing no SecretVersions.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
CreateSecretRequest request =
CreateSecretRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setSecretId("secretId945974251")
.setSecret(Secret.newBuilder().build())
.build();
ApiFuture<Secret> future =
secretManagerServiceClient.createSecretCallable().futureCall(request);
// Do something.
Secret response = future.get();
}
Type | Description |
UnaryCallable<CreateSecretRequest,Secret> |
deleteSecret(DeleteSecretRequest request)
public final void deleteSecret(DeleteSecretRequest request)
Deletes a Secret.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
DeleteSecretRequest request =
DeleteSecretRequest.newBuilder()
.setName(SecretName.of("[PROJECT]", "[SECRET]").toString())
.setEtag("etag3123477")
.build();
secretManagerServiceClient.deleteSecret(request);
}
Name | Description |
request | DeleteSecretRequest The request object containing all of the parameters for the API call. |
deleteSecret(SecretName name)
public final void deleteSecret(SecretName name)
Deletes a Secret.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
SecretName name = SecretName.of("[PROJECT]", "[SECRET]");
secretManagerServiceClient.deleteSecret(name);
}
Name | Description |
name | SecretName Required. The resource name of the Secret
to delete in the format |
deleteSecret(String name)
public final void deleteSecret(String name)
Deletes a Secret.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
String name = SecretName.of("[PROJECT]", "[SECRET]").toString();
secretManagerServiceClient.deleteSecret(name);
}
Name | Description |
name | String Required. The resource name of the Secret
to delete in the format |
deleteSecretCallable()
public final UnaryCallable<DeleteSecretRequest,Empty> deleteSecretCallable()
Deletes a Secret.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
DeleteSecretRequest request =
DeleteSecretRequest.newBuilder()
.setName(SecretName.of("[PROJECT]", "[SECRET]").toString())
.setEtag("etag3123477")
.build();
ApiFuture<Empty> future =
secretManagerServiceClient.deleteSecretCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
UnaryCallable<DeleteSecretRequest,Empty> |
destroySecretVersion(DestroySecretVersionRequest request)
public final SecretVersion destroySecretVersion(DestroySecretVersionRequest request)
Destroys a SecretVersion.
Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
DestroySecretVersionRequest request =
DestroySecretVersionRequest.newBuilder()
.setName(SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString())
.setEtag("etag3123477")
.build();
SecretVersion response = secretManagerServiceClient.destroySecretVersion(request);
}
Name | Description |
request | DestroySecretVersionRequest The request object containing all of the parameters for the API call. |
Type | Description |
SecretVersion |
destroySecretVersion(SecretVersionName name)
public final SecretVersion destroySecretVersion(SecretVersionName name)
Destroys a SecretVersion.
Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
SecretVersionName name = SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]");
SecretVersion response = secretManagerServiceClient.destroySecretVersion(name);
}
Name | Description |
name | SecretVersionName Required. The resource name of the
SecretVersion to destroy in the format
|
Type | Description |
SecretVersion |
destroySecretVersion(String name)
public final SecretVersion destroySecretVersion(String name)
Destroys a SecretVersion.
Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
String name = SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString();
SecretVersion response = secretManagerServiceClient.destroySecretVersion(name);
}
Name | Description |
name | String Required. The resource name of the
SecretVersion to destroy in the format
|
Type | Description |
SecretVersion |
destroySecretVersionCallable()
public final UnaryCallable<DestroySecretVersionRequest,SecretVersion> destroySecretVersionCallable()
Destroys a SecretVersion.
Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
DestroySecretVersionRequest request =
DestroySecretVersionRequest.newBuilder()
.setName(SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString())
.setEtag("etag3123477")
.build();
ApiFuture<SecretVersion> future =
secretManagerServiceClient.destroySecretVersionCallable().futureCall(request);
// Do something.
SecretVersion response = future.get();
}
Type | Description |
UnaryCallable<DestroySecretVersionRequest,SecretVersion> |
disableSecretVersion(DisableSecretVersionRequest request)
public final SecretVersion disableSecretVersion(DisableSecretVersionRequest request)
Disables a SecretVersion.
Sets the state of the SecretVersion to DISABLED.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
DisableSecretVersionRequest request =
DisableSecretVersionRequest.newBuilder()
.setName(SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString())
.setEtag("etag3123477")
.build();
SecretVersion response = secretManagerServiceClient.disableSecretVersion(request);
}
Name | Description |
request | DisableSecretVersionRequest The request object containing all of the parameters for the API call. |
Type | Description |
SecretVersion |
disableSecretVersion(SecretVersionName name)
public final SecretVersion disableSecretVersion(SecretVersionName name)
Disables a SecretVersion.
Sets the state of the SecretVersion to DISABLED.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
SecretVersionName name = SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]");
SecretVersion response = secretManagerServiceClient.disableSecretVersion(name);
}
Name | Description |
name | SecretVersionName Required. The resource name of the
SecretVersion to disable in the format
|
Type | Description |
SecretVersion |
disableSecretVersion(String name)
public final SecretVersion disableSecretVersion(String name)
Disables a SecretVersion.
Sets the state of the SecretVersion to DISABLED.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
String name = SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString();
SecretVersion response = secretManagerServiceClient.disableSecretVersion(name);
}
Name | Description |
name | String Required. The resource name of the
SecretVersion to disable in the format
|
Type | Description |
SecretVersion |
disableSecretVersionCallable()
public final UnaryCallable<DisableSecretVersionRequest,SecretVersion> disableSecretVersionCallable()
Disables a SecretVersion.
Sets the state of the SecretVersion to DISABLED.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
DisableSecretVersionRequest request =
DisableSecretVersionRequest.newBuilder()
.setName(SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString())
.setEtag("etag3123477")
.build();
ApiFuture<SecretVersion> future =
secretManagerServiceClient.disableSecretVersionCallable().futureCall(request);
// Do something.
SecretVersion response = future.get();
}
Type | Description |
UnaryCallable<DisableSecretVersionRequest,SecretVersion> |
enableSecretVersion(EnableSecretVersionRequest request)
public final SecretVersion enableSecretVersion(EnableSecretVersionRequest request)
Enables a SecretVersion.
Sets the state of the SecretVersion to ENABLED.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
EnableSecretVersionRequest request =
EnableSecretVersionRequest.newBuilder()
.setName(SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString())
.setEtag("etag3123477")
.build();
SecretVersion response = secretManagerServiceClient.enableSecretVersion(request);
}
Name | Description |
request | EnableSecretVersionRequest The request object containing all of the parameters for the API call. |
Type | Description |
SecretVersion |
enableSecretVersion(SecretVersionName name)
public final SecretVersion enableSecretVersion(SecretVersionName name)
Enables a SecretVersion.
Sets the state of the SecretVersion to ENABLED.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
SecretVersionName name = SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]");
SecretVersion response = secretManagerServiceClient.enableSecretVersion(name);
}
Name | Description |
name | SecretVersionName Required. The resource name of the
SecretVersion to enable in the format
|
Type | Description |
SecretVersion |
enableSecretVersion(String name)
public final SecretVersion enableSecretVersion(String name)
Enables a SecretVersion.
Sets the state of the SecretVersion to ENABLED.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
String name = SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString();
SecretVersion response = secretManagerServiceClient.enableSecretVersion(name);
}
Name | Description |
name | String Required. The resource name of the
SecretVersion to enable in the format
|
Type | Description |
SecretVersion |
enableSecretVersionCallable()
public final UnaryCallable<EnableSecretVersionRequest,SecretVersion> enableSecretVersionCallable()
Enables a SecretVersion.
Sets the state of the SecretVersion to ENABLED.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
EnableSecretVersionRequest request =
EnableSecretVersionRequest.newBuilder()
.setName(SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString())
.setEtag("etag3123477")
.build();
ApiFuture<SecretVersion> future =
secretManagerServiceClient.enableSecretVersionCallable().futureCall(request);
// Do something.
SecretVersion response = future.get();
}
Type | Description |
UnaryCallable<EnableSecretVersionRequest,SecretVersion> |
getIamPolicy(GetIamPolicyRequest request)
public final 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.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(ProjectName.of("[PROJECT]").toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
Policy response = secretManagerServiceClient.getIamPolicy(request);
}
Name | Description |
request | com.google.iam.v1.GetIamPolicyRequest The request object containing all of the parameters for the API call. |
Type | Description |
com.google.iam.v1.Policy |
getIamPolicyCallable()
public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()
Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(ProjectName.of("[PROJECT]").toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
ApiFuture<Policy> future =
secretManagerServiceClient.getIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
Type | Description |
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
getSecret(GetSecretRequest request)
public final Secret getSecret(GetSecretRequest request)
Gets metadata for a given Secret.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
GetSecretRequest request =
GetSecretRequest.newBuilder()
.setName(SecretName.of("[PROJECT]", "[SECRET]").toString())
.build();
Secret response = secretManagerServiceClient.getSecret(request);
}
Name | Description |
request | GetSecretRequest The request object containing all of the parameters for the API call. |
Type | Description |
Secret |
getSecret(SecretName name)
public final Secret getSecret(SecretName name)
Gets metadata for a given Secret.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
SecretName name = SecretName.of("[PROJECT]", "[SECRET]");
Secret response = secretManagerServiceClient.getSecret(name);
}
Name | Description |
name | SecretName Required. The resource name of the Secret,
in the format |
Type | Description |
Secret |
getSecret(String name)
public final Secret getSecret(String name)
Gets metadata for a given Secret.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
String name = SecretName.of("[PROJECT]", "[SECRET]").toString();
Secret response = secretManagerServiceClient.getSecret(name);
}
Name | Description |
name | String Required. The resource name of the Secret,
in the format |
Type | Description |
Secret |
getSecretCallable()
public final UnaryCallable<GetSecretRequest,Secret> getSecretCallable()
Gets metadata for a given Secret.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
GetSecretRequest request =
GetSecretRequest.newBuilder()
.setName(SecretName.of("[PROJECT]", "[SECRET]").toString())
.build();
ApiFuture<Secret> future = secretManagerServiceClient.getSecretCallable().futureCall(request);
// Do something.
Secret response = future.get();
}
Type | Description |
UnaryCallable<GetSecretRequest,Secret> |
getSecretVersion(GetSecretVersionRequest request)
public final SecretVersion getSecretVersion(GetSecretVersionRequest request)
Gets metadata for a SecretVersion.
projects/*/secrets/*/versions/latest
is an alias to the most recently created
SecretVersion.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
GetSecretVersionRequest request =
GetSecretVersionRequest.newBuilder()
.setName(SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString())
.build();
SecretVersion response = secretManagerServiceClient.getSecretVersion(request);
}
Name | Description |
request | GetSecretVersionRequest The request object containing all of the parameters for the API call. |
Type | Description |
SecretVersion |
getSecretVersion(SecretVersionName name)
public final SecretVersion getSecretVersion(SecretVersionName name)
Gets metadata for a SecretVersion.
projects/*/secrets/*/versions/latest
is an alias to the most recently created
SecretVersion.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
SecretVersionName name = SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]");
SecretVersion response = secretManagerServiceClient.getSecretVersion(name);
}
Name | Description |
name | SecretVersionName Required. The resource name of the
SecretVersion in the format
|
Type | Description |
SecretVersion |
getSecretVersion(String name)
public final SecretVersion getSecretVersion(String name)
Gets metadata for a SecretVersion.
projects/*/secrets/*/versions/latest
is an alias to the most recently created
SecretVersion.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
String name = SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString();
SecretVersion response = secretManagerServiceClient.getSecretVersion(name);
}
Name | Description |
name | String Required. The resource name of the
SecretVersion in the format
|
Type | Description |
SecretVersion |
getSecretVersionCallable()
public final UnaryCallable<GetSecretVersionRequest,SecretVersion> getSecretVersionCallable()
Gets metadata for a SecretVersion.
projects/*/secrets/*/versions/latest
is an alias to the most recently created
SecretVersion.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
GetSecretVersionRequest request =
GetSecretVersionRequest.newBuilder()
.setName(SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString())
.build();
ApiFuture<SecretVersion> future =
secretManagerServiceClient.getSecretVersionCallable().futureCall(request);
// Do something.
SecretVersion response = future.get();
}
Type | Description |
UnaryCallable<GetSecretVersionRequest,SecretVersion> |
getSettings()
public final SecretManagerServiceSettings getSettings()
Type | Description |
SecretManagerServiceSettings |
getStub()
public SecretManagerServiceStub getStub()
Type | Description |
SecretManagerServiceStub |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
listSecretVersions(ListSecretVersionsRequest request)
public final SecretManagerServiceClient.ListSecretVersionsPagedResponse listSecretVersions(ListSecretVersionsRequest request)
Lists SecretVersions. This call does not return secret data.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
ListSecretVersionsRequest request =
ListSecretVersionsRequest.newBuilder()
.setParent(SecretName.of("[PROJECT]", "[SECRET]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
for (SecretVersion element :
secretManagerServiceClient.listSecretVersions(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListSecretVersionsRequest The request object containing all of the parameters for the API call. |
Type | Description |
SecretManagerServiceClient.ListSecretVersionsPagedResponse |
listSecretVersions(SecretName parent)
public final SecretManagerServiceClient.ListSecretVersionsPagedResponse listSecretVersions(SecretName parent)
Lists SecretVersions. This call does not return secret data.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
SecretName parent = SecretName.of("[PROJECT]", "[SECRET]");
for (SecretVersion element :
secretManagerServiceClient.listSecretVersions(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | SecretName Required. The resource name of the Secret
associated with the SecretVersions to list,
in the format |
Type | Description |
SecretManagerServiceClient.ListSecretVersionsPagedResponse |
listSecretVersions(String parent)
public final SecretManagerServiceClient.ListSecretVersionsPagedResponse listSecretVersions(String parent)
Lists SecretVersions. This call does not return secret data.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
String parent = SecretName.of("[PROJECT]", "[SECRET]").toString();
for (SecretVersion element :
secretManagerServiceClient.listSecretVersions(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The resource name of the Secret
associated with the SecretVersions to list,
in the format |
Type | Description |
SecretManagerServiceClient.ListSecretVersionsPagedResponse |
listSecretVersionsCallable()
public final UnaryCallable<ListSecretVersionsRequest,ListSecretVersionsResponse> listSecretVersionsCallable()
Lists SecretVersions. This call does not return secret data.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
ListSecretVersionsRequest request =
ListSecretVersionsRequest.newBuilder()
.setParent(SecretName.of("[PROJECT]", "[SECRET]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
while (true) {
ListSecretVersionsResponse response =
secretManagerServiceClient.listSecretVersionsCallable().call(request);
for (SecretVersion element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListSecretVersionsRequest,ListSecretVersionsResponse> |
listSecretVersionsPagedCallable()
public final UnaryCallable<ListSecretVersionsRequest,SecretManagerServiceClient.ListSecretVersionsPagedResponse> listSecretVersionsPagedCallable()
Lists SecretVersions. This call does not return secret data.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
ListSecretVersionsRequest request =
ListSecretVersionsRequest.newBuilder()
.setParent(SecretName.of("[PROJECT]", "[SECRET]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
ApiFuture<SecretVersion> future =
secretManagerServiceClient.listSecretVersionsPagedCallable().futureCall(request);
// Do something.
for (SecretVersion element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<ListSecretVersionsRequest,ListSecretVersionsPagedResponse> |
listSecrets(ListSecretsRequest request)
public final SecretManagerServiceClient.ListSecretsPagedResponse listSecrets(ListSecretsRequest request)
Lists Secrets.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
ListSecretsRequest request =
ListSecretsRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
for (Secret element : secretManagerServiceClient.listSecrets(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListSecretsRequest The request object containing all of the parameters for the API call. |
Type | Description |
SecretManagerServiceClient.ListSecretsPagedResponse |
listSecrets(ProjectName parent)
public final SecretManagerServiceClient.ListSecretsPagedResponse listSecrets(ProjectName parent)
Lists Secrets.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
ProjectName parent = ProjectName.of("[PROJECT]");
for (Secret element : secretManagerServiceClient.listSecrets(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | ProjectName Required. The resource name of the project associated with the
Secrets, in the format |
Type | Description |
SecretManagerServiceClient.ListSecretsPagedResponse |
listSecrets(String parent)
public final SecretManagerServiceClient.ListSecretsPagedResponse listSecrets(String parent)
Lists Secrets.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
String parent = ProjectName.of("[PROJECT]").toString();
for (Secret element : secretManagerServiceClient.listSecrets(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The resource name of the project associated with the
Secrets, in the format |
Type | Description |
SecretManagerServiceClient.ListSecretsPagedResponse |
listSecretsCallable()
public final UnaryCallable<ListSecretsRequest,ListSecretsResponse> listSecretsCallable()
Lists Secrets.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
ListSecretsRequest request =
ListSecretsRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
while (true) {
ListSecretsResponse response =
secretManagerServiceClient.listSecretsCallable().call(request);
for (Secret element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListSecretsRequest,ListSecretsResponse> |
listSecretsPagedCallable()
public final UnaryCallable<ListSecretsRequest,SecretManagerServiceClient.ListSecretsPagedResponse> listSecretsPagedCallable()
Lists Secrets.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
ListSecretsRequest request =
ListSecretsRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
ApiFuture<Secret> future =
secretManagerServiceClient.listSecretsPagedCallable().futureCall(request);
// Do something.
for (Secret element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<ListSecretsRequest,ListSecretsPagedResponse> |
setIamPolicy(SetIamPolicyRequest request)
public final 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.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(ProjectName.of("[PROJECT]").toString())
.setPolicy(Policy.newBuilder().build())
.build();
Policy response = secretManagerServiceClient.setIamPolicy(request);
}
Name | Description |
request | com.google.iam.v1.SetIamPolicyRequest The request object containing all of the parameters for the API call. |
Type | Description |
com.google.iam.v1.Policy |
setIamPolicyCallable()
public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()
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.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(ProjectName.of("[PROJECT]").toString())
.setPolicy(Policy.newBuilder().build())
.build();
ApiFuture<Policy> future =
secretManagerServiceClient.setIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
Type | Description |
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
testIamPermissions(TestIamPermissionsRequest request)
public final 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.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(ProjectName.of("[PROJECT]").toString())
.addAllPermissions(new ArrayList<String>())
.build();
TestIamPermissionsResponse response = secretManagerServiceClient.testIamPermissions(request);
}
Name | Description |
request | com.google.iam.v1.TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
Type | Description |
com.google.iam.v1.TestIamPermissionsResponse |
testIamPermissionsCallable()
public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()
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.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(ProjectName.of("[PROJECT]").toString())
.addAllPermissions(new ArrayList<String>())
.build();
ApiFuture<TestIamPermissionsResponse> future =
secretManagerServiceClient.testIamPermissionsCallable().futureCall(request);
// Do something.
TestIamPermissionsResponse response = future.get();
}
Type | Description |
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
updateSecret(Secret secret, FieldMask updateMask)
public final Secret updateSecret(Secret secret, FieldMask updateMask)
Updates metadata of an existing Secret.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
Secret secret = Secret.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Secret response = secretManagerServiceClient.updateSecret(secret, updateMask);
}
Name | Description |
secret | Secret Required. Secret with updated field values. |
updateMask | FieldMask Required. Specifies the fields to be updated. |
Type | Description |
Secret |
updateSecret(UpdateSecretRequest request)
public final Secret updateSecret(UpdateSecretRequest request)
Updates metadata of an existing Secret.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
UpdateSecretRequest request =
UpdateSecretRequest.newBuilder()
.setSecret(Secret.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Secret response = secretManagerServiceClient.updateSecret(request);
}
Name | Description |
request | UpdateSecretRequest The request object containing all of the parameters for the API call. |
Type | Description |
Secret |
updateSecretCallable()
public final UnaryCallable<UpdateSecretRequest,Secret> updateSecretCallable()
Updates metadata of an existing Secret.
Sample code:
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
UpdateSecretRequest request =
UpdateSecretRequest.newBuilder()
.setSecret(Secret.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Secret> future =
secretManagerServiceClient.updateSecretCallable().futureCall(request);
// Do something.
Secret response = future.get();
}
Type | Description |
UnaryCallable<UpdateSecretRequest,Secret> |