feat(parametermanager): Added samples to view, list and render parameter in specified region

parametermanager/src/main/java/parametermanager/regionalsamples/GetRegionalParam.java

@@ -0,0 +1,68 @@
+/*
+ * 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
+ *
+ * http://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 parametermanager.regionalsamples;
+
+// [START parametermanager_get_regional_param]
+
+import com.google.cloud.parametermanager.v1.Parameter;
+import com.google.cloud.parametermanager.v1.ParameterManagerClient;
+import com.google.cloud.parametermanager.v1.ParameterManagerSettings;
+import com.google.cloud.parametermanager.v1.ParameterName;
+import java.io.IOException;
+
+/**
+ * This class demonstrates how to get a regional parameter using the Parameter Manager SDK for GCP.
+ */
+public class GetRegionalParam {
+
+  public static void main(String[] args) throws IOException {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "your-project-id";
+    String locationId = "your-location-id";
+    String parameterId = "your-parameter-id";
+
+    // Call the method to get a regional parameter.
+    getRegionalParam(projectId, locationId, parameterId);
+  }
+
+  // This is an example snippet that gets a regional parameter.
+  public static Parameter getRegionalParam(String projectId, String locationId, String parameterId)
+      throws IOException {
+    // Endpoint to call the regional parameter manager server
+    String apiEndpoint = String.format("parametermanager.%s.rep.googleapis.com:443", locationId);
+    ParameterManagerSettings parameterManagerSettings =
+        ParameterManagerSettings.newBuilder().setEndpoint(apiEndpoint).build();
+
+    // Initialize the client that will be used to send requests. This client only
+    // needs to be created once, and can be reused for multiple requests.
+    try (ParameterManagerClient client = ParameterManagerClient.create(parameterManagerSettings)) {
+      // Build the parameter name.
+      ParameterName parameterName = ParameterName.of(projectId, locationId, parameterId);
+
+      // Get the parameter.
+      Parameter parameter = client.getParameter(parameterName.toString());
+      // Find more details for the Parameter object here:
+      // https://cloud.google.com/secret-manager/parameter-manager/docs/reference/rest/v1/projects.locations.parameters#Parameter
+      System.out.printf(
+          "Found the regional parameter %s with format %s\n",
+          parameter.getName(), parameter.getFormat());
+
+      return parameter;
+    }
+  }
+}
+// [END parametermanager_get_regional_param]

parametermanager/src/main/java/parametermanager/regionalsamples/GetRegionalParamVersion.java

@@ -0,0 +1,75 @@
+/*
+ * 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
+ *
+ * http://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 parametermanager.regionalsamples;
+
+// [START parametermanager_get_regional_param_version]
+
+import com.google.cloud.parametermanager.v1.ParameterManagerClient;
+import com.google.cloud.parametermanager.v1.ParameterManagerSettings;
+import com.google.cloud.parametermanager.v1.ParameterVersion;
+import com.google.cloud.parametermanager.v1.ParameterVersionName;
+import java.io.IOException;
+
+/**
+ * This class demonstrates how to get a regional parameter version using the Parameter Manager SDK
+ * for GCP.
+ */
+public class GetRegionalParamVersion {
+
+  public static void main(String[] args) throws IOException {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "your-project-id";
+    String locationId = "your-location-id";
+    String parameterId = "your-parameter-id";
+    String versionId = "your-version-id";
+
+    // Call the method to get a regional parameter version.
+    getRegionalParamVersion(projectId, locationId, parameterId, versionId);
+  }
+
+  // This is an example snippet that gets a regional parameter version.
+  public static ParameterVersion getRegionalParamVersion(
+      String projectId, String locationId, String parameterId, String versionId)
+      throws IOException {
+    // Endpoint to call the regional parameter manager server
+    String apiEndpoint = String.format("parametermanager.%s.rep.googleapis.com:443", locationId);
+    ParameterManagerSettings parameterManagerSettings =
+        ParameterManagerSettings.newBuilder().setEndpoint(apiEndpoint).build();
+
+    // Initialize the client that will be used to send requests. This client only
+    // needs to be created once, and can be reused for multiple requests.
+    try (ParameterManagerClient client = ParameterManagerClient.create(parameterManagerSettings)) {
+      // Build the parameter version name.
+      ParameterVersionName parameterVersionName =
+          ParameterVersionName.of(projectId, locationId, parameterId, versionId);
+
+      // Get the parameter version.
+      ParameterVersion parameterVersion =
+          client.getParameterVersion(parameterVersionName.toString());
+      // Find more details for the Parameter Version object here:
+      // https://cloud.google.com/secret-manager/parameter-manager/docs/reference/rest/v1/projects.locations.parameters.versions#ParameterVersion
+      System.out.printf(
+          "Found regional parameter version %s with state %s\n",
+          parameterVersion.getName(), (parameterVersion.getDisabled() ? "disabled" : "enabled"));
+      if (!parameterVersion.getDisabled()) {
+        System.out.printf("Payload: %s", parameterVersion.getPayload().getData().toStringUtf8());
+      }
+      return parameterVersion;
+    }
+  }
+}
+// [END parametermanager_get_regional_param_version]

