deployments
Overview
| Name | deployments |
| Type | Resource |
| Id | google.apigeeregistry.deployments |
Fields
| Name | Datatype | Description |
|---|---|---|
name | string | Resource name. |
description | string | A detailed description. |
labels | object | 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. |
accessGuidance | string | Text briefly describing how to access the endpoint. 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. |
endpointUri | string | The address where the deployment is serving. Changes to this value will update the revision. |
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. |
displayName | string | Human-meaningful name. |
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. |
annotations | object | 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. |
revisionCreateTime | string | Output only. Revision creation timestamp; when the represented revision was created. |
createTime | string | Output only. Creation timestamp; when the deployment resource was created. |
revisionUpdateTime | string | Output only. Last update timestamp: when the represented revision was last modified. |
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} |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
projects_locations_apis_deployments_get | SELECT | apisId, deploymentsId, locationsId, projectsId | Returns a specified deployment. |
projects_locations_apis_deployments_list | SELECT | apisId, locationsId, projectsId | Returns matching deployments. |
projects_locations_apis_deployments_create | INSERT | apisId, locationsId, projectsId | Creates a specified deployment. |
projects_locations_apis_deployments_delete | DELETE | apisId, deploymentsId, locationsId, projectsId | Removes a specified deployment, all revisions, and all child resources (e.g., artifacts). |
_projects_locations_apis_deployments_list | EXEC | apisId, locationsId, projectsId | Returns matching deployments. |
projects_locations_apis_deployments_patch | EXEC | apisId, deploymentsId, locationsId, projectsId | Used to modify a specified deployment. |
projects_locations_apis_deployments_rollback | EXEC | apisId, deploymentsId, locationsId, projectsId | Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID. |
projects_locations_apis_deployments_tag_revision | EXEC | apisId, deploymentsId, locationsId, projectsId | Adds a tag to a specified revision of a deployment. |