ApiDeployment(mapping=None, *, ignore_unknown_fields=False, **kwargs)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.
Attributes |
|
|---|---|
| Name | Description |
name |
str
Resource name. |
display_name |
str
Human-meaningful name. |
description |
str
A detailed description. |
revision_id |
str
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. |
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Creation timestamp; when the deployment resource was created. |
revision_create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Revision creation timestamp; when the represented revision was created. |
revision_update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Last update timestamp: when the represented revision was last modified. |
api_spec_revision |
str
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}
|
endpoint_uri |
str
The address where the deployment is serving. Changes to this value will update the revision. |
external_channel_uri |
str
The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision. |
intended_audience |
str
Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision. |
access_guidance |
str
Text briefly describing how to access the endpoint. Changes to this value will not affect the revision. |
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 |