parametermanager/src/main/java/parametermanager/regionalsamples/ListRegionalParamVersions.java

@@ -0,0 +1,79 @@
+/*
+ * 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
+ *
+ * http://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 parametermanager.regionalsamples;
+
+// [START parametermanager_list_regional_param_versions]
+
+import com.google.cloud.parametermanager.v1.ListParameterVersionsRequest;
+import com.google.cloud.parametermanager.v1.ParameterManagerClient;
+import com.google.cloud.parametermanager.v1.ParameterManagerClient.ListParameterVersionsPagedResponse;
+import com.google.cloud.parametermanager.v1.ParameterManagerSettings;
+import com.google.cloud.parametermanager.v1.ParameterName;
+import java.io.IOException;
+
+/**
+ * Class to list parameter versions for a specified region using the Parameter Manager SDK
+ * for GCP.
+ */
+public class ListRegionalParamVersions {
+
+  public static void main(String[] args) throws IOException {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "your-project-id";
+    String locationId = "your-location-id";
+    String parameterId = "your-parameter-id";
+
+    // Call the method to list parameter versions regionally.
+    listRegionalParamVersions(projectId, locationId, parameterId);
+  }
+
+  // This is an example snippet that list all parameter versions regionally
+  public static ListParameterVersionsPagedResponse listRegionalParamVersions(
+      String projectId, String locationId, String parameterId) throws IOException {
+    // Endpoint to call the regional parameter manager server
+    String apiEndpoint = String.format("parametermanager.%s.rep.googleapis.com:443", locationId);
+    ParameterManagerSettings parameterManagerSettings =
+        ParameterManagerSettings.newBuilder().setEndpoint(apiEndpoint).build();
+
+    // Initialize the client that will be used to send requests. This client only needs to be
+    // created once,
+    // and can be reused for multiple requests.
+    try (ParameterManagerClient client = ParameterManagerClient.create(parameterManagerSettings)) {
+      // Build the parameter name from the project and parameter ID.
+      ParameterName parameterName = ParameterName.of(projectId, locationId, parameterId);
+
+      // Build the request to list parameter versions.
+      ListParameterVersionsRequest request =
+          ListParameterVersionsRequest.newBuilder().setParent(parameterName.toString()).build();
+
+      // Send the request and get the response.
+      ListParameterVersionsPagedResponse response = client.listParameterVersions(request);
+
+      // Iterate through all versions and print their details.
+      response
+          .iterateAll()
+          .forEach(
+              version ->
+                  System.out.printf(
+                      "Found regional parameter version %s with state %s\n",
+                      version.getName(), (version.getDisabled() ? "disabled" : "enabled")));
+
+      return response;
+    }
+  }
+}
+// [END parametermanager_list_regional_param_versions]

parametermanager/src/main/java/parametermanager/regionalsamples/ListRegionalParams.java

