feat(parametermanager): Added samples for delete, disable and enable regional parameter (#2993)

Author: durgesh-ninave-crest

parametermanager/api/ParameterManager.RegionalSamples.Tests/DeleteRegionalParameterTests.cs

@@ -0,0 +1,43 @@
+/*
+ * 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.
+ */
+
+using Google.Cloud.ParameterManager.V1;
+
+[Collection(nameof(ParameterManagerRegionalFixture))]
+public class DeleteRegionalParameterTests
+{
+    private readonly ParameterManagerRegionalFixture _fixture;
+    private readonly DeleteRegionalParameterSample _sample;
+
+    public DeleteRegionalParameterTests(ParameterManagerRegionalFixture fixture)
+    {
+        _fixture = fixture;
+        _sample = new DeleteRegionalParameterSample();
+    }
+
+    [Fact]
+    public void DeleteRegionalParameter()
+    {
+        string parameterId = _fixture.RandomId();
+        Parameter parameter = _fixture.CreateParameter(parameterId, ParameterFormat.Unformatted);
+
+        _sample.DeleteRegionalParameter(projectId: _fixture.ProjectId, locationId: ParameterManagerRegionalFixture.LocationId, parameterId: parameterId);
+
+        ParameterManagerClient client = _fixture.Client;
+        var exception = Assert.Throws<Grpc.Core.RpcException>(() => client.GetParameter(parameter.ParameterName));
+        Assert.Equal(Grpc.Core.StatusCode.NotFound, exception.Status.StatusCode);
+    }
+}

parametermanager/api/ParameterManager.RegionalSamples.Tests/DeleteRegionalParameterVersionTests.cs

@@ -0,0 +1,43 @@
+/*
+ * 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.
+ */
+
+using Google.Cloud.ParameterManager.V1;
+
+[Collection(nameof(ParameterManagerRegionalFixture))]
+public class DeleteRegionalParameterVersionTests
+{
+    private readonly ParameterManagerRegionalFixture _fixture;
+    private readonly DeleteRegionalParameterVersionSample _sample;
+
+    public DeleteRegionalParameterVersionTests(ParameterManagerRegionalFixture fixture)
+    {
+        _fixture = fixture;
+        _sample = new DeleteRegionalParameterVersionSample();
+    }
+
+    [Fact]
+    public void DeleteRegionalParameterVersion()
+    {
+        var (parameterId, versionId, parameter, payload) = _fixture.CreateParameterWithVersion();
+
+        ParameterVersion parameterVersion = _fixture.CreateParameterVersion(parameterId, versionId, payload);
+        _sample.DeleteRegionalParameterVersion(projectId: _fixture.ProjectId, locationId: ParameterManagerRegionalFixture.LocationId, parameterId: parameterId, versionId: versionId);
+
+        ParameterManagerClient client = _fixture.Client;
+        var exception = Assert.Throws<Grpc.Core.RpcException>(() => client.GetParameterVersion(parameterVersion.ParameterVersionName));
+        Assert.Equal(Grpc.Core.StatusCode.NotFound, exception.Status.StatusCode);
+    }
+}

parametermanager/api/ParameterManager.RegionalSamples.Tests/DisableRegionalParameterVersionTests.cs

@@ -0,0 +1,42 @@
+/*
+ * 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.
+ */
+
+using Google.Cloud.ParameterManager.V1;
+
+[Collection(nameof(ParameterManagerRegionalFixture))]
+public class DisableRegionalParameterVersionTests
+{
+    private readonly ParameterManagerRegionalFixture _fixture;
+    private readonly DisableRegionalParameterVersionSample _sample;
+
+    public DisableRegionalParameterVersionTests(ParameterManagerRegionalFixture fixture)
+    {
+        _fixture = fixture;
+        _sample = new DisableRegionalParameterVersionSample();
+    }
+
+    [Fact]
+    public void DisableRegionalParameterVersion()
+    {
+        var (parameterId, versionId, parameter, payload) = _fixture.CreateParameterWithVersion();
+
+        ParameterVersion parameterVersion = _fixture.CreateParameterVersion(parameterId, versionId, payload);
+        ParameterVersion result = _sample.DisableRegionalParameterVersion(projectId: _fixture.ProjectId, locationId: ParameterManagerRegionalFixture.LocationId, parameterId: parameterId, versionId: versionId);
+
+        Assert.NotNull(result);
+        Assert.True(result.Disabled);
+    }
+}

parametermanager/api/ParameterManager.RegionalSamples.Tests/EnableRegionalParameterVersionTests.cs

@@ -0,0 +1,42 @@
+/*
+ * 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.
+ */
+
+using Google.Cloud.ParameterManager.V1;
+
+[Collection(nameof(ParameterManagerRegionalFixture))]
+public class EnableRegionalParameterVersionTests
+{
+    private readonly ParameterManagerRegionalFixture _fixture;
+    private readonly EnableRegionalParameterVersionSample _sample;
+
+    public EnableRegionalParameterVersionTests(ParameterManagerRegionalFixture fixture)
+    {
+        _fixture = fixture;
+        _sample = new EnableRegionalParameterVersionSample();
+    }
+
+    [Fact]
+    public void EnableRegionalParameterVersion()
+    {
+        var (parameterId, versionId, parameter, payload) = _fixture.CreateParameterWithVersion();
+
+        ParameterVersion parameterVersion = _fixture.CreateParameterVersion(parameterId, versionId, payload);
+        ParameterVersion result = _sample.EnableRegionalParameterVersion(projectId: _fixture.ProjectId, locationId: ParameterManagerRegionalFixture.LocationId, parameterId: parameterId, versionId: versionId);
+
+        Assert.NotNull(result);
+        Assert.False(result.Disabled);
+    }
+}

parametermanager/api/ParameterManager.RegionalSamples.Tests/ParameterManagerRegionalFixture.cs

@@ -76,6 +76,15 @@ public string RandomId()
         return $"csharp-{System.Guid.NewGuid()}";
     }
 
