public sealed class ExternalApi : IMessage<ExternalApi>, IEquatable<ExternalApi>, IDeepCloneable<ExternalApi>, IBufferMessage, IMessageReference documentation and code samples for the API hub v1 API class ExternalApi.
An external API represents an API being provided by external sources. This can be used to model third-party APIs and can be used to define dependencies.
Implements
IMessageExternalApi, IEquatableExternalApi, IDeepCloneableExternalApi, IBufferMessage, IMessageNamespace
Google.Cloud.ApiHub.V1Assembly
Google.Cloud.ApiHub.V1.dll
Constructors
ExternalApi()
public ExternalApi()ExternalApi(ExternalApi)
public ExternalApi(ExternalApi other)| Parameter | |
|---|---|
| Name | Description |
other |
ExternalApi |
Properties
Attributes
public MapField<string, AttributeValues> Attributes { get; }Optional. The list of user defined attributes associated with the Version
resource. The key is the attribute name. It will be of the format:
projects/{project}/locations/{location}/attributes/{attribute}.
The value is the attribute values associated with the resource.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringAttributeValues |
|
CreateTime
public Timestamp CreateTime { get; set; }Output only. Creation timestamp.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
Description
public string Description { get; set; }Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).
| Property Value | |
|---|---|
| Type | Description |
string |
|
DisplayName
public string DisplayName { get; set; }Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).
| Property Value | |
|---|---|
| Type | Description |
string |
|
Documentation
public Documentation Documentation { get; set; }Optional. Documentation of the external API.
| Property Value | |
|---|---|
| Type | Description |
Documentation |
|
Endpoints
public RepeatedField<string> Endpoints { get; }Optional. List of endpoints on which this API is accessible.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
ExternalApiName
public ExternalApiName ExternalApiName { get; set; }ExternalApiName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
ExternalApiName |
|
Name
public string Name { get; set; }Identifier. Format:
projects/{project}/locations/{location}/externalApi/{externalApi}.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Paths
public RepeatedField<string> Paths { get; }Optional. List of paths served by this API.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. Last update timestamp.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|