keyvaluemaps

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

Overview

Name	keyvaluemaps
Type	Resource
Id	google.apigee.keyvaluemaps

Fields

The following fields are returned by SELECT queries:

organizations_apis_keyvaluemaps_get

Name	Datatype	Description
name	string	Required. ID of the key value map.
encrypted	boolean	Required. Flag that specifies whether entry values will be encrypted. This field is retained for backward compatibility and the value of encrypted will always be true. Apigee X and hybrid do not support unencrypted key value maps.
maskedValues	boolean	Optional. Flag that specifies whether entry values will be masked when returned.

organizations_environments_keyvaluemaps_get

Name	Datatype	Description
name	string	Required. ID of the key value map.
encrypted	boolean	Required. Flag that specifies whether entry values will be encrypted. This field is retained for backward compatibility and the value of encrypted will always be true. Apigee X and hybrid do not support unencrypted key value maps.
maskedValues	boolean	Optional. Flag that specifies whether entry values will be masked when returned.

organizations_keyvaluemaps_get

Name	Datatype	Description
name	string	Required. ID of the key value map.
encrypted	boolean	Required. Flag that specifies whether entry values will be encrypted. This field is retained for backward compatibility and the value of encrypted will always be true. Apigee X and hybrid do not support unencrypted key value maps.
maskedValues	boolean	Optional. Flag that specifies whether entry values will be masked when returned.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_apis_keyvaluemaps_get	select	organizationsId, apisId, keyvaluemapsId		Get the key value map scoped to an organization, environment, or API proxy.
organizations_environments_keyvaluemaps_get	select	organizationsId, environmentsId, keyvaluemapsId		Get the key value map scoped to an organization, environment, or API proxy.
organizations_keyvaluemaps_get	select	organizationsId, keyvaluemapsId		Get the key value map scoped to an organization, environment, or API proxy.
organizations_apis_keyvaluemaps_create	insert	organizationsId, apisId		Creates a key value map in an API proxy.
organizations_environments_keyvaluemaps_create	insert	organizationsId, environmentsId		Creates a key value map in an environment.
organizations_keyvaluemaps_create	insert	organizationsId		Creates a key value map in an organization.
organizations_apis_keyvaluemaps_update	replace	organizationsId, apisId, keyvaluemapsId		Update the key value map scoped to an organization, environment, or API proxy.
organizations_environments_keyvaluemaps_update	replace	organizationsId, environmentsId, keyvaluemapsId		Update the key value map scoped to an organization, environment, or API proxy.
organizations_keyvaluemaps_update	replace	organizationsId, keyvaluemapsId		Update the key value map scoped to an organization, environment, or API proxy.
organizations_apis_keyvaluemaps_delete	delete	organizationsId, apisId, keyvaluemapsId		Deletes a key value map from an API proxy.
organizations_environments_keyvaluemaps_delete	delete	organizationsId, environmentsId, keyvaluemapsId		Deletes a key value map from an environment.
organizations_keyvaluemaps_delete	delete	organizationsId, keyvaluemapsId		Deletes a key value map from an organization.

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
apisId	string
environmentsId	string
keyvaluemapsId	string
organizationsId	string

SELECT examples

organizations_apis_keyvaluemaps_get

Get the key value map scoped to an organization, environment, or API proxy.

SELECT
name,
encrypted,
maskedValues
FROM google.apigee.keyvaluemaps
WHERE organizationsId = '{{ organizationsId }}' -- required
AND apisId = '{{ apisId }}' -- required
AND keyvaluemapsId = '{{ keyvaluemapsId }}' -- required
;

organizations_environments_keyvaluemaps_get

Get the key value map scoped to an organization, environment, or API proxy.

SELECT
name,
encrypted,
maskedValues
FROM google.apigee.keyvaluemaps
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND keyvaluemapsId = '{{ keyvaluemapsId }}' -- required
;

organizations_keyvaluemaps_get

Get the key value map scoped to an organization, environment, or API proxy.

SELECT
name,
encrypted,
maskedValues
FROM google.apigee.keyvaluemaps
WHERE organizationsId = '{{ organizationsId }}' -- required
AND keyvaluemapsId = '{{ keyvaluemapsId }}' -- required
;