@@ -0,0 +1,70 @@
+/*
+ * 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
+ *
+ * http://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 parametermanager.regionalsamples;
+
+// [START parametermanager_list_regional_params]
+
+import com.google.cloud.parametermanager.v1.LocationName;
+import com.google.cloud.parametermanager.v1.ParameterManagerClient;
+import com.google.cloud.parametermanager.v1.ParameterManagerClient.ListParametersPagedResponse;
+import com.google.cloud.parametermanager.v1.ParameterManagerSettings;
+import java.io.IOException;
+
+/**
+ * Class to demonstrate listing parameters for a specified region using the Parameter Manager SDK
+ * for GCP.
+ */
+public class ListRegionalParams {
+
+  public static void main(String[] args) throws IOException {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "your-project-id";
+    String locationId = "your-location-id";
+
+    // Call the method to list parameters regionally.
+    listRegionalParams(projectId, locationId);
+  }
+
+  // This is an example snippet that list all parameters in a given region.
+  public static ListParametersPagedResponse listRegionalParams(String projectId, String locationId)
+      throws IOException {
+    // Endpoint to call the regional parameter manager server
+    String apiEndpoint = String.format("parametermanager.%s.rep.googleapis.com:443", locationId);
+    ParameterManagerSettings parameterManagerSettings =
+        ParameterManagerSettings.newBuilder().setEndpoint(apiEndpoint).build();
+
+    // Initialize the client that will be used to send requests. This client only
+    // needs to be created once, and can be reused for multiple requests.
+    try (ParameterManagerClient client = ParameterManagerClient.create(parameterManagerSettings)) {
+      // Build the parent name from the project.
+      LocationName location = LocationName.of(projectId, locationId);
+
+      // Get all parameters.
+      ListParametersPagedResponse response = client.listParameters(location.toString());
+
+      // List all parameters.
+      response
+          .iterateAll()
+          .forEach(parameter ->
+                  System.out.printf("Found regional parameter %s with format %s\n",
+                          parameter.getName(), parameter.getFormat()));
+
+      return response;
+    }
+  }
+}
+// [END parametermanager_list_regional_params]

parametermanager/src/main/java/parametermanager/regionalsamples/RenderRegionalParamVersion.java

@@ -0,0 +1,71 @@
+/*
+ * 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
+ *
+ * http://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 parametermanager.regionalsamples;
+
+// [START parametermanager_render_regional_param_version]
+
+import com.google.cloud.parametermanager.v1.ParameterManagerClient;
+import com.google.cloud.parametermanager.v1.ParameterManagerSettings;
+import com.google.cloud.parametermanager.v1.ParameterVersionName;
+import com.google.cloud.parametermanager.v1.RenderParameterVersionResponse;
+import java.io.IOException;
+
+/**
+ * This class demonstrates how to render a regional parameter version using the Parameter Manager
+ * SDK for GCP.
+ */
+public class RenderRegionalParamVersion {
+
+  public static void main(String[] args) throws IOException {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "your-project-id";
+    String locationId = "your-location-id";
+    String parameterId = "your-parameter-id";
+    String versionId = "your-version-id";
+
+    // Call the method to render a regional parameter version.
+    renderRegionalParamVersion(projectId, locationId, parameterId, versionId);
+  }
+
+  // This is an example snippet to render a regional parameter version.
+  public static RenderParameterVersionResponse renderRegionalParamVersion(
+      String projectId, String locationId, String parameterId, String versionId)
+      throws IOException {
+    // Endpoint to call the regional parameter manager server
+    String apiEndpoint = String.format("parametermanager.%s.rep.googleapis.com:443", locationId);
+    ParameterManagerSettings parameterManagerSettings =
+        ParameterManagerSettings.newBuilder().setEndpoint(apiEndpoint).build();
+
+    // Initialize the client that will be used to send requests. This client only
+    // needs to be created once, and can be reused for multiple requests.
+    try (ParameterManagerClient client = ParameterManagerClient.create(parameterManagerSettings)) {
+      // Build the parameter version name.
+      ParameterVersionName parameterVersionName =
+          ParameterVersionName.of(projectId, locationId, parameterId, versionId);
+
+      // Render the parameter version.
+      RenderParameterVersionResponse response =
+          client.renderParameterVersion(parameterVersionName.toString());
+      System.out.printf(
+          "Rendered regional parameter version payload: %s\n",
+          response.getRenderedPayload().toStringUtf8());
+
+      return response;
+    }
+  }
+}
+// [END parametermanager_render_regional_param_version]