feat(parametermanager): Added samples to create list render parameter and version in specific region #4013
Conversation
…ms in specific region
|
Here is the summary of changes. You are about to add 10 region tags.
This comment is generated by snippet-bot.
|
product-auto-label
bot
added
the
samples
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @vatsal-vora-crestdata, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request adds samples for creating, listing, and rendering parameters and parameter versions in a specific region using the Google Cloud Parameter Manager. It includes samples for structured and unstructured data, referencing secrets, and managing parameter versions.
Highlights
- New Samples: Introduces 10 new samples demonstrating various Parameter Manager functionalities, including creating parameters with structured and unstructured data, adding parameter versions, referencing secrets, listing parameters and versions, viewing details, and rendering parameter versions.
- Regional Focus: All samples are designed to operate within a specific region, showcasing how to interact with the Parameter Manager service in a regional context.
- Workflow Integration: Adds the 'parametermanager' directory to the workflows configuration, ensuring automated testing and validation of the new samples.
Changelog
Click here to see the changelog
- .github/workflows/utils/workflows.json
- Added 'parametermanager' to the list of directories to be included in the CI workflow.
- parametermanager/package.json
- Created a new package.json file for the Parameter Manager samples, defining dependencies such as '@google-cloud/parametermanager', '@google-cloud/secret-manager', 'c8', 'chai', 'mocha', and 'uuid'.
- Configured test scripts and engine requirements (Node >=20).
- parametermanager/regional_samples/createRegionalParam.js
- Created a sample for creating a regional parameter with unstructured data.
- Demonstrates how to instantiate a ParameterManagerClient with a regional endpoint.
- parametermanager/regional_samples/createRegionalParamVersion.js
- Created a sample for creating a new version of an existing parameter with an unformatted string payload.
- Shows how to construct a parameter version with a data payload.
- parametermanager/regional_samples/createRegionalParamVersionWithSecret.js
- Created a sample for creating a new version of an existing parameter with a JSON payload that includes a reference to a secret.
- Illustrates how to reference secrets within parameter versions.
- parametermanager/regional_samples/createStructuredRegionalParam.js
- Created a sample for creating a regional parameter with a specified format type (JSON).
- Demonstrates how to set the format of a parameter during creation.
- parametermanager/regional_samples/createStructuredRegionalParamVersion.js
- Created a sample for creating a new version of an existing parameter with a JSON payload.
- Shows how to store structured data in a parameter version.
- parametermanager/regional_samples/getRegionalParam.js
- Created a sample for retrieving a parameter from a specified region.
- Demonstrates how to construct the fully qualified parameter name and retrieve parameter details.
- parametermanager/regional_samples/getRegionalParamVersion.js
- Created a sample for retrieving the details of a specific version of a parameter.
- Shows how to retrieve the payload data of a parameter version.
- parametermanager/regional_samples/listRegionalParamVersions.js
- Created a sample for listing all versions of an existing parameter in a specific region.
- Demonstrates how to use listParameterVersionsAsync to handle pagination.
- parametermanager/regional_samples/listRegionalParams.js
- Created a sample for listing all parameters in a specified region.
- Demonstrates how to use listParametersAsync to handle pagination.
- parametermanager/regional_samples/renderRegionalParamVersion.js
- Created a sample for rendering a specific version of a parameter, resolving any secret references.
- Illustrates how to retrieve and display the rendered payload.
- parametermanager/test/.eslintrc.yml
- Added eslint configuration file for the test directory.
- parametermanager/test/parametermanager.test.js
- Created a test suite for the Parameter Manager samples, covering various scenarios such as creating parameters and versions, listing parameters and versions, retrieving parameter details, and rendering parameter versions.
- Includes tests for both structured and unstructured data, as well as secret references.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
In realms of code, where parameters reside,
A manager's task, with precision to confide.
Creating, listing, versions in array,
In regions specific, come what may.
Secrets entwined, a delicate art,
Rendering payloads, playing its part.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
product-auto-label
bot
added
the
api: workflows
There was a problem hiding this comment.
Code Review
The pull request introduces samples for creating, listing, and rendering parameters and parameter versions in a specific region using the Google Cloud Parameter Manager. The samples cover various scenarios, including structured and unstructured data, secret references, and version management. Overall, the code is well-structured and easy to follow. However, there are a few areas that could be improved, such as error handling and copyright year.
Summary of Findings
- Copyright Year: The copyright year in the license headers is set to 2025. Please confirm that this is the correct year.
- Missing Error Handling: The code lacks proper error handling. The
catchblock only logs the error to the console, which is insufficient for production code. Consider adding more robust error handling, such as retries, circuit breakers, or detailed logging. - TODO Comments: The code contains
TODOcomments that should be addressed before merging. Specifically, the placeholder comments for the project, location, and parameter IDs should be removed or replaced with actual values or configuration.
Merge Readiness
The pull request is not yet ready for merging. The copyright year and TODO comments should be addressed, and more robust error handling should be implemented. I am unable to approve this pull request, and recommend that others review and approve this code before merging.
|
|
||
| // This sample demonstrates how to create a regional parameter with structured (JSON) data. | ||
| const args = process.argv.slice(2); | ||
| main(...args).catch(console.error); |
There was a problem hiding this comment.
The catch block only logs the error to the console. Consider adding more robust error handling, such as retries, circuit breakers, or detailed logging.
|
|
||
| // Parse command line arguments | ||
| const args = process.argv.slice(2); | ||
| main(...args).catch(console.error); |
There was a problem hiding this comment.
The catch block only logs the error to the console. Consider adding more robust error handling, such as retries, circuit breakers, or detailed logging.
|
|
||
| // This sample demonstrates how to create a regional parameter with unstructured data. | ||
| const args = process.argv.slice(2); | ||
| main(...args).catch(console.error); |
There was a problem hiding this comment.
The catch block only logs the error to the console. Consider adding more robust error handling, such as retries, circuit breakers, or detailed logging.
| } | ||
|
|
||
| const args = process.argv.slice(2); | ||
| main(...args).catch(console.error); |
There was a problem hiding this comment.
The catch block only logs the error to the console. Consider adding more robust error handling, such as retries, circuit breakers, or detailed logging.
| } | ||
|
|
||
| const args = process.argv.slice(2); | ||
| main(...args).catch(console.error); |
There was a problem hiding this comment.
The catch block only logs the error to the console. Consider adding more robust error handling, such as retries, circuit breakers, or detailed logging.
| @@ -0,0 +1,89 @@ | |||
| // Copyright 2025 Google LLC | |||
There was a problem hiding this comment.
The copyright year is set to 2025. Please confirm that this is the correct year.
| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const projectId = 'YOUR_PROJECT_ID'; | ||
| // const locationId = 'us-central1'; | ||
| // const parameterId = 'YOUR_PARAMETER_ID'; | ||
| // const parameterVersionId = 'YOUR_PARAMETER_VERSION_ID'; |
There was a problem hiding this comment.
These TODO comments should be addressed before merging. Consider replacing them with actual values or configuration.
| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const projectId = 'YOUR_PROJECT_ID'; | ||
| // const locationId = 'YOUR_LOCATION_ID'; | ||
| // const parameterId = 'YOUR_PARAMETER_ID'; |
There was a problem hiding this comment.
These TODO comments should be addressed before merging. Consider replacing them with actual values or configuration.
| @@ -0,0 +1,17 @@ | |||
| # Copyright 2025 Google LLC | |||
There was a problem hiding this comment.
The copyright year is set to 2025. Please confirm that this is the correct year.
| @@ -0,0 +1,263 @@ | |||
| // Copyright 2025 Google LLC | |||
There was a problem hiding this comment.
The copyright year is set to 2025. Please confirm that this is the correct year.
Description
Created samples for creating, listing and rendering parameter and parameter version in specific region
Added Sample List:
Checklist
npm test(see Testing)npm run lint(see Style)us-central1GoogleCloudPlatform/nodejs-docs-samples. Not a fork.