+    public (string parameterId, string versionId, Parameter parameter, string payload) CreateParameterWithVersion()
+    {
+        string parameterId = RandomId();
+        string versionId = RandomId();
+        Parameter parameter = CreateParameter(parameterId, ParameterFormat.Unformatted);
+        string payload = "test123";
+        return (parameterId, versionId, parameter, payload);
+    }
+
     public Parameter CreateParameter(string parameterId, ParameterFormat format)
     {
         LocationName parent = new LocationName(ProjectId, LocationId);

parametermanager/api/ParameterManager.RegionalSamples/DeleteRegionalParameter.cs

@@ -0,0 +1,52 @@
+/*
+ * 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.
+ */
+
+// [START parametermanager_delete_regional_param]
+
+using Google.Cloud.ParameterManager.V1;
+
+public class DeleteRegionalParameterSample
+{
+    /// <summary>
+    /// This function deletes a regional parameter using the Parameter Manager SDK for GCP.
+    /// </summary>
+    /// <param name="projectId">The ID of the project where the parameter is located.</param>
+    /// <param name="locationId">The ID of the region where the parameter is located.</param>
+    /// <param name="parameterId">The ID of the parameter to be deleted.</param>
+    public void DeleteRegionalParameter(
+        string projectId,
+        string locationId,
+        string parameterId)
+    {
+        // Define the regional endpoint
+        string regionalEndpoint = $"parametermanager.{locationId}.rep.googleapis.com";
+
+        // Create the client with the regional endpoint
+        ParameterManagerClient client = new ParameterManagerClientBuilder
+        {
+            Endpoint = regionalEndpoint
+        }.Build();
+
+        // Build the resource name for the parameter in the specified regional locationId
+        ParameterName parameterName = new ParameterName(projectId, locationId, parameterId);
+
+        // Call the API to delete the parameter
+        client.DeleteParameter(parameterName);
+
+        Console.WriteLine($"Deleted regional parameter: {parameterName}");
+    }
+}
+// [END parametermanager_delete_regional_param]

parametermanager/api/ParameterManager.RegionalSamples/DeleteRegionalParameterVersion.cs

@@ -0,0 +1,54 @@
+/*
+ * 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.
+ */
+
+// [START parametermanager_delete_regional_param_version]
+
+using Google.Cloud.ParameterManager.V1;
+
+public class DeleteRegionalParameterVersionSample
+{
+    /// <summary>
+    /// This function deletes a regional parameter version using the Parameter Manager SDK for GCP.
+    /// </summary>
+    /// <param name="projectId">The ID of the project where the parameter is located.</param>
+    /// <param name="locationId">The ID of the region where the parameter is located.</param>
+    /// <param name="parameterId">The ID of the parameter for which the version is to be deleted.</param>
+    /// <param name="versionId">The ID of the version to be deleted.</param>
+    public void DeleteRegionalParameterVersion(
+        string projectId,
+        string locationId,
+        string parameterId,
+        string versionId)
+    {
+        // Define the regional endpoint
+        string regionalEndpoint = $"parametermanager.{locationId}.rep.googleapis.com";
+
+        // Create the client with the regional endpoint
+        ParameterManagerClient client = new ParameterManagerClientBuilder
+        {
+            Endpoint = regionalEndpoint
+        }.Build();
+
+        // Build the resource name for the parameter version in the specified regional locationId
+        ParameterVersionName parameterVersionName = new ParameterVersionName(projectId, locationId, parameterId, versionId);
+
+        // Call the API to delete the parameter version
+        client.DeleteParameterVersion(parameterVersionName);
+
+        Console.WriteLine($"Deleted regional parameter version: {parameterVersionName}");
+    }
+}
+// [END parametermanager_delete_regional_param_version]

parametermanager/api/ParameterManager.RegionalSamples/DisbleRegionalParameterVersion.cs

@@ -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
+ *
+ *     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.
+ */
+
+// [START parametermanager_disable_regional_param_version]
+
+using Google.Cloud.ParameterManager.V1;
+using Google.Protobuf.WellKnownTypes;
+
+public class DisableRegionalParameterVersionSample
+{
+    /// <summary>
+    /// This function disables a regional parameter version using the Parameter Manager SDK for GCP.
+    /// </summary>
+    /// <param name="projectId">The ID of the project where the parameter is located.</param>
+    /// <param name="locationId">The ID of the region where the parameter is located.</param>
+    /// <param name="parameterId">The ID of the parameter for which the version is to be disabled.</param>
+    /// <param name="versionId">The ID of the version to be disabled.</param>
+    public ParameterVersion DisableRegionalParameterVersion(
+        string projectId,
+        string locationId,
+        string parameterId,
+        string versionId)
+    {
+        // Define the regional endpoint
+        string regionalEndpoint = $"parametermanager.{locationId}.rep.googleapis.com";
+
+        // Create the client with the regional endpoint
+        ParameterManagerClient client = new ParameterManagerClientBuilder
+        {
+            Endpoint = regionalEndpoint
+        }.Build();
+
+        // Build the resource name for the parameter version in the specified regional locationId
+        ParameterVersionName parameterVersionName = new ParameterVersionName(projectId, locationId, parameterId, versionId);
+
+        UpdateParameterVersionRequest request = new UpdateParameterVersionRequest
+        {
+            ParameterVersion = new ParameterVersion
+            {
+                Name = parameterVersionName.ToString(),
+                Disabled = true
+            },
+            UpdateMask = new FieldMask
+            {
+                Paths = { "disabled" }
+            }
+        };
+
+        // Call the API to update (disable) the parameter version.
+        ParameterVersion updatedParameterVersion = client.UpdateParameterVersion(request);
+
+        Console.WriteLine($"Disabled regional parameter version {versionId} for parameter {parameterId}");
+
+        return updatedParameterVersion;
+    }
+}
+// [END parametermanager_disable_regional_param_version]