Api(mapping=None, *, ignore_unknown_fields=False, **kwargs)A top-level description of an API. Produced by producers and are commitments to provide services.
Attributes |
|
|---|---|
| Name | Description |
name |
str
Resource name. |
display_name |
str
Human-meaningful name. |
description |
str
A detailed description. |
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Creation timestamp. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Last update timestamp. |
availability |
str
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". |
recommended_version |
str
The recommended version of the API. Format: apis/{api}/versions/{version}
|
recommended_deployment |
str
The recommended deployment of the API. Format: apis/{api}/deployments/{deployment}
|
labels |
MutableMapping[str, str]
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.
|
annotations |
MutableMapping[str, str]
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. |
Classes
AnnotationsEntry
AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |