Resource: ApiDeployment
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.
JSON representation |
---|
{ "name": string, "displayName": string, "description": string, "revisionId": string, "createTime": string, "revisionCreateTime": string, "revisionUpdateTime": string, "apiSpecRevision": string, "endpointUri": string, "externalChannelUri": string, "intendedAudience": string, "accessGuidance": string, "labels": { string: string, ... }, "annotations": { string: string, ... } } |
Fields | |
---|---|
name |
Resource name. |
displayName |
Human-meaningful name. |
description |
A detailed description. |
revisionId |
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. |
createTime |
Output only. Creation timestamp; when the deployment resource was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
revisionCreateTime |
Output only. Revision creation timestamp; when the represented revision was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
revisionUpdateTime |
Output only. Last update timestamp: when the represented revision was last modified. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
apiSpecRevision |
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: |
endpointUri |
The address where the deployment is serving. Changes to this value will update the revision. |
externalChannelUri |
The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision. |
intendedAudience |
Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision. |
accessGuidance |
Text briefly describing how to access the endpoint. Changes to this value will not affect the revision. |
labels |
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 An object containing a list of |
annotations |
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. An object containing a list of |
Methods |
|
---|---|
|
Creates a specified deployment. |
|
Removes a specified deployment, all revisions, and all child resources (e.g., artifacts). |
|
Deletes a revision of a deployment. |
|
Returns a specified deployment. |
|
Gets the access control policy for a resource. |
|
Returns matching deployments. |
|
Lists all revisions of a deployment. |
|
Used to modify a specified deployment. |
|
Sets the current revision to a specified prior revision. |
|
Sets the access control policy on the specified resource. |
|
Adds a tag to a specified revision of a deployment. |
|
Returns permissions that a caller has on the specified resource. |