public sealed class Api : IMessage<Api>, IEquatable<Api>, IDeepCloneable<Api>, IBufferMessage, IMessageReference documentation and code samples for the Apigee Registry v1 API class Api.
A top-level description of an API. Produced by producers and are commitments to provide services.
Namespace
Google.Cloud.ApigeeRegistry.V1Assembly
Google.Cloud.ApigeeRegistry.V1.dll
Constructors
Api()
public Api()Api(Api)
public Api(Api other)| Parameter | |
|---|---|
| Name | Description |
other | Api |
Properties
Annotations
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.
| Property Value | |
|---|---|
| Type | Description |
MapField<String, String> | |
ApiName
public ApiName ApiName { get; set; }| Property Value | |
|---|---|
| Type | Description |
ApiName | |
Availability
public string Availability { get; set; }A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".
| Property Value | |
|---|---|
| Type | Description |
String | |
CreateTime
public Timestamp CreateTime { get; set; }Output only. Creation timestamp.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
Description
public string Description { get; set; }A detailed description.
| Property Value | |
|---|---|
| Type | Description |
String | |
DisplayName
public string DisplayName { get; set; }Human-meaningful name.
| Property Value | |
|---|---|
| Type | Description |
String | |
Labels
public MapField<string, string> Labels { get; }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.
| Property Value | |
|---|---|
| Type | Description |
MapField<String, String> | |
Name
public string Name { get; set; }Resource name.
| Property Value | |
|---|---|
| Type | Description |
String | |
RecommendedDeployment
public string RecommendedDeployment { get; set; }The recommended deployment of the API.
Format: apis/{api}/deployments/{deployment}
| Property Value | |
|---|---|
| Type | Description |
String | |
RecommendedDeploymentAsApiDeploymentName
public ApiDeploymentName RecommendedDeploymentAsApiDeploymentName { get; set; }ApiDeploymentName-typed view over the RecommendedDeployment resource name property.
| Property Value | |
|---|---|
| Type | Description |
ApiDeploymentName | |
RecommendedVersion
public string RecommendedVersion { get; set; }The recommended version of the API.
Format: apis/{api}/versions/{version}
| Property Value | |
|---|---|
| Type | Description |
String | |
RecommendedVersionAsApiVersionName
public ApiVersionName RecommendedVersionAsApiVersionName { get; set; }ApiVersionName-typed view over the RecommendedVersion resource name property.
| Property Value | |
|---|---|
| Type | Description |
ApiVersionName | |
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. Last update timestamp.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |