feat(parametermanager): Added samples for create, get, list and render global parameter & parameter version

parametermanager/createParam.js

@@ -0,0 +1,64 @@
+// 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.
+
+'use strict';
+
+/**
+ * Creates a global parameter using the Parameter Manager SDK.
+ *
+ * @param {string} projectId - The Google Cloud project ID where the parameter is to be created.
+ * @param {string} parameterId - The ID of the parameter to create. This ID must be unique within the project.
+ */
+async function main(projectId, parameterId) {
+  // [START parametermanager_create_param]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // const projectId = 'YOUR_PROJECT_ID';
+  // const parameterId = 'YOUR_PARAMETER_ID';
+
+  // Imports the Parameter Manager library
+  const {ParameterManagerClient} = require('@google-cloud/parametermanager');
+
+  // Instantiates a client
+  const client = new ParameterManagerClient();
+
+  async function createParam() {
+    const parent = client.locationPath(projectId, 'global');
+    const request = {
+      parent: parent,
+      parameterId: parameterId,
+    };
+
+    const [parameter] = await client.createParameter(request);
+    console.log(`Created parameter: ${parameter.name}`);
+    return parameter;
+  }
+
+  return await createParam();
+  // [END parametermanager_create_param]
+}
+module.exports.main = main;
+
+/* c8 ignore next 10 */
+if (require.main === module) {
+  main(...process.argv.slice(2)).catch(err => {
+    console.error(err.message);
+    process.exitCode = 1;
+  });
+  process.on('unhandledRejection', err => {
+    console.error(err.message);
+    process.exitCode = 1;
+  });
+}

parametermanager/createParamVersion.js

@@ -0,0 +1,80 @@
+// 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.
+
+'use strict';
+
+/**
+ * Creates a parameter version globally for unstructured data.
+ *
+ * @param {string} projectId - The Google Cloud project ID where the parameter is to be created
+ * @param {string} parameterId - The ID of the parameter for which the version is to be created.
+ * @param {string} parameterVersionId - The ID of the parameter version to be created.
+ * @param {string} payload - The unformatted string payload to be stored in the new parameter version.
+ */
+async function main(projectId, parameterId, parameterVersionId, payload) {
+  // [START parametermanager_create_param_version]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // const projectId = 'YOUR_PROJECT_ID';
+  // const parameterId = 'YOUR_PARAMETER_ID';
+  // const parameterVersionId = 'YOUR_PARAMETER_VERSION_ID';
+  // const payload = 'This is unstructured data';
+
+  // Imports the Parameter Manager library
+  const {ParameterManagerClient} = require('@google-cloud/parametermanager');
+
+  // Instantiates a client
+  const client = new ParameterManagerClient();
+
+  async function createParamVersion() {
+    // Construct the parent resource name
+    const parent = client.parameterPath(projectId, 'global', parameterId);
+
+    // Construct the parameter version
+    const parameterVersion = {
+      payload: {
+        data: Buffer.from(payload, 'utf8'),
+      },
+    };
+
+    // Construct the request
+    const request = {
+      parent: parent,
+      parameterVersionId: parameterVersionId,
+      parameterVersion: parameterVersion,
+    };
+
+    // Create the parameter version
+    const [paramVersion] = await client.createParameterVersion(request);
+    console.log(`Created parameter version: ${paramVersion.name}`);
+    return paramVersion;
+  }
+
+  return await createParamVersion();
+  // [END parametermanager_create_param_version]
+}
+module.exports.main = main;
+
+/* c8 ignore next 10 */
+if (require.main === module) {
+  main(...process.argv.slice(2)).catch(err => {
+    console.error(err.message);
+    process.exitCode = 1;
+  });
+  process.on('unhandledRejection', err => {
+    console.error(err.message);
+    process.exitCode = 1;
+  });
+}

parametermanager/createParamVersionWithSecret.js

@@ -0,0 +1,90 @@
+// 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.
+
+'use strict';
+
+/**
+ * Creates a new version of an existing parameter in the global location
+ * of the specified project using the Google Cloud Parameter Manager SDK.
+ * The payload is specified as a JSON string and includes a reference to a secret.
+ *
+ * @param {string} projectId - The Google Cloud project ID where the parameter is located.
+ * @param {string} parameterId - The ID of the parameter for which the version is to be created.
+ * @param {string} parameterVersionId - The ID of the parameter version to be created.
+ * @param {string} secretId - The ID of the secret to be referenced.
+ */
+async function main(projectId, parameterId, parameterVersionId, secretId) {
+  // [START parametermanager_create_param_version_with_secret]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // const projectId = 'YOUR_PROJECT_ID';
+  // const parameterId = 'YOUR_PARAMETER_ID';
+  // const parameterVersionId = 'YOUR_PARAMETER_VERSION_ID';
+  // const secretId = 'YOUR_SECRET_ID'; // For example projects/my-project/secrets/application-secret/version/latest
+
+  // Imports the Parameter Manager library
+  const {ParameterManagerClient} = require('@google-cloud/parametermanager');
+
+  // Instantiates a client
+  const client = new ParameterManagerClient();
+
+  async function createParamVersionWithSecret() {
+    // Construct the parent resource name
+    const parent = client.parameterPath(projectId, 'global', parameterId);
+
+    // Construct the JSON data with secret references
+    const jsonData = {
+      db_user: 'test_user',
+      db_password: `__REF__(//secretmanager.googleapis.com/${secretId})`,
+    };
+
+    // Construct the parameter version
+    const parameterVersion = {
+      payload: {
+        data: Buffer.from(JSON.stringify(jsonData), 'utf8'),
+      },
+    };
+
+    // Construct the request
+    const request = {
+      parent: parent,
+      parameterVersionId: parameterVersionId,
+      parameterVersion: parameterVersion,
+    };
+
+    // Create the parameter version
+    const [paramVersion] = await client.createParameterVersion(request);
+    console.log(
+      `Created parameter version with secret references: ${paramVersion.name}`
+    );
+    return paramVersion;
+  }
+
+  return await createParamVersionWithSecret();
+  // [END parametermanager_create_param_version_with_secret]
+}
+module.exports.main = main;
+
+/* c8 ignore next 10 */
+if (require.main === module) {
+  main(...process.argv.slice(2)).catch(err => {
+    console.error(err.message);
+    process.exitCode = 1;
+  });
+  process.on('unhandledRejection', err => {
+    console.error(err.message);
+    process.exitCode = 1;
+  });
+}

