references

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

Overview

Name	references
Type	Resource
Id	google.apigee.references

Fields

The following fields are returned by SELECT queries:

organizations_environments_references_get

Successful response

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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_environments_references_get	select	organizationsId, environmentsId, referencesId		Gets a Reference resource.
organizations_environments_references_create	insert	organizationsId, environmentsId		Creates a Reference in the specified environment.
organizations_environments_references_update	replace	organizationsId, environmentsId, 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.
organizations_environments_references_delete	delete	organizationsId, environmentsId, referencesId		Deletes a Reference from an environment. Returns the deleted Reference resource.

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
environmentsId	string
organizationsId	string
referencesId	string

SELECT examples

organizations_environments_references_get

Gets a Reference resource.

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

INSERT examples

organizations_environments_references_create

Creates a Reference in the specified environment.

INSERT INTO google.apigee.references (
data__name,
data__description,
data__resourceType,
data__refers,
organizationsId,
environmentsId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ resourceType }}',
'{{ refers }}',
'{{ organizationsId }}',
'{{ environmentsId }}'
RETURNING
name,
description,
refers,
resourceType
;

Manifest

# Description fields are for documentation purposes
- name: references
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the references resource.
    - name: environmentsId
      value: string
      description: Required parameter for the references resource.
    - name: name
      value: string
      description: >
        Required. The resource id of this reference. Values must match the regular expression [\w
        \-.]+.
        
    - name: description
      value: string
      description: >
        Optional. A human-readable description of this reference.
        
    - name: resourceType
      value: string
      description: >
        The type of resource referred to by this reference. Valid values are 'KeyStore' or 'TrustStore'.
        
    - name: refers
      value: string
      description: >
        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.
        

REPLACE examples

organizations_environments_references_update

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.

REPLACE google.apigee.references
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__resourceType = '{{ resourceType }}',
data__refers = '{{ refers }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND referencesId = '{{ referencesId }}' --required
RETURNING
name,
description,
refers,
resourceType;

DELETE examples

organizations_environments_references_delete

Deletes a Reference from an environment. Returns the deleted Reference resource.

DELETE FROM google.apigee.references
WHERE organizationsId = '{{ organizationsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND referencesId = '{{ referencesId }}' --required;