feat(parametermanager): Added samples for get and list global parameters (#5258)

* feat(parametermanager): Added samples for get and list global parameters

* fix(parametermanager): fix linting issue

---------

Co-authored-by: Arpan Goswami <[email protected]>

Author: durgesh-ninave-crest

parametermanager/get_param.go

@@ -0,0 +1,63 @@
+// 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 parametermanager
+
+// [START parametermanager_get_param]
+import (
+	"context"
+	"fmt"
+	"io"
+
+	parametermanager "cloud.google.com/go/parametermanager/apiv1"
+	parametermanagerpb "cloud.google.com/go/parametermanager/apiv1/parametermanagerpb"
+)
+
+// getParam get parameter using the Parameter Manager SDK for GCP.
+//
+// w: The io.Writer object used to write the output.
+// projectID: The ID of the project where the parameter is located.
+// parameterID: The ID of the parameter to retrieved.
+//
+// The function returns an error if the parameter retrieval fails.
+func getParam(w io.Writer, projectID, parameterID string) error {
+	// Create a context and a Parameter Manager client.
+	ctx := context.Background()
+	client, err := parametermanager.NewClient(ctx)
+	if err != nil {
+		return fmt.Errorf("failed to create Parameter Manager client: %w", err)
+	}
+	defer client.Close()
+
+	// Construct the name of the parameter to get parameter.
+	name := fmt.Sprintf("projects/%s/locations/global/parameters/%s", projectID, parameterID)
+
+	// Build the request to get parameter.
+	req := &parametermanagerpb.GetParameterRequest{
+		Name: name,
+	}
+
+	// Call the API to get parameter.
+	param, err := client.GetParameter(ctx, req)
+	if err != nil {
+		return fmt.Errorf("failed to get parameter: %w", err)
+	}
+
+	// Find more details for the Parameter object here:
+	// https://cloud.google.com/secret-manager/parameter-manager/docs/reference/rest/v1/projects.locations.parameters#Parameter
+	fmt.Fprintf(w, "Found parameter %s with format %s\n", param.Name, param.Format.String())
+	return nil
+}
+
+// [END parametermanager_get_param]

parametermanager/list_param.go

@@ -0,0 +1,67 @@
+// 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 parametermanager
+
+// [START parametermanager_list_params]
+import (
+	"context"
+	"fmt"
+	"io"
+
+	parametermanager "cloud.google.com/go/parametermanager/apiv1"
+	parametermanagerpb "cloud.google.com/go/parametermanager/apiv1/parametermanagerpb"
+	"google.golang.org/api/iterator"
+)
+
+// listParam lists parameters using the Parameter Manager SDK for GCP.
+//
+// w: The io.Writer object used to write the output.
+// projectID: The ID of the project where the parameters are located.
+//
+// The function returns an error if the parameter listing fails.
+func listParams(w io.Writer, projectID string) error {
+	// Create a context and a Parameter Manager client.
+	ctx := context.Background()
+	client, err := parametermanager.NewClient(ctx)
+	if err != nil {
+		return fmt.Errorf("failed to create Parameter Manager client: %w", err)
+	}
+	defer client.Close()
+
+	// Construct the name of the list parameter.
+	parent := fmt.Sprintf("projects/%s/locations/global", projectID)
+	// Build the request to list parameters.
+	req := &parametermanagerpb.ListParametersRequest{
+		Parent: parent,
+	}
+
+	// Call the API to list parameters.
+	it := client.ListParameters(ctx, req)
+	for {
+		resp, err := it.Next()
+		if err == iterator.Done {
+			break
+		}
+		if err != nil {
+			return fmt.Errorf("failed to list parameters: %w", err)
+		}
+
+		fmt.Fprintf(w, "Found parameter %s with format %s \n", resp.Name, resp.Format.String())
+	}
+
+	return nil
+}
+
+// [END parametermanager_list_params]

parametermanager/parametermanager_test.go

@@ -171,3 +171,48 @@ func TestCreateParamVersionWithSecret(t *testing.T) {
 		t.Errorf("createParameterVersion: expected %q to contain %q", got, want)
 	}
 }
+
+// TestGetParam tests the getParam function by creating a parameter,
+// then attempts to retrieve the created parameter. It verifies if the parameter
+// was successfully retrieved by checking the output.
+func TestGetParam(t *testing.T) {
+	tc := testutil.SystemTest(t)
+
+	parameter, parameterID := testParameter(t, tc.ProjectID, parametermanagerpb.ParameterFormat_JSON)
+	defer testCleanupParameter(t, parameter.Name)
+
+	var b bytes.Buffer
+	if err := getParam(&b, tc.ProjectID, parameterID); err != nil {
+		t.Fatal(err)
+	}
+
+	if got, want := b.String(), fmt.Sprintf("Found parameter %s with format JSON", parameter.Name); !strings.Contains(got, want) {
+		t.Errorf("GetParameter: expected %q to contain %q", got, want)
+	}
+}
+
+// TestListParam tests the listParam function by creating multiple parameters,
+// then attempts to list the created parameters. It verifies if the parameters
+// were successfully listed by checking the output.
+func TestListParam(t *testing.T) {
+	tc := testutil.SystemTest(t)
+
+	parameter1, _ := testParameter(t, tc.ProjectID, parametermanagerpb.ParameterFormat_JSON)
+	parameter2, _ := testParameter(t, tc.ProjectID, parametermanagerpb.ParameterFormat_UNFORMATTED)
+
+	defer testCleanupParameter(t, parameter1.Name)
+	defer testCleanupParameter(t, parameter2.Name)
+
+	var b bytes.Buffer
+	if err := listParams(&b, tc.ProjectID); err != nil {
+		t.Fatal(err)
+	}
+
+	if got, want := b.String(), fmt.Sprintf("Found parameter %s with format %s \n", parameter1.Name, parameter1.Format); !strings.Contains(got, want) {
+		t.Errorf("ListParameter: expected %q to contain %q", got, want)
+	}
+
+	if got, want := b.String(), fmt.Sprintf("Found parameter %s with format %s \n", parameter2.Name, parameter2.Format); !strings.Contains(got, want) {
+		t.Errorf("ListParameter: expected %q to contain %q", got, want)
+	}
+}