feat: added support for deploy policies

docs: Minor documentation updates

PiperOrigin-RevId: 679600689

Source-Link: googleapis/googleapis@bd4f368

Source-Link: googleapis/googleapis-gen@12a2d22
Copy-Tag: eyJwIjoiYXBpcy9Hb29nbGUuQ2xvdWQuRGVwbG95LlYxLy5Pd2xCb3QueWFtbCIsImgiOiIxMmEyZDIyYmYxYmRhODViYTliZWQxZmE2MDQ4NDMwNmEyZTU1NzgxIn0=

Author: gcf-owl-bot[bot]

apis/Google.Cloud.Deploy.V1/Google.Cloud.Deploy.V1.GeneratedSnippets/CloudDeployClient.AdvanceRolloutRequestObjectAsyncSnippet.g.cs

@@ -39,6 +39,10 @@ public async Task AdvanceRolloutRequestObjectAsync()
             {
                 RolloutName = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]"),
                 PhaseId = "",
+                OverrideDeployPolicyAsDeployPolicyNames =
+                {
+                    DeployPolicyName.FromProjectLocationDeployPolicy("[PROJECT]", "[LOCATION]", "[DEPLOY_POLICY]"),
+                },
             };
             // Make the request
             AdvanceRolloutResponse response = await cloudDeployClient.AdvanceRolloutAsync(request);

apis/Google.Cloud.Deploy.V1/Google.Cloud.Deploy.V1.GeneratedSnippets/CloudDeployClient.AdvanceRolloutRequestObjectSnippet.g.cs

@@ -38,6 +38,10 @@ public void AdvanceRolloutRequestObject()
             {
                 RolloutName = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]"),
                 PhaseId = "",
+                OverrideDeployPolicyAsDeployPolicyNames =
+                {
+                    DeployPolicyName.FromProjectLocationDeployPolicy("[PROJECT]", "[LOCATION]", "[DEPLOY_POLICY]"),
+                },
             };
             // Make the request
             AdvanceRolloutResponse response = cloudDeployClient.AdvanceRollout(request);

apis/Google.Cloud.Deploy.V1/Google.Cloud.Deploy.V1.GeneratedSnippets/CloudDeployClient.ApproveRolloutRequestObjectAsyncSnippet.g.cs

@@ -39,6 +39,10 @@ public async Task ApproveRolloutRequestObjectAsync()
             {
                 RolloutName = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]"),
                 Approved = false,
+                OverrideDeployPolicyAsDeployPolicyNames =
+                {
+                    DeployPolicyName.FromProjectLocationDeployPolicy("[PROJECT]", "[LOCATION]", "[DEPLOY_POLICY]"),
+                },
             };
             // Make the request
             ApproveRolloutResponse response = await cloudDeployClient.ApproveRolloutAsync(request);

apis/Google.Cloud.Deploy.V1/Google.Cloud.Deploy.V1.GeneratedSnippets/CloudDeployClient.ApproveRolloutRequestObjectSnippet.g.cs

@@ -38,6 +38,10 @@ public void ApproveRolloutRequestObject()
             {
                 RolloutName = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]"),
                 Approved = false,
+                OverrideDeployPolicyAsDeployPolicyNames =
+                {
+                    DeployPolicyName.FromProjectLocationDeployPolicy("[PROJECT]", "[LOCATION]", "[DEPLOY_POLICY]"),
+                },
             };
             // Make the request
             ApproveRolloutResponse response = cloudDeployClient.ApproveRollout(request);

apis/Google.Cloud.Deploy.V1/Google.Cloud.Deploy.V1.GeneratedSnippets/CloudDeployClient.CancelRolloutRequestObjectAsyncSnippet.g.cs

@@ -38,6 +38,10 @@ public async Task CancelRolloutRequestObjectAsync()
             CancelRolloutRequest request = new CancelRolloutRequest
             {
                 RolloutName = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]"),
+                OverrideDeployPolicyAsDeployPolicyNames =
+                {
+                    DeployPolicyName.FromProjectLocationDeployPolicy("[PROJECT]", "[LOCATION]", "[DEPLOY_POLICY]"),
+                },
             };
             // Make the request
             CancelRolloutResponse response = await cloudDeployClient.CancelRolloutAsync(request);

apis/Google.Cloud.Deploy.V1/Google.Cloud.Deploy.V1.GeneratedSnippets/CloudDeployClient.CancelRolloutRequestObjectSnippet.g.cs

@@ -37,6 +37,10 @@ public void CancelRolloutRequestObject()
             CancelRolloutRequest request = new CancelRolloutRequest
             {
                 RolloutName = RolloutName.FromProjectLocationDeliveryPipelineReleaseRollout("[PROJECT]", "[LOCATION]", "[DELIVERY_PIPELINE]", "[RELEASE]", "[ROLLOUT]"),
+                OverrideDeployPolicyAsDeployPolicyNames =
+                {
+                    DeployPolicyName.FromProjectLocationDeployPolicy("[PROJECT]", "[LOCATION]", "[DEPLOY_POLICY]"),
+                },
             };
             // Make the request
             CancelRolloutResponse response = cloudDeployClient.CancelRollout(request);

