instances

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

Overview

Name	instances
Type	Resource
Id	google.apigeeregistry.instances

Fields

Name	Datatype	Description
name	string	Format: projects/*/locations/*/instance. Currently only locations/global is supported.
build	object	Build information of the Instance if it's in ACTIVE state.
config	object	Available configurations to provision an Instance.
createTime	string	Output only. Creation timestamp.
state	string	Output only. The current state of the Instance.
stateMessage	string	Output only. Extra information of Instance.State if the state is FAILED.
updateTime	string	Output only. Last update timestamp.

Methods

Name	Accessible by	Required Params	Description
projects_locations_instances_get	SELECT	instancesId, locationsId, projectsId	Gets details of a single Instance.
projects_locations_instances_create	INSERT	locationsId, projectsId	Provisions instance resources for the Registry.
projects_locations_instances_delete	DELETE	instancesId, locationsId, projectsId	Deletes the Registry instance.

SELECT examples

Gets details of a single Instance.

SELECT
name,
build,
config,
createTime,
state,
stateMessage,
updateTime
FROM google.apigeeregistry.instances
WHERE instancesId = '{{ instancesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.apigeeregistry.instances (
locationsId,
projectsId,
name,
config
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ config }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: state
      value: string
    - name: stateMessage
      value: string
    - name: config
      value:
        - name: location
          value: string
        - name: cmekKeyName
          value: string
    - name: build
      value:
        - name: repo
          value: string
        - name: commitId
          value: string
        - name: commitTime
          value: string

DELETE example

Deletes the specified instances resource.

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