public CustomCanaryDeployment CustomCanaryDeployment { get; set; }
Optional. Configures the progressive based deployment for a Target, but
allows customizing at the phase level where a phase represents each of
the percentage deployments.
Optional. Runtime specific configurations for the deployment strategy. The
runtime configuration is used to determine how Cloud Deploy will split
traffic to enable a progressive deployment.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis page provides documentation for the \u003ccode\u003eCanary\u003c/code\u003e class within the Google Cloud Deploy v1 API, with the latest version being 3.4.0, and several other versions available from 3.3.0 back to 1.0.0.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCanary\u003c/code\u003e class represents a canary deployment strategy, and it inherits from \u003ccode\u003eobject\u003c/code\u003e while implementing \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e interfaces.\u003c/p\u003e\n"],["\u003cp\u003eThe class offers two deployment configuration options, \u003ccode\u003eCanaryDeployment\u003c/code\u003e and \u003ccode\u003eCustomCanaryDeployment\u003c/code\u003e, allowing for progressive deployments with standard or customized phases.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCanary\u003c/code\u003e class also has a \u003ccode\u003eRuntimeConfig\u003c/code\u003e property for runtime-specific configurations, influencing how Cloud Deploy manages traffic distribution during a progressive deployment.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eModeCase\u003c/code\u003e property indicates what type of deployment configuration is being used, either standard \u003ccode\u003eCanaryDeployment\u003c/code\u003e or \u003ccode\u003eCustomCanaryDeployment\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Google Cloud Deploy v1 API - Class Canary (3.6.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.6.0 (latest)](/dotnet/docs/reference/Google.Cloud.Deploy.V1/latest/Google.Cloud.Deploy.V1.Canary)\n- [3.5.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/3.5.0/Google.Cloud.Deploy.V1.Canary)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/3.4.0/Google.Cloud.Deploy.V1.Canary)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/3.3.0/Google.Cloud.Deploy.V1.Canary)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/3.2.0/Google.Cloud.Deploy.V1.Canary)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/3.1.0/Google.Cloud.Deploy.V1.Canary)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/3.0.0/Google.Cloud.Deploy.V1.Canary)\n- [2.19.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/2.19.0/Google.Cloud.Deploy.V1.Canary)\n- [2.18.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/2.18.0/Google.Cloud.Deploy.V1.Canary)\n- [2.17.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/2.17.0/Google.Cloud.Deploy.V1.Canary)\n- [2.16.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/2.16.0/Google.Cloud.Deploy.V1.Canary)\n- [2.15.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/2.15.0/Google.Cloud.Deploy.V1.Canary)\n- [2.14.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/2.14.0/Google.Cloud.Deploy.V1.Canary)\n- [2.13.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/2.13.0/Google.Cloud.Deploy.V1.Canary)\n- [2.12.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/2.12.0/Google.Cloud.Deploy.V1.Canary)\n- [2.11.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/2.11.0/Google.Cloud.Deploy.V1.Canary)\n- [2.10.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/2.10.0/Google.Cloud.Deploy.V1.Canary)\n- [2.9.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/2.9.0/Google.Cloud.Deploy.V1.Canary)\n- [2.8.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/2.8.0/Google.Cloud.Deploy.V1.Canary)\n- [2.7.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/2.7.0/Google.Cloud.Deploy.V1.Canary)\n- [2.6.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/2.6.0/Google.Cloud.Deploy.V1.Canary)\n- [2.5.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/2.5.0/Google.Cloud.Deploy.V1.Canary)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/2.4.0/Google.Cloud.Deploy.V1.Canary)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/2.3.0/Google.Cloud.Deploy.V1.Canary)\n- [2.2.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/2.2.0/Google.Cloud.Deploy.V1.Canary)\n- [2.1.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/2.1.0/Google.Cloud.Deploy.V1.Canary)\n- [2.0.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/2.0.0/Google.Cloud.Deploy.V1.Canary)\n- [1.1.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/1.1.0/Google.Cloud.Deploy.V1.Canary)\n- [1.0.0](/dotnet/docs/reference/Google.Cloud.Deploy.V1/1.0.0/Google.Cloud.Deploy.V1.Canary) \n\n public sealed class Canary : IMessage\u003cCanary\u003e, IEquatable\u003cCanary\u003e, IDeepCloneable\u003cCanary\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Google Cloud Deploy v1 API class Canary.\n\nCanary represents the canary deployment strategy. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e Canary \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[Canary](/dotnet/docs/reference/Google.Cloud.Deploy.V1/latest/Google.Cloud.Deploy.V1.Canary), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[Canary](/dotnet/docs/reference/Google.Cloud.Deploy.V1/latest/Google.Cloud.Deploy.V1.Canary), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[Canary](/dotnet/docs/reference/Google.Cloud.Deploy.V1/latest/Google.Cloud.Deploy.V1.Canary), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Deploy.V1](/dotnet/docs/reference/Google.Cloud.Deploy.V1/latest/Google.Cloud.Deploy.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.Deploy.V1.dll\n\nConstructors\n------------\n\n### Canary()\n\n public Canary()\n\n### Canary(Canary)\n\n public Canary(Canary other)\n\nProperties\n----------\n\n### CanaryDeployment\n\n public CanaryDeployment CanaryDeployment { get; set; }\n\nOptional. Configures the progressive based deployment for a Target.\n\n### CustomCanaryDeployment\n\n public CustomCanaryDeployment CustomCanaryDeployment { get; set; }\n\nOptional. Configures the progressive based deployment for a Target, but\nallows customizing at the phase level where a phase represents each of\nthe percentage deployments.\n\n### ModeCase\n\n public Canary.ModeOneofCase ModeCase { get; }\n\n### RuntimeConfig\n\n public RuntimeConfig RuntimeConfig { get; set; }\n\nOptional. Runtime specific configurations for the deployment strategy. The\nruntime configuration is used to determine how Cloud Deploy will split\ntraffic to enable a progressive deployment."]]
