deployment_revisions
Creates, updates, deletes, gets or lists a deployment_revisions
resource.
Overview
Name | deployment_revisions |
Type | Resource |
Id | google.apigeeregistry.deployment_revisions |
Fields
The following fields are returned by SELECT
queries:
- projects_locations_apis_deployments_list_revisions
Successful response
Name | Datatype | Description |
---|---|---|
name | string | Resource name. |
accessGuidance | string | Text briefly describing how to access the endpoint. 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. |
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} |
createTime | string (google-datetime) | Output only. Creation timestamp; when the deployment resource was created. |
description | string | A detailed description. |
displayName | string | Human-meaningful name. |
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. |
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. |
revisionCreateTime | string (google-datetime) | Output only. Revision creation timestamp; when the represented revision was created. |
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. |
revisionUpdateTime | string (google-datetime) | Output only. Last update timestamp: when the represented revision was last modified. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
projects_locations_apis_deployments_list_revisions | select | projectsId , locationsId , apisId , deploymentsId | pageSize , pageToken , filter | Lists all revisions of a deployment. Revisions are returned in descending order of revision creation time. |
projects_locations_apis_deployments_delete_revision | delete | projectsId , locationsId , apisId , deploymentsId | Deletes a revision of a deployment. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
apisId | string | |
deploymentsId | string | |
locationsId | string | |
projectsId | string | |
filter | string | |
pageSize | integer (int32) | |
pageToken | string |
SELECT
examples
- projects_locations_apis_deployments_list_revisions
Lists all revisions of a deployment. Revisions are returned in descending order of revision creation time.
SELECT
name,
accessGuidance,
annotations,
apiSpecRevision,
createTime,
description,
displayName,
endpointUri,
externalChannelUri,
intendedAudience,
labels,
revisionCreateTime,
revisionId,
revisionUpdateTime
FROM google.apigeeregistry.deployment_revisions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND apisId = '{{ apisId }}' -- required
AND deploymentsId = '{{ deploymentsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';
DELETE
examples
- projects_locations_apis_deployments_delete_revision
Deletes a revision of a deployment.
DELETE FROM google.apigeeregistry.deployment_revisions
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND apisId = '{{ apisId }}' --required
AND deploymentsId = '{{ deploymentsId }}' --required;