Manages secrets and operations using those secrets. Implements a REST model with the following + * objects: + * + *
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: + * + *
{@code
+ * // 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
+ * 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(). + * + *
| Method | + *Description | + *Method Variants | + *
|---|---|---|
ListSecrets |
+ * Lists [Secrets][google.cloud.secrets.v1beta1.Secret]. |
+ *
+ * Request object method variants only take one parameter, a request object, which must be constructed before the call. + *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. + *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. + *
|
+ *
CreateSecret |
+ * Creates a new [Secret][google.cloud.secrets.v1beta1.Secret] containing no [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion]. |
+ *
+ * Request object method variants only take one parameter, a request object, which must be constructed before the call. + *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. + *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. + *
|
+ *
AddSecretVersion |
+ * Creates a new [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] containing secret data and attaches it to an existing [Secret][google.cloud.secrets.v1beta1.Secret]. |
+ *
+ * Request object method variants only take one parameter, a request object, which must be constructed before the call. + *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. + *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. + *
|
+ *
GetSecret |
+ * Gets metadata for a given [Secret][google.cloud.secrets.v1beta1.Secret]. |
+ *
+ * Request object method variants only take one parameter, a request object, which must be constructed before the call. + *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. + *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. + *
|
+ *
UpdateSecret |
+ * Updates metadata of an existing [Secret][google.cloud.secrets.v1beta1.Secret]. |
+ *
+ * Request object method variants only take one parameter, a request object, which must be constructed before the call. + *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. + *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. + *
|
+ *
DeleteSecret |
+ * Deletes a [Secret][google.cloud.secrets.v1beta1.Secret]. |
+ *
+ * Request object method variants only take one parameter, a request object, which must be constructed before the call. + *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. + *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. + *
|
+ *
ListSecretVersions |
+ * Lists [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion]. This call does not return secret data. |
+ *
+ * Request object method variants only take one parameter, a request object, which must be constructed before the call. + *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. + *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. + *
|
+ *
GetSecretVersion |
+ * Gets metadata for a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. + * `projects/*/secrets/*/versions/latest` is an alias to the `latest` [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. |
+ *
+ * Request object method variants only take one parameter, a request object, which must be constructed before the call. + *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. + *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. + *
|
+ *
AccessSecretVersion |
+ * Accesses a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. This call returns the secret data. + * `projects/*/secrets/*/versions/latest` is an alias to the `latest` [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. |
+ *
+ * Request object method variants only take one parameter, a request object, which must be constructed before the call. + *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. + *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. + *
|
+ *
DisableSecretVersion |
+ * Disables a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. + * Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to [DISABLED][google.cloud.secrets.v1beta1.SecretVersion.State.DISABLED]. |
+ *
+ * Request object method variants only take one parameter, a request object, which must be constructed before the call. + *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. + *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. + *
|
+ *
EnableSecretVersion |
+ * Enables a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. + * Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to [ENABLED][google.cloud.secrets.v1beta1.SecretVersion.State.ENABLED]. |
+ *
+ * Request object method variants only take one parameter, a request object, which must be constructed before the call. + *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. + *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. + *
|
+ *
DestroySecretVersion |
+ * Destroys a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. + * Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to [DESTROYED][google.cloud.secrets.v1beta1.SecretVersion.State.DESTROYED] and irrevocably destroys the secret data. |
+ *
+ * Request object method variants only take one parameter, a request object, which must be constructed before the call. + *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. + *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. + *
|
+ *
SetIamPolicy |
+ * Sets the access control policy on the specified secret. Replaces any existing policy. + * Permissions on [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion] are enforced according to the policy set on the associated [Secret][google.cloud.secrets.v1beta1.Secret]. |
+ *
+ * Request object method variants only take one parameter, a request object, which must be constructed before the call. + *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. + *
|
+ *
GetIamPolicy |
+ * Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set. |
+ *
+ * Request object method variants only take one parameter, a request object, which must be constructed before the call. + *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. + *
|
+ *
TestIamPermissions |
+ * 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. |
+ *
+ * Request object method variants only take one parameter, a request object, which must be constructed before the call. + *
Callable method variants take no parameters and return 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: + * + *
{@code
+ * // 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
+ * SecretManagerServiceSettings secretManagerServiceSettings =
+ * SecretManagerServiceSettings.newBuilder()
+ * .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
+ * .build();
+ * SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create(secretManagerServiceSettings);
+ * }
+ *
+ * To customize the endpoint: + * + *
{@code
+ * // 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
+ * SecretManagerServiceSettings secretManagerServiceSettings =
+ * SecretManagerServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
+ * SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create(secretManagerServiceSettings);
+ * }
+ *
+ * To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over + * the wire: + * + *
{@code
+ * // 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
+ * SecretManagerServiceSettings secretManagerServiceSettings =
+ * SecretManagerServiceSettings.newHttpJsonBuilder().build();
+ * SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create(secretManagerServiceSettings);
+ * }
+ *
+ * Please refer to the GitHub repository's samples for more quickstart code snippets. + */ +@BetaApi +@Generated("by gapic-generator-java") +public class SecretManagerServiceClient implements BackgroundResource { + private final SecretManagerServiceSettings settings; + private final SecretManagerServiceStub stub; + + /** Constructs an instance of SecretManagerServiceClient with default settings. */ + public static final SecretManagerServiceClient create() throws IOException { + return create(SecretManagerServiceSettings.newBuilder().build()); + } + + /** + * 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. + */ + public static final SecretManagerServiceClient create(SecretManagerServiceSettings settings) + throws IOException { + return new SecretManagerServiceClient(settings); + } + + /** + * Constructs an instance of SecretManagerServiceClient, using the given stub for making calls. + * This is for advanced usage - prefer using create(SecretManagerServiceSettings). + */ + public static final SecretManagerServiceClient create(SecretManagerServiceStub stub) { + return new SecretManagerServiceClient(stub); + } + + /** + * 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. + */ + protected SecretManagerServiceClient(SecretManagerServiceSettings settings) throws IOException { + this.settings = settings; + this.stub = ((SecretManagerServiceStubSettings) settings.getStubSettings()).createStub(); + } + + protected SecretManagerServiceClient(SecretManagerServiceStub stub) { + this.settings = null; + this.stub = stub; + } + + public final SecretManagerServiceSettings getSettings() { + return settings; + } + + public SecretManagerServiceStub getStub() { + return stub; + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD. + /** + * Lists [Secrets][google.cloud.secrets.v1beta1.Secret]. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * ProjectName parent = ProjectName.of("[PROJECT]");
+ * for (Secret element : secretManagerServiceClient.listSecrets(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
+ * @param parent Required. The resource name of the project associated with the
+ * [Secrets][google.cloud.secrets.v1beta1.Secret], in the format `projects/*`.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final ListSecretsPagedResponse listSecrets(ProjectName parent) {
+ ListSecretsRequest request =
+ ListSecretsRequest.newBuilder()
+ .setParent(parent == null ? null : parent.toString())
+ .build();
+ return listSecrets(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Lists [Secrets][google.cloud.secrets.v1beta1.Secret].
+ *
+ * Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * String parent = ProjectName.of("[PROJECT]").toString();
+ * for (Secret element : secretManagerServiceClient.listSecrets(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
+ * @param parent Required. The resource name of the project associated with the
+ * [Secrets][google.cloud.secrets.v1beta1.Secret], in the format `projects/*`.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final ListSecretsPagedResponse listSecrets(String parent) {
+ ListSecretsRequest request = ListSecretsRequest.newBuilder().setParent(parent).build();
+ return listSecrets(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Lists [Secrets][google.cloud.secrets.v1beta1.Secret].
+ *
+ * Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * ListSecretsRequest request =
+ * ListSecretsRequest.newBuilder()
+ * .setParent(ProjectName.of("[PROJECT]").toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * for (Secret element : secretManagerServiceClient.listSecrets(request).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final ListSecretsPagedResponse listSecrets(ListSecretsRequest request) {
+ return listSecretsPagedCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Lists [Secrets][google.cloud.secrets.v1beta1.Secret].
+ *
+ * Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * ListSecretsRequest request =
+ * ListSecretsRequest.newBuilder()
+ * .setParent(ProjectName.of("[PROJECT]").toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * ApiFuture future =
+ * secretManagerServiceClient.listSecretsPagedCallable().futureCall(request);
+ * // Do something.
+ * for (Secret element : future.get().iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ */
+ public final UnaryCallableSample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * ListSecretsRequest request =
+ * ListSecretsRequest.newBuilder()
+ * .setParent(ProjectName.of("[PROJECT]").toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * while (true) {
+ * ListSecretsResponse response =
+ * secretManagerServiceClient.listSecretsCallable().call(request);
+ * for (Secret element : response.getSecretsList()) {
+ * // doThingsWith(element);
+ * }
+ * String nextPageToken = response.getNextPageToken();
+ * if (!Strings.isNullOrEmpty(nextPageToken)) {
+ * request = request.toBuilder().setPageToken(nextPageToken).build();
+ * } else {
+ * break;
+ * }
+ * }
+ * }
+ * }
+ */
+ public final UnaryCallableSample code: + * + *
{@code
+ * // 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
+ * 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);
+ * }
+ * }
+ *
+ * @param parent Required. The resource name of the project to associate with the
+ * [Secret][google.cloud.secrets.v1beta1.Secret], in the format `projects/*`.
+ * @param secretId 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 (`-`) and underscore (`_`) + * characters. + * @param secret Required. A [Secret][google.cloud.secrets.v1beta1.Secret] with initial field + * values. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final Secret createSecret(ProjectName parent, String secretId, Secret secret) { + CreateSecretRequest request = + CreateSecretRequest.newBuilder() + .setParent(parent == null ? null : parent.toString()) + .setSecretId(secretId) + .setSecret(secret) + .build(); + return createSecret(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD. + /** + * Creates a new [Secret][google.cloud.secrets.v1beta1.Secret] containing no + * [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion]. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * 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);
+ * }
+ * }
+ *
+ * @param parent Required. The resource name of the project to associate with the
+ * [Secret][google.cloud.secrets.v1beta1.Secret], in the format `projects/*`.
+ * @param secretId 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 (`-`) and underscore (`_`) + * characters. + * @param secret Required. A [Secret][google.cloud.secrets.v1beta1.Secret] with initial field + * values. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final Secret createSecret(String parent, String secretId, Secret secret) { + CreateSecretRequest request = + CreateSecretRequest.newBuilder() + .setParent(parent) + .setSecretId(secretId) + .setSecret(secret) + .build(); + return createSecret(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD. + /** + * Creates a new [Secret][google.cloud.secrets.v1beta1.Secret] containing no + * [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion]. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * 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);
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final Secret createSecret(CreateSecretRequest request) {
+ return createSecretCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Creates a new [Secret][google.cloud.secrets.v1beta1.Secret] containing no
+ * [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion].
+ *
+ * Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * CreateSecretRequest request =
+ * CreateSecretRequest.newBuilder()
+ * .setParent(ProjectName.of("[PROJECT]").toString())
+ * .setSecretId("secretId945974251")
+ * .setSecret(Secret.newBuilder().build())
+ * .build();
+ * ApiFuture future =
+ * secretManagerServiceClient.createSecretCallable().futureCall(request);
+ * // Do something.
+ * Secret response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableSample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * SecretName parent = SecretName.of("[PROJECT]", "[SECRET]");
+ * SecretPayload payload = SecretPayload.newBuilder().build();
+ * SecretVersion response = secretManagerServiceClient.addSecretVersion(parent, payload);
+ * }
+ * }
+ *
+ * @param parent Required. The resource name of the [Secret][google.cloud.secrets.v1beta1.Secret]
+ * to associate with the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] in the
+ * format `projects/*/secrets/*`.
+ * @param payload Required. The secret payload of the
+ * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final SecretVersion addSecretVersion(SecretName parent, SecretPayload payload) {
+ AddSecretVersionRequest request =
+ AddSecretVersionRequest.newBuilder()
+ .setParent(parent == null ? null : parent.toString())
+ .setPayload(payload)
+ .build();
+ return addSecretVersion(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Creates a new [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] containing secret
+ * data and attaches it to an existing [Secret][google.cloud.secrets.v1beta1.Secret].
+ *
+ * Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * String parent = SecretName.of("[PROJECT]", "[SECRET]").toString();
+ * SecretPayload payload = SecretPayload.newBuilder().build();
+ * SecretVersion response = secretManagerServiceClient.addSecretVersion(parent, payload);
+ * }
+ * }
+ *
+ * @param parent Required. The resource name of the [Secret][google.cloud.secrets.v1beta1.Secret]
+ * to associate with the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] in the
+ * format `projects/*/secrets/*`.
+ * @param payload Required. The secret payload of the
+ * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final SecretVersion addSecretVersion(String parent, SecretPayload payload) {
+ AddSecretVersionRequest request =
+ AddSecretVersionRequest.newBuilder().setParent(parent).setPayload(payload).build();
+ return addSecretVersion(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Creates a new [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] containing secret
+ * data and attaches it to an existing [Secret][google.cloud.secrets.v1beta1.Secret].
+ *
+ * Sample code: + * + *
{@code
+ * // 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
+ * 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);
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final SecretVersion addSecretVersion(AddSecretVersionRequest request) {
+ return addSecretVersionCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Creates a new [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] containing secret
+ * data and attaches it to an existing [Secret][google.cloud.secrets.v1beta1.Secret].
+ *
+ * Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * AddSecretVersionRequest request =
+ * AddSecretVersionRequest.newBuilder()
+ * .setParent(SecretName.of("[PROJECT]", "[SECRET]").toString())
+ * .setPayload(SecretPayload.newBuilder().build())
+ * .build();
+ * ApiFuture future =
+ * secretManagerServiceClient.addSecretVersionCallable().futureCall(request);
+ * // Do something.
+ * SecretVersion response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableSample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * SecretName name = SecretName.of("[PROJECT]", "[SECRET]");
+ * Secret response = secretManagerServiceClient.getSecret(name);
+ * }
+ * }
+ *
+ * @param name Required. The resource name of the [Secret][google.cloud.secrets.v1beta1.Secret],
+ * in the format `projects/*/secrets/*`.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final Secret getSecret(SecretName name) {
+ GetSecretRequest request =
+ GetSecretRequest.newBuilder().setName(name == null ? null : name.toString()).build();
+ return getSecret(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Gets metadata for a given [Secret][google.cloud.secrets.v1beta1.Secret].
+ *
+ * Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * String name = SecretName.of("[PROJECT]", "[SECRET]").toString();
+ * Secret response = secretManagerServiceClient.getSecret(name);
+ * }
+ * }
+ *
+ * @param name Required. The resource name of the [Secret][google.cloud.secrets.v1beta1.Secret],
+ * in the format `projects/*/secrets/*`.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final Secret getSecret(String name) {
+ GetSecretRequest request = GetSecretRequest.newBuilder().setName(name).build();
+ return getSecret(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Gets metadata for a given [Secret][google.cloud.secrets.v1beta1.Secret].
+ *
+ * Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * GetSecretRequest request =
+ * GetSecretRequest.newBuilder()
+ * .setName(SecretName.of("[PROJECT]", "[SECRET]").toString())
+ * .build();
+ * Secret response = secretManagerServiceClient.getSecret(request);
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final Secret getSecret(GetSecretRequest request) {
+ return getSecretCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Gets metadata for a given [Secret][google.cloud.secrets.v1beta1.Secret].
+ *
+ * Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * GetSecretRequest request =
+ * GetSecretRequest.newBuilder()
+ * .setName(SecretName.of("[PROJECT]", "[SECRET]").toString())
+ * .build();
+ * ApiFuture future = secretManagerServiceClient.getSecretCallable().futureCall(request);
+ * // Do something.
+ * Secret response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableSample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * Secret secret = Secret.newBuilder().build();
+ * FieldMask updateMask = FieldMask.newBuilder().build();
+ * Secret response = secretManagerServiceClient.updateSecret(secret, updateMask);
+ * }
+ * }
+ *
+ * @param secret Required. [Secret][google.cloud.secrets.v1beta1.Secret] with updated field
+ * values.
+ * @param updateMask Required. Specifies the fields to be updated.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final Secret updateSecret(Secret secret, FieldMask updateMask) {
+ UpdateSecretRequest request =
+ UpdateSecretRequest.newBuilder().setSecret(secret).setUpdateMask(updateMask).build();
+ return updateSecret(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Updates metadata of an existing [Secret][google.cloud.secrets.v1beta1.Secret].
+ *
+ * Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * UpdateSecretRequest request =
+ * UpdateSecretRequest.newBuilder()
+ * .setSecret(Secret.newBuilder().build())
+ * .setUpdateMask(FieldMask.newBuilder().build())
+ * .build();
+ * Secret response = secretManagerServiceClient.updateSecret(request);
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final Secret updateSecret(UpdateSecretRequest request) {
+ return updateSecretCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Updates metadata of an existing [Secret][google.cloud.secrets.v1beta1.Secret].
+ *
+ * Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * UpdateSecretRequest request =
+ * UpdateSecretRequest.newBuilder()
+ * .setSecret(Secret.newBuilder().build())
+ * .setUpdateMask(FieldMask.newBuilder().build())
+ * .build();
+ * ApiFuture future =
+ * secretManagerServiceClient.updateSecretCallable().futureCall(request);
+ * // Do something.
+ * Secret response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableSample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * SecretName name = SecretName.of("[PROJECT]", "[SECRET]");
+ * secretManagerServiceClient.deleteSecret(name);
+ * }
+ * }
+ *
+ * @param name Required. The resource name of the [Secret][google.cloud.secrets.v1beta1.Secret] to
+ * delete in the format `projects/*/secrets/*`.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final void deleteSecret(SecretName name) {
+ DeleteSecretRequest request =
+ DeleteSecretRequest.newBuilder().setName(name == null ? null : name.toString()).build();
+ deleteSecret(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Deletes a [Secret][google.cloud.secrets.v1beta1.Secret].
+ *
+ * Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * String name = SecretName.of("[PROJECT]", "[SECRET]").toString();
+ * secretManagerServiceClient.deleteSecret(name);
+ * }
+ * }
+ *
+ * @param name Required. The resource name of the [Secret][google.cloud.secrets.v1beta1.Secret] to
+ * delete in the format `projects/*/secrets/*`.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final void deleteSecret(String name) {
+ DeleteSecretRequest request = DeleteSecretRequest.newBuilder().setName(name).build();
+ deleteSecret(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Deletes a [Secret][google.cloud.secrets.v1beta1.Secret].
+ *
+ * Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * DeleteSecretRequest request =
+ * DeleteSecretRequest.newBuilder()
+ * .setName(SecretName.of("[PROJECT]", "[SECRET]").toString())
+ * .build();
+ * secretManagerServiceClient.deleteSecret(request);
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final void deleteSecret(DeleteSecretRequest request) {
+ deleteSecretCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Deletes a [Secret][google.cloud.secrets.v1beta1.Secret].
+ *
+ * Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * DeleteSecretRequest request =
+ * DeleteSecretRequest.newBuilder()
+ * .setName(SecretName.of("[PROJECT]", "[SECRET]").toString())
+ * .build();
+ * ApiFuture future =
+ * secretManagerServiceClient.deleteSecretCallable().futureCall(request);
+ * // Do something.
+ * future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableSample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * SecretName parent = SecretName.of("[PROJECT]", "[SECRET]");
+ * for (SecretVersion element :
+ * secretManagerServiceClient.listSecretVersions(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
+ * @param parent Required. The resource name of the [Secret][google.cloud.secrets.v1beta1.Secret]
+ * associated with the [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion] to list,
+ * in the format `projects/*/secrets/*`.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final ListSecretVersionsPagedResponse listSecretVersions(SecretName parent) {
+ ListSecretVersionsRequest request =
+ ListSecretVersionsRequest.newBuilder()
+ .setParent(parent == null ? null : parent.toString())
+ .build();
+ return listSecretVersions(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Lists [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion]. This call does not return
+ * secret data.
+ *
+ * Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * String parent = SecretName.of("[PROJECT]", "[SECRET]").toString();
+ * for (SecretVersion element :
+ * secretManagerServiceClient.listSecretVersions(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
+ * @param parent Required. The resource name of the [Secret][google.cloud.secrets.v1beta1.Secret]
+ * associated with the [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion] to list,
+ * in the format `projects/*/secrets/*`.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final ListSecretVersionsPagedResponse listSecretVersions(String parent) {
+ ListSecretVersionsRequest request =
+ ListSecretVersionsRequest.newBuilder().setParent(parent).build();
+ return listSecretVersions(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Lists [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion]. This call does not return
+ * secret data.
+ *
+ * Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * ListSecretVersionsRequest request =
+ * ListSecretVersionsRequest.newBuilder()
+ * .setParent(SecretName.of("[PROJECT]", "[SECRET]").toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * for (SecretVersion element :
+ * secretManagerServiceClient.listSecretVersions(request).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final ListSecretVersionsPagedResponse listSecretVersions(
+ ListSecretVersionsRequest request) {
+ return listSecretVersionsPagedCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Lists [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion]. This call does not return
+ * secret data.
+ *
+ * Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * ListSecretVersionsRequest request =
+ * ListSecretVersionsRequest.newBuilder()
+ * .setParent(SecretName.of("[PROJECT]", "[SECRET]").toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * ApiFuture future =
+ * secretManagerServiceClient.listSecretVersionsPagedCallable().futureCall(request);
+ * // Do something.
+ * for (SecretVersion element : future.get().iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ */
+ public final UnaryCallableSample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * ListSecretVersionsRequest request =
+ * ListSecretVersionsRequest.newBuilder()
+ * .setParent(SecretName.of("[PROJECT]", "[SECRET]").toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * while (true) {
+ * ListSecretVersionsResponse response =
+ * secretManagerServiceClient.listSecretVersionsCallable().call(request);
+ * for (SecretVersion element : response.getVersionsList()) {
+ * // doThingsWith(element);
+ * }
+ * String nextPageToken = response.getNextPageToken();
+ * if (!Strings.isNullOrEmpty(nextPageToken)) {
+ * request = request.toBuilder().setPageToken(nextPageToken).build();
+ * } else {
+ * break;
+ * }
+ * }
+ * }
+ * }
+ */
+ public final UnaryCallable`projects/*/secrets/*/versions/latest` is an alias to the `latest` + * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * SecretVersionName name = SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]");
+ * SecretVersion response = secretManagerServiceClient.getSecretVersion(name);
+ * }
+ * }
+ *
+ * @param name Required. The resource name of the
+ * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] in the format
+ * `projects/*/secrets/*/versions/*`.
+ * `projects/*/secrets/*/versions/latest` is an alias to the `latest`
+ * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final SecretVersion getSecretVersion(SecretVersionName name) {
+ GetSecretVersionRequest request =
+ GetSecretVersionRequest.newBuilder().setName(name == null ? null : name.toString()).build();
+ return getSecretVersion(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Gets metadata for a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
+ *
+ * `projects/*/secrets/*/versions/latest` is an alias to the `latest` + * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * String name = SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString();
+ * SecretVersion response = secretManagerServiceClient.getSecretVersion(name);
+ * }
+ * }
+ *
+ * @param name Required. The resource name of the
+ * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] in the format
+ * `projects/*/secrets/*/versions/*`.
+ * `projects/*/secrets/*/versions/latest` is an alias to the `latest`
+ * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final SecretVersion getSecretVersion(String name) {
+ GetSecretVersionRequest request = GetSecretVersionRequest.newBuilder().setName(name).build();
+ return getSecretVersion(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Gets metadata for a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
+ *
+ * `projects/*/secrets/*/versions/latest` is an alias to the `latest` + * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * GetSecretVersionRequest request =
+ * GetSecretVersionRequest.newBuilder()
+ * .setName(SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString())
+ * .build();
+ * SecretVersion response = secretManagerServiceClient.getSecretVersion(request);
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final SecretVersion getSecretVersion(GetSecretVersionRequest request) {
+ return getSecretVersionCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Gets metadata for a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
+ *
+ * `projects/*/secrets/*/versions/latest` is an alias to the `latest` + * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * GetSecretVersionRequest request =
+ * GetSecretVersionRequest.newBuilder()
+ * .setName(SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString())
+ * .build();
+ * ApiFuture future =
+ * secretManagerServiceClient.getSecretVersionCallable().futureCall(request);
+ * // Do something.
+ * SecretVersion response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallable`projects/*/secrets/*/versions/latest` is an alias to the `latest` + * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * SecretVersionName name = SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]");
+ * AccessSecretVersionResponse response = secretManagerServiceClient.accessSecretVersion(name);
+ * }
+ * }
+ *
+ * @param name Required. The resource name of the
+ * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] in the format
+ * `projects/*/secrets/*/versions/*`.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final AccessSecretVersionResponse accessSecretVersion(SecretVersionName name) {
+ AccessSecretVersionRequest request =
+ AccessSecretVersionRequest.newBuilder()
+ .setName(name == null ? null : name.toString())
+ .build();
+ return accessSecretVersion(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Accesses a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. This call returns the
+ * secret data.
+ *
+ * `projects/*/secrets/*/versions/latest` is an alias to the `latest` + * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * String name = SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString();
+ * AccessSecretVersionResponse response = secretManagerServiceClient.accessSecretVersion(name);
+ * }
+ * }
+ *
+ * @param name Required. The resource name of the
+ * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] in the format
+ * `projects/*/secrets/*/versions/*`.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final AccessSecretVersionResponse accessSecretVersion(String name) {
+ AccessSecretVersionRequest request =
+ AccessSecretVersionRequest.newBuilder().setName(name).build();
+ return accessSecretVersion(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Accesses a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. This call returns the
+ * secret data.
+ *
+ * `projects/*/secrets/*/versions/latest` is an alias to the `latest` + * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * AccessSecretVersionRequest request =
+ * AccessSecretVersionRequest.newBuilder()
+ * .setName(SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString())
+ * .build();
+ * AccessSecretVersionResponse response =
+ * secretManagerServiceClient.accessSecretVersion(request);
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final AccessSecretVersionResponse accessSecretVersion(AccessSecretVersionRequest request) {
+ return accessSecretVersionCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Accesses a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. This call returns the
+ * secret data.
+ *
+ * `projects/*/secrets/*/versions/latest` is an alias to the `latest` + * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * AccessSecretVersionRequest request =
+ * AccessSecretVersionRequest.newBuilder()
+ * .setName(SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString())
+ * .build();
+ * ApiFuture future =
+ * secretManagerServiceClient.accessSecretVersionCallable().futureCall(request);
+ * // Do something.
+ * AccessSecretVersionResponse response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableSets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the + * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to + * [DISABLED][google.cloud.secrets.v1beta1.SecretVersion.State.DISABLED]. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * SecretVersionName name = SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]");
+ * SecretVersion response = secretManagerServiceClient.disableSecretVersion(name);
+ * }
+ * }
+ *
+ * @param name Required. The resource name of the
+ * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to disable in the format
+ * `projects/*/secrets/*/versions/*`.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final SecretVersion disableSecretVersion(SecretVersionName name) {
+ DisableSecretVersionRequest request =
+ DisableSecretVersionRequest.newBuilder()
+ .setName(name == null ? null : name.toString())
+ .build();
+ return disableSecretVersion(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Disables a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
+ *
+ * Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the + * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to + * [DISABLED][google.cloud.secrets.v1beta1.SecretVersion.State.DISABLED]. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * String name = SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString();
+ * SecretVersion response = secretManagerServiceClient.disableSecretVersion(name);
+ * }
+ * }
+ *
+ * @param name Required. The resource name of the
+ * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to disable in the format
+ * `projects/*/secrets/*/versions/*`.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final SecretVersion disableSecretVersion(String name) {
+ DisableSecretVersionRequest request =
+ DisableSecretVersionRequest.newBuilder().setName(name).build();
+ return disableSecretVersion(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Disables a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
+ *
+ * Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the + * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to + * [DISABLED][google.cloud.secrets.v1beta1.SecretVersion.State.DISABLED]. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * DisableSecretVersionRequest request =
+ * DisableSecretVersionRequest.newBuilder()
+ * .setName(SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString())
+ * .build();
+ * SecretVersion response = secretManagerServiceClient.disableSecretVersion(request);
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final SecretVersion disableSecretVersion(DisableSecretVersionRequest request) {
+ return disableSecretVersionCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Disables a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
+ *
+ * Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the + * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to + * [DISABLED][google.cloud.secrets.v1beta1.SecretVersion.State.DISABLED]. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * DisableSecretVersionRequest request =
+ * DisableSecretVersionRequest.newBuilder()
+ * .setName(SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString())
+ * .build();
+ * ApiFuture future =
+ * secretManagerServiceClient.disableSecretVersionCallable().futureCall(request);
+ * // Do something.
+ * SecretVersion response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableSets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the + * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to + * [ENABLED][google.cloud.secrets.v1beta1.SecretVersion.State.ENABLED]. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * SecretVersionName name = SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]");
+ * SecretVersion response = secretManagerServiceClient.enableSecretVersion(name);
+ * }
+ * }
+ *
+ * @param name Required. The resource name of the
+ * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to enable in the format
+ * `projects/*/secrets/*/versions/*`.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final SecretVersion enableSecretVersion(SecretVersionName name) {
+ EnableSecretVersionRequest request =
+ EnableSecretVersionRequest.newBuilder()
+ .setName(name == null ? null : name.toString())
+ .build();
+ return enableSecretVersion(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Enables a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
+ *
+ * Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the + * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to + * [ENABLED][google.cloud.secrets.v1beta1.SecretVersion.State.ENABLED]. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * String name = SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString();
+ * SecretVersion response = secretManagerServiceClient.enableSecretVersion(name);
+ * }
+ * }
+ *
+ * @param name Required. The resource name of the
+ * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to enable in the format
+ * `projects/*/secrets/*/versions/*`.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final SecretVersion enableSecretVersion(String name) {
+ EnableSecretVersionRequest request =
+ EnableSecretVersionRequest.newBuilder().setName(name).build();
+ return enableSecretVersion(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Enables a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
+ *
+ * Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the + * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to + * [ENABLED][google.cloud.secrets.v1beta1.SecretVersion.State.ENABLED]. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * EnableSecretVersionRequest request =
+ * EnableSecretVersionRequest.newBuilder()
+ * .setName(SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString())
+ * .build();
+ * SecretVersion response = secretManagerServiceClient.enableSecretVersion(request);
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final SecretVersion enableSecretVersion(EnableSecretVersionRequest request) {
+ return enableSecretVersionCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Enables a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
+ *
+ * Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the + * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to + * [ENABLED][google.cloud.secrets.v1beta1.SecretVersion.State.ENABLED]. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * EnableSecretVersionRequest request =
+ * EnableSecretVersionRequest.newBuilder()
+ * .setName(SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString())
+ * .build();
+ * ApiFuture future =
+ * secretManagerServiceClient.enableSecretVersionCallable().futureCall(request);
+ * // Do something.
+ * SecretVersion response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableSets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the + * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to + * [DESTROYED][google.cloud.secrets.v1beta1.SecretVersion.State.DESTROYED] and irrevocably + * destroys the secret data. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * SecretVersionName name = SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]");
+ * SecretVersion response = secretManagerServiceClient.destroySecretVersion(name);
+ * }
+ * }
+ *
+ * @param name Required. The resource name of the
+ * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to destroy in the format
+ * `projects/*/secrets/*/versions/*`.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final SecretVersion destroySecretVersion(SecretVersionName name) {
+ DestroySecretVersionRequest request =
+ DestroySecretVersionRequest.newBuilder()
+ .setName(name == null ? null : name.toString())
+ .build();
+ return destroySecretVersion(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Destroys a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
+ *
+ * Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the + * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to + * [DESTROYED][google.cloud.secrets.v1beta1.SecretVersion.State.DESTROYED] and irrevocably + * destroys the secret data. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * String name = SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString();
+ * SecretVersion response = secretManagerServiceClient.destroySecretVersion(name);
+ * }
+ * }
+ *
+ * @param name Required. The resource name of the
+ * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to destroy in the format
+ * `projects/*/secrets/*/versions/*`.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final SecretVersion destroySecretVersion(String name) {
+ DestroySecretVersionRequest request =
+ DestroySecretVersionRequest.newBuilder().setName(name).build();
+ return destroySecretVersion(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Destroys a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
+ *
+ * Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the + * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to + * [DESTROYED][google.cloud.secrets.v1beta1.SecretVersion.State.DESTROYED] and irrevocably + * destroys the secret data. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * DestroySecretVersionRequest request =
+ * DestroySecretVersionRequest.newBuilder()
+ * .setName(SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString())
+ * .build();
+ * SecretVersion response = secretManagerServiceClient.destroySecretVersion(request);
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final SecretVersion destroySecretVersion(DestroySecretVersionRequest request) {
+ return destroySecretVersionCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Destroys a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
+ *
+ * Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the + * [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to + * [DESTROYED][google.cloud.secrets.v1beta1.SecretVersion.State.DESTROYED] and irrevocably + * destroys the secret data. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * DestroySecretVersionRequest request =
+ * DestroySecretVersionRequest.newBuilder()
+ * .setName(SecretVersionName.of("[PROJECT]", "[SECRET]", "[SECRET_VERSION]").toString())
+ * .build();
+ * ApiFuture future =
+ * secretManagerServiceClient.destroySecretVersionCallable().futureCall(request);
+ * // Do something.
+ * SecretVersion response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallablePermissions on [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion] are enforced + * according to the policy set on the associated [Secret][google.cloud.secrets.v1beta1.Secret]. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * SetIamPolicyRequest request =
+ * SetIamPolicyRequest.newBuilder()
+ * .setResource(SecretName.of("[PROJECT]", "[SECRET]").toString())
+ * .setPolicy(Policy.newBuilder().build())
+ * .setUpdateMask(FieldMask.newBuilder().build())
+ * .build();
+ * Policy response = secretManagerServiceClient.setIamPolicy(request);
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final Policy setIamPolicy(SetIamPolicyRequest request) {
+ return setIamPolicyCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Sets the access control policy on the specified secret. Replaces any existing policy.
+ *
+ * Permissions on [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion] are enforced + * according to the policy set on the associated [Secret][google.cloud.secrets.v1beta1.Secret]. + * + *
Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * SetIamPolicyRequest request =
+ * SetIamPolicyRequest.newBuilder()
+ * .setResource(SecretName.of("[PROJECT]", "[SECRET]").toString())
+ * .setPolicy(Policy.newBuilder().build())
+ * .setUpdateMask(FieldMask.newBuilder().build())
+ * .build();
+ * ApiFuture future =
+ * secretManagerServiceClient.setIamPolicyCallable().futureCall(request);
+ * // Do something.
+ * Policy response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableSample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * GetIamPolicyRequest request =
+ * GetIamPolicyRequest.newBuilder()
+ * .setResource(SecretName.of("[PROJECT]", "[SECRET]").toString())
+ * .setOptions(GetPolicyOptions.newBuilder().build())
+ * .build();
+ * Policy response = secretManagerServiceClient.getIamPolicy(request);
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final Policy getIamPolicy(GetIamPolicyRequest request) {
+ return getIamPolicyCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Gets the access control policy for a secret. Returns empty policy if the secret exists and does
+ * not have a policy set.
+ *
+ * Sample code: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * GetIamPolicyRequest request =
+ * GetIamPolicyRequest.newBuilder()
+ * .setResource(SecretName.of("[PROJECT]", "[SECRET]").toString())
+ * .setOptions(GetPolicyOptions.newBuilder().build())
+ * .build();
+ * ApiFuture future =
+ * secretManagerServiceClient.getIamPolicyCallable().futureCall(request);
+ * // Do something.
+ * Policy response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableNote: 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: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * TestIamPermissionsRequest request =
+ * TestIamPermissionsRequest.newBuilder()
+ * .setResource(SecretName.of("[PROJECT]", "[SECRET]").toString())
+ * .addAllPermissions(new ArrayList())
+ * .build();
+ * TestIamPermissionsResponse response = secretManagerServiceClient.testIamPermissions(request);
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request) {
+ return testIamPermissionsCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * 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: + * + *
{@code
+ * // 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
+ * try (SecretManagerServiceClient secretManagerServiceClient =
+ * SecretManagerServiceClient.create()) {
+ * TestIamPermissionsRequest request =
+ * TestIamPermissionsRequest.newBuilder()
+ * .setResource(SecretName.of("[PROJECT]", "[SECRET]").toString())
+ * .addAllPermissions(new ArrayList())
+ * .build();
+ * ApiFuture future =
+ * secretManagerServiceClient.testIamPermissionsCallable().futureCall(request);
+ * // Do something.
+ * TestIamPermissionsResponse response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableThe default instance has everything set to sensible defaults: + * + *
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: + * + *
{@code
+ * // 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
+ * SecretManagerServiceSettings.Builder secretManagerServiceSettingsBuilder =
+ * SecretManagerServiceSettings.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());
+ * SecretManagerServiceSettings secretManagerServiceSettings =
+ * secretManagerServiceSettingsBuilder.build();
+ * }
+ *
+ * Please refer to the [Client Side Retry
+ * Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for
+ * additional support in setting retries.
+ */
+@BetaApi
+@Generated("by gapic-generator-java")
+public class SecretManagerServiceSettings extends ClientSettingsNote: This method does not support applying settings to streaming methods.
+ */
+ public Builder applyToAllUnaryMethods(
+ ApiFunction The interfaces provided are listed below, along with usage samples.
+ *
+ * ======================= SecretManagerServiceClient =======================
+ *
+ * Service Description: Secret Manager Service
+ *
+ * Manages secrets and operations using those secrets. Implements a REST model with the following
+ * objects:
+ *
+ * Sample for SecretManagerServiceClient:
+ *
+ * This class is for advanced usage.
+ */
+@BetaApi
+@Generated("by gapic-generator-java")
+public class GrpcSecretManagerServiceCallableFactory implements GrpcStubCallableFactory {
+
+ @Override
+ public This class is for advanced usage and reflects the underlying API directly.
+ */
+@BetaApi
+@Generated("by gapic-generator-java")
+public class GrpcSecretManagerServiceStub extends SecretManagerServiceStub {
+ private static final MethodDescriptor This class is for advanced usage.
+ */
+@BetaApi
+@Generated("by gapic-generator-java")
+public class HttpJsonSecretManagerServiceCallableFactory
+ implements HttpJsonStubCallableFactory This class is for advanced usage and reflects the underlying API directly.
+ */
+@BetaApi
+@Generated("by gapic-generator-java")
+public class HttpJsonSecretManagerServiceStub extends SecretManagerServiceStub {
+ private static final TypeRegistry typeRegistry = TypeRegistry.newBuilder().build();
+
+ private static final ApiMethodDescriptor
+ *
+ *
+ * {@code
+ * // 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
+ * 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);
+ * }
+ * }
+ */
+@Generated("by gapic-generator-java")
+package com.google.cloud.secretmanager.v1beta1;
+
+import javax.annotation.Generated;
diff --git a/java-secretmanager/google-cloud-secretmanager/src/main/java/com/google/cloud/secretmanager/v1beta1/stub/GrpcSecretManagerServiceCallableFactory.java b/java-secretmanager/google-cloud-secretmanager/src/main/java/com/google/cloud/secretmanager/v1beta1/stub/GrpcSecretManagerServiceCallableFactory.java
new file mode 100644
index 000000000000..7924eefaf2ff
--- /dev/null
+++ b/java-secretmanager/google-cloud-secretmanager/src/main/java/com/google/cloud/secretmanager/v1beta1/stub/GrpcSecretManagerServiceCallableFactory.java
@@ -0,0 +1,115 @@
+/*
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.cloud.secretmanager.v1beta1.stub;
+
+import com.google.api.core.BetaApi;
+import com.google.api.gax.grpc.GrpcCallSettings;
+import com.google.api.gax.grpc.GrpcCallableFactory;
+import com.google.api.gax.grpc.GrpcStubCallableFactory;
+import com.google.api.gax.rpc.BatchingCallSettings;
+import com.google.api.gax.rpc.BidiStreamingCallable;
+import com.google.api.gax.rpc.ClientContext;
+import com.google.api.gax.rpc.ClientStreamingCallable;
+import com.google.api.gax.rpc.OperationCallSettings;
+import com.google.api.gax.rpc.OperationCallable;
+import com.google.api.gax.rpc.PagedCallSettings;
+import com.google.api.gax.rpc.ServerStreamingCallSettings;
+import com.google.api.gax.rpc.ServerStreamingCallable;
+import com.google.api.gax.rpc.StreamingCallSettings;
+import com.google.api.gax.rpc.UnaryCallSettings;
+import com.google.api.gax.rpc.UnaryCallable;
+import com.google.longrunning.Operation;
+import com.google.longrunning.stub.OperationsStub;
+import javax.annotation.Generated;
+
+// AUTO-GENERATED DOCUMENTATION AND CLASS.
+/**
+ * gRPC callable factory implementation for the SecretManagerService service API.
+ *
+ *