parametermanager/createStructuredParam.js

@@ -0,0 +1,73 @@
+// 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.
+
+'use strict';
+
+/**
+ * Creates a parameter in the global location of the specified
+ * project with specified format using the Google Cloud Parameter Manager SDK.
+ *
+ * @param {string} projectId - The Google Cloud project ID where the parameter is to be created.
+ * @param {string} parameterId - The ID of the parameter to create. This ID must be unique within the project.
+ * @param {string} formatType - The format type of the parameter (UNFORMATTED, YAML, JSON).
+ */
+async function main(projectId, parameterId, formatType) {
+  // [START parametermanager_create_structured_param]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // const {protos} = require('@google-cloud/parametermanager');
+  // const projectId = 'YOUR_PROJECT_ID';
+  // const parameterId = 'YOUR_PARAMETER_ID';
+  // const formatType = protos.google.cloud.parametermanager.v1.ParameterFormat.JSON;
+
+  // Imports the Parameter Manager library
+  const {ParameterManagerClient} = require('@google-cloud/parametermanager');
+
+  // Instantiates a client
+  const client = new ParameterManagerClient();
+
+  async function createStructuredParam() {
+    const parent = client.locationPath(projectId, 'global');
+    const request = {
+      parent: parent,
+      parameterId: parameterId,
+      parameter: {
+        format: formatType,
+      },
+    };
+
+    const [parameter] = await client.createParameter(request);
+    console.log(
+      `Created parameter ${parameter.name} with format ${parameter.format}`
+    );
+    return parameter;
+  }
+
+  return await createStructuredParam();
+  // [END parametermanager_create_structured_param]
+}
+module.exports.main = main;
+
+/* c8 ignore next 10 */
+if (require.main === module) {
+  main(...process.argv.slice(2)).catch(err => {
+    console.error(err.message);
+    process.exitCode = 1;
+  });
+  process.on('unhandledRejection', err => {
+    console.error(err.message);
+    process.exitCode = 1;
+  });
+}

parametermanager/createStructuredParamVersion.js

@@ -0,0 +1,82 @@
+// 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.
+
+'use strict';
+
+/**
+ * Creates a new version of an existing parameter in the global location
+ * of the specified project using the Google Cloud Parameter Manager SDK.
+ * The payload is specified as a JSON format.
+ *
+ * @param {string} projectId - The Google Cloud project ID where the parameter is to be created.
+ * @param {string} parameterId - The ID of the parameter to create. This ID must be unique within the project.
+ * @param {string} parameterVersionId - The ID of the parameter version to be created.
+ * @param {Object} payload - The JSON payload data to be stored in the parameter version.
+ */
+async function main(projectId, parameterId, parameterVersionId, payload) {
+  // [START parametermanager_create_structured_param_version]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // const projectId = 'YOUR_PROJECT_ID';
+  // const parameterId = 'YOUR_PARAMETER_ID';
+  // const parameterVersionId = 'YOUR_PARAMETER_VERSION_ID';
+  // const jsonData = {username: "test-user", host: "localhost"};
+
+  // Imports the Parameter Manager library
+  const {ParameterManagerClient} = require('@google-cloud/parametermanager');
+
+  // Instantiates a client
+  const client = new ParameterManagerClient();
+
+  async function createStructuredParamVersion() {
+    // Construct the parent resource name
+    const parent = client.parameterPath(projectId, 'global', parameterId);
+
+    // Construct the parameter version
+    const parameterVersion = {
+      payload: {
+        data: Buffer.from(JSON.stringify(payload), 'utf8'),
+      },
+    };
+
+    // Construct the request
+    const request = {
+      parent: parent,
+      parameterVersionId: parameterVersionId,
+      parameterVersion: parameterVersion,
+    };
+
+    // Create the parameter version
+    const [paramVersion] = await client.createParameterVersion(request);
+    console.log(`Created parameter version: ${paramVersion.name}`);
+    return paramVersion;
+  }
+
+  return await createStructuredParamVersion();
+  // [END parametermanager_create_structured_param_version]
+}
+module.exports.main = main;
+
+/* c8 ignore next 10 */
+if (require.main === module) {
+  main(...process.argv.slice(2)).catch(err => {
+    console.error(err.message);
+    process.exitCode = 1;
+  });
+  process.on('unhandledRejection', err => {
+    console.error(err.message);
+    process.exitCode = 1;
+  });
+}