deployments

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

Overview

Name	deployments
Type	Resource
Id	google.apigeeregistry.deployments

Fields

The following fields are returned by SELECT queries:

projects_locations_apis_deployments_get

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.

projects_locations_apis_deployments_list

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_get	select	projectsId, locationsId, apisId, deploymentsId		Returns a specified deployment.
projects_locations_apis_deployments_list	select	projectsId, locationsId, apisId	pageToken, pageSize, orderBy, filter	Returns matching deployments.
projects_locations_apis_deployments_create	insert	projectsId, locationsId, apisId	apiDeploymentId	Creates a specified deployment.
projects_locations_apis_deployments_patch	update	projectsId, locationsId, apisId, deploymentsId	allowMissing, updateMask	Used to modify a specified deployment.
projects_locations_apis_deployments_delete	delete	projectsId, locationsId, apisId, deploymentsId	force	Removes a specified deployment, all revisions, and all child resources (e.g., artifacts).
projects_locations_apis_deployments_rollback	exec	projectsId, locationsId, apisId, deploymentsId		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	projectsId, locationsId, apisId, deploymentsId		Adds a tag to a specified 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
allowMissing	boolean
apiDeploymentId	string
filter	string
force	boolean
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_apis_deployments_get

Returns a specified deployment.

SELECT
name,
accessGuidance,
annotations,
apiSpecRevision,
createTime,
description,
displayName,
endpointUri,
externalChannelUri,
intendedAudience,
labels,
revisionCreateTime,
revisionId,
revisionUpdateTime
FROM google.apigeeregistry.deployments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND apisId = '{{ apisId }}' -- required
AND deploymentsId = '{{ deploymentsId }}' -- required
;

projects_locations_apis_deployments_list

Returns matching deployments.

SELECT
name,
accessGuidance,
annotations,
apiSpecRevision,
createTime,
description,
displayName,
endpointUri,
externalChannelUri,
intendedAudience,
labels,
revisionCreateTime,
revisionId,
revisionUpdateTime
FROM google.apigeeregistry.deployments
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND apisId = '{{ apisId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
;

INSERT examples

projects_locations_apis_deployments_create

Creates a specified deployment.

INSERT INTO google.apigeeregistry.deployments (
data__intendedAudience,
data__name,
data__labels,
data__annotations,
data__description,
data__endpointUri,
data__displayName,
data__accessGuidance,
data__apiSpecRevision,
data__externalChannelUri,
projectsId,
locationsId,
apisId,
apiDeploymentId
)
SELECT 
'{{ intendedAudience }}',
'{{ name }}',
'{{ labels }}',
'{{ annotations }}',
'{{ description }}',
'{{ endpointUri }}',
'{{ displayName }}',
'{{ accessGuidance }}',
'{{ apiSpecRevision }}',
'{{ externalChannelUri }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ apisId }}',
'{{ apiDeploymentId }}'
RETURNING
name,
accessGuidance,
annotations,
apiSpecRevision,
createTime,
description,
displayName,
endpointUri,
externalChannelUri,
intendedAudience,
labels,
revisionCreateTime,
revisionId,
revisionUpdateTime
;

Manifest

# Description fields are for documentation purposes
- name: deployments
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the deployments resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the deployments resource.
  - name: apisId
    value: "{{ apisId }}"
    description: Required parameter for the deployments resource.
  - name: intendedAudience
    value: "{{ intendedAudience }}"
    description: |
      Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.
  - name: name
    value: "{{ name }}"
    description: |
      Resource name.
  - name: labels
    value: "{{ labels }}"
    description: |
      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.
  - name: annotations
    value: "{{ annotations }}"
    description: |
      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.
  - name: description
    value: "{{ description }}"
    description: |
      A detailed description.
  - name: endpointUri
    value: "{{ endpointUri }}"
    description: |
      The address where the deployment is serving. Changes to this value will update the revision.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Human-meaningful name.
  - name: accessGuidance
    value: "{{ accessGuidance }}"
    description: |
      Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.
  - name: apiSpecRevision
    value: "{{ apiSpecRevision }}"
    description: |
      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}`
  - name: externalChannelUri
    value: "{{ externalChannelUri }}"
    description: |
      The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.
  - name: apiDeploymentId
    value: "{{ apiDeploymentId }}"

UPDATE examples

projects_locations_apis_deployments_patch

Used to modify a specified deployment.

UPDATE google.apigeeregistry.deployments
SET 
data__intendedAudience = '{{ intendedAudience }}',
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__annotations = '{{ annotations }}',
data__description = '{{ description }}',
data__endpointUri = '{{ endpointUri }}',
data__displayName = '{{ displayName }}',
data__accessGuidance = '{{ accessGuidance }}',
data__apiSpecRevision = '{{ apiSpecRevision }}',
data__externalChannelUri = '{{ externalChannelUri }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND apisId = '{{ apisId }}' --required
AND deploymentsId = '{{ deploymentsId }}' --required
AND allowMissing = {{ allowMissing}}
AND updateMask = '{{ updateMask}}'
RETURNING
name,
accessGuidance,
annotations,
apiSpecRevision,
createTime,
description,
displayName,
endpointUri,
externalChannelUri,
intendedAudience,
labels,
revisionCreateTime,
revisionId,
revisionUpdateTime;

DELETE examples

projects_locations_apis_deployments_delete

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

DELETE FROM google.apigeeregistry.deployments
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND apisId = '{{ apisId }}' --required
AND deploymentsId = '{{ deploymentsId }}' --required
AND force = '{{ force }}'
;

Lifecycle Methods

projects_locations_apis_deployments_rollback

Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID.

EXEC google.apigeeregistry.deployments.projects_locations_apis_deployments_rollback 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@apisId='{{ apisId }}' --required, 
@deploymentsId='{{ deploymentsId }}' --required 
@@json=
'{
"revisionId": "{{ revisionId }}"
}'
;

projects_locations_apis_deployments_tag_revision

Adds a tag to a specified revision of a deployment.

EXEC google.apigeeregistry.deployments.projects_locations_apis_deployments_tag_revision 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@apisId='{{ apisId }}' --required, 
@deploymentsId='{{ deploymentsId }}' --required 
@@json=
'{
"tag": "{{ tag }}"
}'
;