apis

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

Overview

Name	apis
Type	Resource
Id	google.apigeeregistry.apis

Fields

Name	Datatype	Description
name	string	Resource name.
description	string	A detailed description.
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.
availability	string	A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".
createTime	string	Output only. Creation timestamp.
displayName	string	Human-meaningful name.
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.
recommendedDeployment	string	The recommended deployment of the API. Format: projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}
recommendedVersion	string	The recommended version of the API. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}
updateTime	string	Output only. Last update timestamp.

Methods

Name	Accessible by	Required Params	Description
projects_locations_apis_get	SELECT	apisId, locationsId, projectsId	Returns a specified API.
projects_locations_apis_list	SELECT	locationsId, projectsId	Returns matching APIs.
projects_locations_apis_create	INSERT	locationsId, projectsId	Creates a specified API.
projects_locations_apis_delete	DELETE	apisId, locationsId, projectsId	Removes a specified API and all of the resources that it owns.
projects_locations_apis_patch	UPDATE	apisId, locationsId, projectsId	Used to modify a specified API.

SELECT examples

Returns matching APIs.

SELECT
name,
description,
annotations,
availability,
createTime,
displayName,
labels,
recommendedDeployment,
recommendedVersion,
updateTime
FROM google.apigeeregistry.apis
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.apigeeregistry.apis (
locationsId,
projectsId,
name,
displayName,
description,
availability,
recommendedVersion,
recommendedDeployment,
labels,
annotations
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ displayName }}',
'{{ description }}',
'{{ availability }}',
'{{ recommendedVersion }}',
'{{ recommendedDeployment }}',
'{{ labels }}',
'{{ annotations }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: description
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: availability
      value: string
    - name: recommendedVersion
      value: string
    - name: recommendedDeployment
      value: string
    - name: labels
      value: object
    - name: annotations
      value: object

UPDATE example

Updates a apis resource.

/*+ update */
UPDATE google.apigeeregistry.apis
SET 
name = '{{ name }}',
displayName = '{{ displayName }}',
description = '{{ description }}',
availability = '{{ availability }}',
recommendedVersion = '{{ recommendedVersion }}',
recommendedDeployment = '{{ recommendedDeployment }}',
labels = '{{ labels }}',
annotations = '{{ annotations }}'
WHERE 
apisId = '{{ apisId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified apis resource.

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