public sealed class UndeployModelRequest : IMessage<UndeployModelRequest>, IEquatable<UndeployModelRequest>, IDeepCloneable<UndeployModelRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Vertex AI v1beta1 API class UndeployModelRequest.
Request message for
[EndpointService.UndeployModel][google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel].
public MapField<string, int> TrafficSplit { get; }
If this field is provided, then the Endpoint's
[traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split]
will be overwritten with it. If last DeployedModel is being undeployed from
the Endpoint, the [Endpoint.traffic_split] will always end up empty when
this call returns. A DeployedModel will be successfully undeployed only if
it doesn't have any traffic assigned to it when this method executes, or if
this field unassigns any traffic to it.
[[["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-14 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eUndeployModelRequest\u003c/code\u003e class is used to define a request for undeploying a model from an endpoint within the Vertex AI v1beta1 API.\u003c/p\u003e\n"],["\u003cp\u003eThis class implements several interfaces, including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, and inherits from \u003ccode\u003eobject\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eUndeployModelRequest\u003c/code\u003e class has two constructors, one default and another that accepts an \u003ccode\u003eUndeployModelRequest\u003c/code\u003e object for copying.\u003c/p\u003e\n"],["\u003cp\u003eKey properties include \u003ccode\u003eDeployedModelId\u003c/code\u003e for specifying the ID of the model to undeploy, \u003ccode\u003eEndpoint\u003c/code\u003e for identifying the endpoint resource, and \u003ccode\u003eTrafficSplit\u003c/code\u003e for managing the traffic allocation to different deployed models.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of this class is 1.0.0-beta21 and it is part of the \u003ccode\u003eGoogle.Cloud.AIPlatform.V1Beta1\u003c/code\u003e namespace.\u003c/p\u003e\n"]]],[],null,["# Vertex AI v1beta1 API - Class UndeployModelRequest (1.0.0-beta47)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.0-beta47 (latest)](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.UndeployModelRequest)\n- [1.0.0-beta46](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/1.0.0-beta46/Google.Cloud.AIPlatform.V1Beta1.UndeployModelRequest) \n\n public sealed class UndeployModelRequest : IMessage\u003cUndeployModelRequest\u003e, IEquatable\u003cUndeployModelRequest\u003e, IDeepCloneable\u003cUndeployModelRequest\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Vertex AI v1beta1 API class UndeployModelRequest.\n\nRequest message for\n\\[EndpointService.UndeployModel\\]\\[google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel\\]. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e UndeployModelRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[UndeployModelRequest](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.UndeployModelRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[UndeployModelRequest](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.UndeployModelRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[UndeployModelRequest](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.UndeployModelRequest), [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.AIPlatform.V1Beta1](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1)\n\nAssembly\n--------\n\nGoogle.Cloud.AIPlatform.V1Beta1.dll\n\nConstructors\n------------\n\n### UndeployModelRequest()\n\n public UndeployModelRequest()\n\n### UndeployModelRequest(UndeployModelRequest)\n\n public UndeployModelRequest(UndeployModelRequest other)\n\nProperties\n----------\n\n### DeployedModelId\n\n public string DeployedModelId { get; set; }\n\nRequired. The ID of the DeployedModel to be undeployed from the Endpoint.\n\n### Endpoint\n\n public string Endpoint { get; set; }\n\nRequired. The name of the Endpoint resource from which to undeploy a Model.\nFormat:\n`projects/{project}/locations/{location}/endpoints/{endpoint}`\n\n### EndpointAsEndpointName\n\n public EndpointName EndpointAsEndpointName { get; set; }\n\n[EndpointName](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.EndpointName)-typed view over the [Endpoint](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.UndeployModelRequest#Google_Cloud_AIPlatform_V1Beta1_UndeployModelRequest_Endpoint) resource name property.\n\n### TrafficSplit\n\n public MapField\u003cstring, int\u003e TrafficSplit { get; }\n\nIf this field is provided, then the Endpoint's\n\\[traffic_split\\]\\[google.cloud.aiplatform.v1beta1.Endpoint.traffic_split\\]\nwill be overwritten with it. If last DeployedModel is being undeployed from\nthe Endpoint, the \\[Endpoint.traffic_split\\] will always end up empty when\nthis call returns. A DeployedModel will be successfully undeployed only if\nit doesn't have any traffic assigned to it when this method executes, or if\nthis field unassigns any traffic to it."]]
