instances

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

Overview

Name	instances
Type	Resource
Id	google.apigeeregistry.instances

Fields

The following fields are returned by SELECT queries:

projects_locations_instances_get

Successful response

Name	Datatype	Description
name	string	Format: projects/*/locations/*/instance. Currently only locations/global is supported.
build	object	Output only. Build info of the Instance if it's in ACTIVE state. (id: Build)
config	object	Required. Config of the Instance. (id: Config)
createTime	string (google-datetime)	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 (google-datetime)	Output only. Last update timestamp.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_instances_get	select	projectsId, locationsId, instancesId		Gets details of a single Instance.
projects_locations_instances_create	insert	projectsId, locationsId	instanceId	Provisions instance resources for the Registry.
projects_locations_instances_delete	delete	projectsId, locationsId, instancesId		Deletes the Registry instance.

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
instancesId	string
locationsId	string
projectsId	string
instanceId	string

SELECT examples

projects_locations_instances_get

Gets details of a single Instance.

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

INSERT examples

projects_locations_instances_create

Provisions instance resources for the Registry.

INSERT INTO google.apigeeregistry.instances (
data__name,
data__config,
projectsId,
locationsId,
instanceId
)
SELECT 
'{{ name }}',
'{{ config }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ instanceId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: instances
  props:
    - name: projectsId
      value: string
      description: Required parameter for the instances resource.
    - name: locationsId
      value: string
      description: Required parameter for the instances resource.
    - name: name
      value: string
      description: >
        Format: `projects/*/locations/*/instance`. Currently only `locations/global` is supported.
        
    - name: config
      value: object
      description: >
        Required. Config of the Instance.
        
    - name: instanceId
      value: string

DELETE examples

projects_locations_instances_delete

Deletes the Registry instance.

DELETE FROM google.apigeeregistry.instances
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND instancesId = '{{ instancesId }}' --required;