references

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

Overview

Name	references
Type	Resource
Id	google.apigee.references

Fields

Name	Datatype	Description
name	string	Required. The resource id of this reference. Values must match the regular expression [\w\s-.]+.
description	string	Optional. A human-readable description of this reference.
refers	string	Required. The id of the resource to which this reference refers. Must be the id of a resource that exists in the parent environment and is of the given resource_type.
resourceType	string	The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.

Methods

Name	Accessible by	Required Params	Description
organizations_environments_references_get	SELECT	environmentsId, organizationsId, referencesId	Gets a Reference resource.
organizations_environments_references_create	INSERT	environmentsId, organizationsId	Creates a Reference in the specified environment.
organizations_environments_references_delete	DELETE	environmentsId, organizationsId, referencesId	Deletes a Reference from an environment. Returns the deleted Reference resource.
organizations_environments_references_update	REPLACE	environmentsId, organizationsId, referencesId	Updates an existing Reference. Note that this operation has PUT semantics; it will replace the entirety of the existing Reference with the resource in the request body.

SELECT examples

Gets a Reference resource.

SELECT
name,
description,
refers,
resourceType
FROM google.apigee.references
WHERE environmentsId = '{{ environmentsId }}'
AND organizationsId = '{{ organizationsId }}'
AND referencesId = '{{ referencesId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.apigee.references (
environmentsId,
organizationsId,
description,
name,
resourceType,
refers
)
SELECT 
'{{ environmentsId }}',
'{{ organizationsId }}',
'{{ description }}',
'{{ name }}',
'{{ resourceType }}',
'{{ refers }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: description
      value: string
    - name: name
      value: string
    - name: resourceType
      value: string
    - name: refers
      value: string

REPLACE example

Replaces all fields in the specified references resource.

/*+ update */
REPLACE google.apigee.references
SET 
description = '{{ description }}',
name = '{{ name }}',
resourceType = '{{ resourceType }}',
refers = '{{ refers }}'
WHERE 
environmentsId = '{{ environmentsId }}'
AND organizationsId = '{{ organizationsId }}'
AND referencesId = '{{ referencesId }}';

DELETE example

Deletes the specified references resource.

/*+ delete */
DELETE FROM google.apigee.references
WHERE environmentsId = '{{ environmentsId }}'
AND organizationsId = '{{ organizationsId }}'
AND referencesId = '{{ referencesId }}';