apis/Google.Cloud.Deploy.V1/Google.Cloud.Deploy.V1.GeneratedSnippets/CloudDeployClient.CreateDeployPolicyAsyncSnippet.g.cs

@@ -0,0 +1,63 @@
+// Copyright 2024 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.
+
+// Generated code. DO NOT EDIT!
+
+namespace GoogleCSharpSnippets
+{
+    // [START clouddeploy_v1_generated_CloudDeploy_CreateDeployPolicy_async_flattened]
+    using Google.Cloud.Deploy.V1;
+    using Google.LongRunning;
+    using System.Threading.Tasks;
+
+    public sealed partial class GeneratedCloudDeployClientSnippets
+    {
+        /// <summary>Snippet for CreateDeployPolicyAsync</summary>
+        /// <remarks>
+        /// This snippet has been automatically generated and should be regarded as a code template only.
+        /// It will require modifications to work:
+        /// - It may require correct/in-range values for request initialization.
+        /// - It may require specifying regional endpoints when creating the service client as shown in
+        ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
+        /// </remarks>
+        public async Task CreateDeployPolicyAsync()
+        {
+            // Create client
+            CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
+            // Initialize request argument(s)
+            string parent = "projects/[PROJECT]/locations/[LOCATION]";
+            DeployPolicy deployPolicy = new DeployPolicy();
+            string deployPolicyId = "";
+            // Make the request
+            Operation<DeployPolicy, OperationMetadata> response = await cloudDeployClient.CreateDeployPolicyAsync(parent, deployPolicy, deployPolicyId);
+
+            // Poll until the returned long-running operation is complete
+            Operation<DeployPolicy, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
+            // Retrieve the operation result
+            DeployPolicy result = completedResponse.Result;
+
+            // Or get the name of the operation
+            string operationName = response.Name;
+            // This name can be stored, then the long-running operation retrieved later by name
+            Operation<DeployPolicy, OperationMetadata> retrievedResponse = await cloudDeployClient.PollOnceCreateDeployPolicyAsync(operationName);
+            // Check if the retrieved long-running operation has completed
+            if (retrievedResponse.IsCompleted)
+            {
+                // If it has completed, then access the result
+                DeployPolicy retrievedResult = retrievedResponse.Result;
+            }
+        }
+    }
+    // [END clouddeploy_v1_generated_CloudDeploy_CreateDeployPolicy_async_flattened]
+}

apis/Google.Cloud.Deploy.V1/Google.Cloud.Deploy.V1.GeneratedSnippets/CloudDeployClient.CreateDeployPolicyRequestObjectAsyncSnippet.g.cs

@@ -0,0 +1,69 @@
+// Copyright 2024 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.
+
+// Generated code. DO NOT EDIT!
+
+namespace GoogleCSharpSnippets
+{
+    // [START clouddeploy_v1_generated_CloudDeploy_CreateDeployPolicy_async]
+    using Google.Api.Gax.ResourceNames;
+    using Google.Cloud.Deploy.V1;
+    using Google.LongRunning;
+    using System.Threading.Tasks;
+
+    public sealed partial class GeneratedCloudDeployClientSnippets
+    {
+        /// <summary>Snippet for CreateDeployPolicyAsync</summary>
+        /// <remarks>
+        /// This snippet has been automatically generated and should be regarded as a code template only.
+        /// It will require modifications to work:
+        /// - It may require correct/in-range values for request initialization.
+        /// - It may require specifying regional endpoints when creating the service client as shown in
+        ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
+        /// </remarks>
+        public async Task CreateDeployPolicyRequestObjectAsync()
+        {
+            // Create client
+            CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
+            // Initialize request argument(s)
+            CreateDeployPolicyRequest request = new CreateDeployPolicyRequest
+            {
+                ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
+                DeployPolicyId = "",
+                DeployPolicy = new DeployPolicy(),
+                RequestId = "",
+                ValidateOnly = false,
+            };
+            // Make the request
+            Operation<DeployPolicy, OperationMetadata> response = await cloudDeployClient.CreateDeployPolicyAsync(request);
+
+            // Poll until the returned long-running operation is complete
+            Operation<DeployPolicy, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
+            // Retrieve the operation result
+            DeployPolicy result = completedResponse.Result;
+
+            // Or get the name of the operation
+            string operationName = response.Name;
+            // This name can be stored, then the long-running operation retrieved later by name
+            Operation<DeployPolicy, OperationMetadata> retrievedResponse = await cloudDeployClient.PollOnceCreateDeployPolicyAsync(operationName);
+            // Check if the retrieved long-running operation has completed
+            if (retrievedResponse.IsCompleted)
+            {
+                // If it has completed, then access the result
+                DeployPolicy retrievedResult = retrievedResponse.Result;
+            }
+        }
+    }
+    // [END clouddeploy_v1_generated_CloudDeploy_CreateDeployPolicy_async]
+}

