Skip to main content

deployment_revisions

Creates, updates, deletes, gets or lists a deployment_revisions resource.

Overview

Namedeployment_revisions
TypeResource
Idgoogle.apigeeregistry.deployment_revisions

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringResource name.
accessGuidancestringText briefly describing how to access the endpoint. Changes to this value will not affect the revision.
annotationsobjectAnnotations 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.
apiSpecRevisionstringThe 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}
createTimestring (google-datetime)Output only. Creation timestamp; when the deployment resource was created.
descriptionstringA detailed description.
displayNamestringHuman-meaningful name.
endpointUristringThe address where the deployment is serving. Changes to this value will update the revision.
externalChannelUristringThe address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.
intendedAudiencestringText briefly identifying the intended audience of the API. Changes to this value will not affect the revision.
labelsobjectLabels 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.
revisionCreateTimestring (google-datetime)Output only. Revision creation timestamp; when the represented revision was created.
revisionIdstringOutput 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.
revisionUpdateTimestring (google-datetime)Output only. Last update timestamp: when the represented revision was last modified.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
projects_locations_apis_deployments_list_revisionsselectprojectsId, locationsId, apisId, deploymentsIdpageSize, pageToken, filterLists all revisions of a deployment. Revisions are returned in descending order of revision creation time.
projects_locations_apis_deployments_delete_revisiondeleteprojectsId, locationsId, apisId, deploymentsIdDeletes 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.

NameDatatypeDescription
apisIdstring
deploymentsIdstring
locationsIdstring
projectsIdstring
filterstring
pageSizeinteger (int32)
pageTokenstring

SELECT examples

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

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;