INSERT examples

organizations_apis_keyvaluemaps_create

Creates a key value map in an API proxy.

INSERT INTO google.apigee.keyvaluemaps (
data__name,
data__maskedValues,
data__encrypted,
organizationsId,
apisId
)
SELECT 
'{{ name }}',
{{ maskedValues }},
{{ encrypted }},
'{{ organizationsId }}',
'{{ apisId }}'
RETURNING
name,
encrypted,
maskedValues
;

organizations_environments_keyvaluemaps_create

Creates a key value map in an environment.

INSERT INTO google.apigee.keyvaluemaps (
data__name,
data__maskedValues,
data__encrypted,
organizationsId,
environmentsId
)
SELECT 
'{{ name }}',
{{ maskedValues }},
{{ encrypted }},
'{{ organizationsId }}',
'{{ environmentsId }}'
RETURNING
name,
encrypted,
maskedValues
;

organizations_keyvaluemaps_create

Creates a key value map in an organization.

INSERT INTO google.apigee.keyvaluemaps (
data__name,
data__maskedValues,
data__encrypted,
organizationsId
)
SELECT 
'{{ name }}',
{{ maskedValues }},
{{ encrypted }},
'{{ organizationsId }}'
RETURNING
name,
encrypted,
maskedValues
;

Manifest

# Description fields are for documentation purposes
- name: keyvaluemaps
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the keyvaluemaps resource.
    - name: apisId
      value: string
      description: Required parameter for the keyvaluemaps resource.
    - name: environmentsId
      value: string
      description: Required parameter for the keyvaluemaps resource.
    - name: name
      value: string
      description: >
        Required. ID of the key value map.
        
    - name: maskedValues
      value: boolean
      description: >
        Optional. Flag that specifies whether entry values will be masked when returned.
        
    - name: encrypted
      value: boolean
      description: >
        Required. Flag that specifies whether entry values will be encrypted. This field is retained for backward compatibility and the value of encrypted will always be `true`. Apigee X and hybrid do not support unencrypted key value maps.
        

REPLACE examples

organizations_apis_keyvaluemaps_update

Update the key value map scoped to an organization, environment, or API proxy.

REPLACE google.apigee.keyvaluemaps
SET 
data__name = '{{ name }}',
data__maskedValues = {{ maskedValues }},
data__encrypted = {{ encrypted }}
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND apisId = '{{ apisId }}' --required
AND keyvaluemapsId = '{{ keyvaluemapsId }}' --required
RETURNING
name,
encrypted,
maskedValues;

organizations_environments_keyvaluemaps_update

Update the key value map scoped to an organization, environment, or API proxy.

REPLACE google.apigee.keyvaluemaps
SET 
data__name = '{{ name }}',
data__maskedValues = {{ maskedValues }},
data__encrypted = {{ encrypted }}
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND keyvaluemapsId = '{{ keyvaluemapsId }}' --required
RETURNING
name,
encrypted,
maskedValues;

organizations_keyvaluemaps_update

Update the key value map scoped to an organization, environment, or API proxy.

REPLACE google.apigee.keyvaluemaps
SET 
data__name = '{{ name }}',
data__maskedValues = {{ maskedValues }},
data__encrypted = {{ encrypted }}
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND keyvaluemapsId = '{{ keyvaluemapsId }}' --required
RETURNING
name,
encrypted,
maskedValues;

DELETE examples

organizations_apis_keyvaluemaps_delete

Deletes a key value map from an API proxy.

DELETE FROM google.apigee.keyvaluemaps
WHERE organizationsId = '{{ organizationsId }}' --required
AND apisId = '{{ apisId }}' --required
AND keyvaluemapsId = '{{ keyvaluemapsId }}' --required
;

organizations_environments_keyvaluemaps_delete

Deletes a key value map from an environment.

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

organizations_keyvaluemaps_delete

Deletes a key value map from an organization.

DELETE FROM google.apigee.keyvaluemaps
WHERE organizationsId = '{{ organizationsId }}' --required
AND keyvaluemapsId = '{{ keyvaluemapsId }}' --required
;