apis/Google.Cloud.Deploy.V1/Google.Cloud.Deploy.V1.GeneratedSnippets/CloudDeployClient.CreateDeployPolicyRequestObjectSnippet.g.cs

@@ -0,0 +1,68 @@
+// Copyright 2024 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.
+
+// Generated code. DO NOT EDIT!
+
+namespace GoogleCSharpSnippets
+{
+    // [START clouddeploy_v1_generated_CloudDeploy_CreateDeployPolicy_sync]
+    using Google.Api.Gax.ResourceNames;
+    using Google.Cloud.Deploy.V1;
+    using Google.LongRunning;
+
+    public sealed partial class GeneratedCloudDeployClientSnippets
+    {
+        /// <summary>Snippet for CreateDeployPolicy</summary>
+        /// <remarks>
+        /// This snippet has been automatically generated and should be regarded as a code template only.
+        /// It will require modifications to work:
+        /// - It may require correct/in-range values for request initialization.
+        /// - It may require specifying regional endpoints when creating the service client as shown in
+        ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
+        /// </remarks>
+        public void CreateDeployPolicyRequestObject()
+        {
+            // Create client
+            CloudDeployClient cloudDeployClient = CloudDeployClient.Create();
+            // Initialize request argument(s)
+            CreateDeployPolicyRequest request = new CreateDeployPolicyRequest
+            {
+                ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
+                DeployPolicyId = "",
+                DeployPolicy = new DeployPolicy(),
+                RequestId = "",
+                ValidateOnly = false,
+            };
+            // Make the request
+            Operation<DeployPolicy, OperationMetadata> response = cloudDeployClient.CreateDeployPolicy(request);
+
+            // Poll until the returned long-running operation is complete
+            Operation<DeployPolicy, OperationMetadata> completedResponse = response.PollUntilCompleted();
+            // Retrieve the operation result
+            DeployPolicy result = completedResponse.Result;
+
+            // Or get the name of the operation
+            string operationName = response.Name;
+            // This name can be stored, then the long-running operation retrieved later by name
+            Operation<DeployPolicy, OperationMetadata> retrievedResponse = cloudDeployClient.PollOnceCreateDeployPolicy(operationName);
+            // Check if the retrieved long-running operation has completed
+            if (retrievedResponse.IsCompleted)
+            {
+                // If it has completed, then access the result
+                DeployPolicy retrievedResult = retrievedResponse.Result;
+            }
+        }
+    }
+    // [END clouddeploy_v1_generated_CloudDeploy_CreateDeployPolicy_sync]
+}

apis/Google.Cloud.Deploy.V1/Google.Cloud.Deploy.V1.GeneratedSnippets/CloudDeployClient.CreateDeployPolicyResourceNamesAsyncSnippet.g.cs

@@ -0,0 +1,64 @@
+// Copyright 2024 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.
+
+// Generated code. DO NOT EDIT!
+
+namespace GoogleCSharpSnippets
+{
+    // [START clouddeploy_v1_generated_CloudDeploy_CreateDeployPolicy_async_flattened_resourceNames]
+    using Google.Api.Gax.ResourceNames;
+    using Google.Cloud.Deploy.V1;
+    using Google.LongRunning;
+    using System.Threading.Tasks;
+
+    public sealed partial class GeneratedCloudDeployClientSnippets
+    {
+        /// <summary>Snippet for CreateDeployPolicyAsync</summary>
+        /// <remarks>
+        /// This snippet has been automatically generated and should be regarded as a code template only.
+        /// It will require modifications to work:
+        /// - It may require correct/in-range values for request initialization.
+        /// - It may require specifying regional endpoints when creating the service client as shown in
+        ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
+        /// </remarks>
+        public async Task CreateDeployPolicyResourceNamesAsync()
+        {
+            // Create client
+            CloudDeployClient cloudDeployClient = await CloudDeployClient.CreateAsync();
+            // Initialize request argument(s)
+            LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
+            DeployPolicy deployPolicy = new DeployPolicy();
+            string deployPolicyId = "";
+            // Make the request
+            Operation<DeployPolicy, OperationMetadata> response = await cloudDeployClient.CreateDeployPolicyAsync(parent, deployPolicy, deployPolicyId);
+
+            // Poll until the returned long-running operation is complete
+            Operation<DeployPolicy, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
+            // Retrieve the operation result
+            DeployPolicy result = completedResponse.Result;
+
+            // Or get the name of the operation
+            string operationName = response.Name;
+            // This name can be stored, then the long-running operation retrieved later by name
+            Operation<DeployPolicy, OperationMetadata> retrievedResponse = await cloudDeployClient.PollOnceCreateDeployPolicyAsync(operationName);
+            // Check if the retrieved long-running operation has completed
+            if (retrievedResponse.IsCompleted)
+            {
+                // If it has completed, then access the result
+                DeployPolicy retrievedResult = retrievedResponse.Result;
+            }
+        }
+    }
+    // [END clouddeploy_v1_generated_CloudDeploy_CreateDeployPolicy_async_flattened_resourceNames]
+}