public sealed class ApiDeployment : IMessage<ApiDeployment>, IEquatable<ApiDeployment>, IDeepCloneable<ApiDeployment>, IBufferMessage, IMessage
Reference documentation and code samples for the Apigee Registry v1 API class ApiDeployment.
Describes a service running at particular address that
provides a particular version of an API. ApiDeployments have revisions which
correspond to different configurations of a single deployment in time.
Revision identifiers should be updated whenever the served API spec or
endpoint address changes.
public MapField<string, string> Annotations { get; }
Annotations attach non-identifying metadata to resources.
Annotation keys and values are less restricted than those of labels, but
should be generally used for small values of broad interest. Larger, topic-
specific metadata should be stored in Artifacts.
The full resource name (including revision ID) of the spec of the API being
served by the deployment. Changes to this value will update the revision.
Format: apis/{api}/deployments/{deployment}
Labels attach identifying metadata to resources. Identifying metadata can
be used to filter list operations.
Label keys and values can be no longer than 64 characters
(Unicode codepoints), can only contain lowercase letters, numeric
characters, underscores and dashes. International characters are allowed.
No more than 64 user labels can be associated with one resource (System
labels are excluded).
See https://goo.gl/xmQnxf for more information and examples of labels.
System reserved label keys are prefixed with
apigeeregistry.googleapis.com/ and cannot be changed.
Output only. Immutable. The revision ID of the deployment.
A new revision is committed whenever the deployment contents are changed.
The format is an 8-character hexadecimal string.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eApiDeployment\u003c/code\u003e class in the Apigee Registry v1 API represents a service deployment serving a specific API version, with revisions for different configurations over time.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eApiDeployment\u003c/code\u003e 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, providing functionalities like deep cloning and message handling.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of \u003ccode\u003eApiDeployment\u003c/code\u003e include \u003ccode\u003eApiSpecRevision\u003c/code\u003e (specifying the served API spec), \u003ccode\u003eEndpointUri\u003c/code\u003e (the service address), and \u003ccode\u003eRevisionId\u003c/code\u003e (identifying specific revisions).\u003c/p\u003e\n"],["\u003cp\u003eThe class supports metadata attachments through \u003ccode\u003eAnnotations\u003c/code\u003e and \u003ccode\u003eLabels\u003c/code\u003e, with \u003ccode\u003eLabels\u003c/code\u003e used for filtering and \u003ccode\u003eAnnotations\u003c/code\u003e for broader, non-identifying metadata.\u003c/p\u003e\n"],["\u003cp\u003eEach \u003ccode\u003eApiDeployment\u003c/code\u003e has a \u003ccode\u003eCreateTime\u003c/code\u003e, a \u003ccode\u003eRevisionCreateTime\u003c/code\u003e, and a \u003ccode\u003eRevisionUpdateTime\u003c/code\u003e to capture the exact timestamps of when the deployment and each revision was created and updated.\u003c/p\u003e\n"]]],[],null,["# Apigee Registry v1 API - Class ApiDeployment (1.0.0-beta07)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.0-beta07 (latest)](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1.ApiDeployment)\n- [1.0.0-beta06](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/1.0.0-beta06/Google.Cloud.ApigeeRegistry.V1.ApiDeployment) \n\n public sealed class ApiDeployment : IMessage\u003cApiDeployment\u003e, IEquatable\u003cApiDeployment\u003e, IDeepCloneable\u003cApiDeployment\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Apigee Registry v1 API class ApiDeployment.\n\nDescribes a service running at particular address that\nprovides a particular version of an API. ApiDeployments have revisions which\ncorrespond to different configurations of a single deployment in time.\nRevision identifiers should be updated whenever the served API spec or\nendpoint address changes. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e ApiDeployment \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[ApiDeployment](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1.ApiDeployment), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[ApiDeployment](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1.ApiDeployment), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[ApiDeployment](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1.ApiDeployment), [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.ApigeeRegistry.V1](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.ApigeeRegistry.V1.dll\n\nConstructors\n------------\n\n### ApiDeployment()\n\n public ApiDeployment()\n\n### ApiDeployment(ApiDeployment)\n\n public ApiDeployment(ApiDeployment other)\n\nProperties\n----------\n\n### AccessGuidance\n\n public string AccessGuidance { get; set; }\n\nText briefly describing how to access the endpoint. Changes to this value\nwill not affect the revision.\n\n### Annotations\n\n public MapField\u003cstring, string\u003e Annotations { get; }\n\nAnnotations attach non-identifying metadata to resources.\n\nAnnotation keys and values are less restricted than those of labels, but\nshould be generally used for small values of broad interest. Larger, topic-\nspecific metadata should be stored in Artifacts.\n\n### ApiDeploymentName\n\n public ApiDeploymentName ApiDeploymentName { get; set; }\n\n[ApiDeploymentName](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1.ApiDeploymentName)-typed view over the [Name](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1.ApiDeployment#Google_Cloud_ApigeeRegistry_V1_ApiDeployment_Name) resource name property.\n\n### ApiSpecRevision\n\n public string ApiSpecRevision { get; set; }\n\nThe full resource name (including revision ID) of the spec of the API being\nserved by the deployment. Changes to this value will update the revision.\nFormat: `apis/{api}/deployments/{deployment}`\n\n### ApiSpecRevisionAsApiSpecName\n\n public ApiSpecName ApiSpecRevisionAsApiSpecName { get; set; }\n\n[ApiSpecName](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1.ApiSpecName)-typed view over the [ApiSpecRevision](/dotnet/docs/reference/Google.Cloud.ApigeeRegistry.V1/latest/Google.Cloud.ApigeeRegistry.V1.ApiDeployment#Google_Cloud_ApigeeRegistry_V1_ApiDeployment_ApiSpecRevision) resource name property.\n\n### CreateTime\n\n public Timestamp CreateTime { get; set; }\n\nOutput only. Creation timestamp; when the deployment resource was created.\n\n### Description\n\n public string Description { get; set; }\n\nA detailed description.\n\n### DisplayName\n\n public string DisplayName { get; set; }\n\nHuman-meaningful name.\n\n### EndpointUri\n\n public string EndpointUri { get; set; }\n\nThe address where the deployment is serving. Changes to this value will\nupdate the revision.\n\n### ExternalChannelUri\n\n public string ExternalChannelUri { get; set; }\n\nThe address of the external channel of the API (e.g., the Developer\nPortal). Changes to this value will not affect the revision.\n\n### IntendedAudience\n\n public string IntendedAudience { get; set; }\n\nText briefly identifying the intended audience of the API. Changes to this\nvalue will not affect the revision.\n\n### Labels\n\n public MapField\u003cstring, string\u003e Labels { get; }\n\nLabels attach identifying metadata to resources. Identifying metadata can\nbe used to filter list operations.\n\nLabel keys and values can be no longer than 64 characters\n(Unicode codepoints), can only contain lowercase letters, numeric\ncharacters, underscores and dashes. International characters are allowed.\nNo more than 64 user labels can be associated with one resource (System\nlabels are excluded).\n\nSee \u003chttps://goo.gl/xmQnxf\u003e for more information and examples of labels.\nSystem reserved label keys are prefixed with\n`apigeeregistry.googleapis.com/` and cannot be changed.\n\n### Name\n\n public string Name { get; set; }\n\nResource name.\n\n### RevisionCreateTime\n\n public Timestamp RevisionCreateTime { get; set; }\n\nOutput only. Revision creation timestamp; when the represented revision was created.\n\n### RevisionId\n\n public string RevisionId { get; set; }\n\nOutput only. Immutable. The revision ID of the deployment.\nA new revision is committed whenever the deployment contents are changed.\nThe format is an 8-character hexadecimal string.\n\n### RevisionUpdateTime\n\n public Timestamp RevisionUpdateTime { get; set; }\n\nOutput only. Last update timestamp: when the represented revision was last modified."]]
