REST Resource: projects.locations.apis.deployments

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

string

Resource name.
displayName

string

Human-meaningful name.
description

string

A detailed description.
revisionId

string

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

string (Timestamp format)

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: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
revisionCreateTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
revisionUpdateTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
apiSpecRevision

string

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: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec@revision}
endpointUri

string

The address where the deployment is serving. Changes to this value will update the revision.
externalChannelUri

string

The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.
intendedAudience

string

Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.
accessGuidance

string

Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.
labels

map (key: string, value: string)

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.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
annotations

map (key: string, value: string)

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 "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Methods

create

 Creates a specified deployment.

delete

 Removes a specified deployment, all revisions, and all child resources (e.g., artifacts).

deleteRevision

 Deletes a revision of a deployment.

get

 Returns a specified deployment.

getIamPolicy

 Gets the access control policy for a resource.

list

 Returns matching deployments.

listRevisions

 Lists all revisions of a deployment.

patch

 Used to modify a specified deployment.

rollback

 Sets the current revision to a specified prior revision.

setIamPolicy

 Sets the access control policy on the specified resource.

tagRevision

 Adds a tag to a specified revision of a deployment.

testIamPermissions

 Returns permissions that a caller has on the specified resource.