deployments

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

Overview

Name	deployments
Type	Resource
Id	google.apigeeregistry.deployments

Fields

Name	Datatype	Description
name	string	Resource name.
description	string	A detailed description.
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	Output only. Creation timestamp; when the deployment resource was created.
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	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	Output only. Last update timestamp: when the represented revision was last modified.

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_patch	UPDATE	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.

SELECT examples

Returns matching deployments.

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

INSERT example

Use the following StackQL query and manifest file to create a new deployments resource.

All Properties

/*+ create */
INSERT INTO google.apigeeregistry.deployments (
apisId,
locationsId,
projectsId,
name,
displayName,
description,
apiSpecRevision,
endpointUri,
externalChannelUri,
intendedAudience,
accessGuidance,
labels,
annotations
)
SELECT 
'{{ apisId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ displayName }}',
'{{ description }}',
'{{ apiSpecRevision }}',
'{{ endpointUri }}',
'{{ externalChannelUri }}',
'{{ intendedAudience }}',
'{{ accessGuidance }}',
'{{ labels }}',
'{{ annotations }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: description
      value: string
    - name: revisionId
      value: string
    - name: createTime
      value: string
    - name: revisionCreateTime
      value: string
    - name: revisionUpdateTime
      value: string
    - name: apiSpecRevision
      value: string
    - name: endpointUri
      value: string
    - name: externalChannelUri
      value: string
    - name: intendedAudience
      value: string
    - name: accessGuidance
      value: string
    - name: labels
      value: object
    - name: annotations
      value: object

UPDATE example

Updates a deployments resource.

/*+ update */
UPDATE google.apigeeregistry.deployments
SET 
name = '{{ name }}',
displayName = '{{ displayName }}',
description = '{{ description }}',
apiSpecRevision = '{{ apiSpecRevision }}',
endpointUri = '{{ endpointUri }}',
externalChannelUri = '{{ externalChannelUri }}',
intendedAudience = '{{ intendedAudience }}',
accessGuidance = '{{ accessGuidance }}',
labels = '{{ labels }}',
annotations = '{{ annotations }}'
WHERE 
apisId = '{{ apisId }}'
AND deploymentsId = '{{ deploymentsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified deployments resource.

/*+ delete */
DELETE FROM google.apigeeregistry.deployments
WHERE apisId = '{{ apisId }}'
AND deploymentsId = '{{ deploymentsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';