public sealed class Api : IMessage<Api>, IEquatable<Api>, IDeepCloneable<Api>, IBufferMessage, IMessageReference documentation and code samples for the API hub v1 API class Api.
An API resource in the API Hub.
Namespace
Google.Cloud.ApiHub.V1Assembly
Google.Cloud.ApiHub.V1.dll
Constructors
Api()
public Api()Api(Api)
public Api(Api other)| Parameter | |
|---|---|
| Name | Description |
other |
Api |
Properties
ApiFunctionalRequirements
public AttributeValues ApiFunctionalRequirements { get; set; }Optional. The api functional requirements associated with the API resource.
Carinality is 1 for this attribute.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-api-functional-requirements
attribute. The value of the attribute should be a proper URI, and in case
of Cloud Storage URI, it should point to a Cloud Storage object,
not a directory.
| Property Value | |
|---|---|
| Type | Description |
AttributeValues |
|
ApiName
public ApiName ApiName { get; set; }| Property Value | |
|---|---|
| Type | Description |
ApiName |
|
ApiRequirements
public AttributeValues ApiRequirements { get; set; }Optional. The api requirement doc associated with the API resource.
Carinality is 1 for this attribute. This maps to the following system
defined attribute:
projects/{project}/locations/{location}/attributes/system-api-requirements
attribute. The value of the attribute should be a proper URI, and in case
of Cloud Storage URI, it should point to a Cloud Storage object,
not a directory.
| Property Value | |
|---|---|
| Type | Description |
AttributeValues |
|
ApiStyle
public AttributeValues ApiStyle { get; set; }Optional. The style of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-api-style
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
| Property Value | |
|---|---|
| Type | Description |
AttributeValues |
|
ApiTechnicalRequirements
public AttributeValues ApiTechnicalRequirements { get; set; }Optional. The api technical requirements associated with the API resource.
Carinality is 1 for this attribute. This maps to the following system
defined attribute:
projects/{project}/locations/{location}/attributes/system-api-technical-requirements
attribute. The value of the attribute should be a proper URI, and in case
of Cloud Storage URI, it should point to a Cloud Storage object,
not a directory.
| Property Value | |
|---|---|
| Type | Description |
AttributeValues |
|
Attributes
public MapField<string, AttributeValues> Attributes { get; }Optional. The list of user defined attributes associated with the API
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 |
|
BusinessUnit
public AttributeValues BusinessUnit { get; set; }Optional. The business unit owning the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-business-unit
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
| Property Value | |
|---|---|
| Type | Description |
AttributeValues |
|
CreateTime
public Timestamp CreateTime { get; set; }Output only. The time at which the API resource was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
Description
public string Description { get; set; }Optional. The description of the API resource.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DisplayName
public string DisplayName { get; set; }Required. The display name of the API resource.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Documentation
public Documentation Documentation { get; set; }Optional. The documentation for the API resource.
| Property Value | |
|---|---|
| Type | Description |
Documentation |
|
Fingerprint
public string Fingerprint { get; set; }Optional. Fingerprint of the API resource.
| Property Value | |
|---|---|
| Type | Description |
string |
|
MaturityLevel
public AttributeValues MaturityLevel { get; set; }Optional. The maturity level of the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-maturity-level
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
| Property Value | |
|---|---|
| Type | Description |
AttributeValues |
|
Name
public string Name { get; set; }Identifier. The name of the API resource in the API Hub.
Format:
projects/{project}/locations/{location}/apis/{api}
| Property Value | |
|---|---|
| Type | Description |
string |
|
Owner
public Owner Owner { get; set; }Optional. Owner details for the API resource.
| Property Value | |
|---|---|
| Type | Description |
Owner |
|
SelectedVersion
public string SelectedVersion { get; set; }Optional. The selected version for an API resource.
This can be used when special handling is needed on client side for
particular version of the API. Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}
| Property Value | |
|---|---|
| Type | Description |
string |
|
SelectedVersionAsVersionName
public VersionName SelectedVersionAsVersionName { get; set; }VersionName-typed view over the SelectedVersion resource name property.
| Property Value | |
|---|---|
| Type | Description |
VersionName |
|
SourceMetadata
public RepeatedField<SourceMetadata> SourceMetadata { get; }Output only. The list of sources and metadata from the sources of the API resource.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldSourceMetadata |
|
TargetUser
public AttributeValues TargetUser { get; set; }Optional. The target users for the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-target-user
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
| Property Value | |
|---|---|
| Type | Description |
AttributeValues |
|
Team
public AttributeValues Team { get; set; }Optional. The team owning the API.
This maps to the following system defined attribute:
projects/{project}/locations/{location}/attributes/system-team
attribute.
The number of values for this attribute will be based on the
cardinality of the attribute. The same can be retrieved via GetAttribute
API. All values should be from the list of allowed values defined for the
attribute.
| Property Value | |
|---|---|
| Type | Description |
AttributeValues |
|
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. The time at which the API resource was last updated.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
Versions
public RepeatedField<string> Versions { get; }Output only. The list of versions present in an API resource.
Note: An API resource can be associated with more than 1 version.
Format is
projects/{project}/locations/{location}/apis/{api}/versions/{version}
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
VersionsAsVersionNames
public ResourceNameList<VersionName> VersionsAsVersionNames { get; }VersionName-typed view over the Versions resource name property.
| Property Value | |
|---|---|
| Type | Description |
ResourceNameListVersionName |
|