entries

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

Overview

Name	entries
Type	Resource
Id	google.apigee.entries

Fields

The following fields are returned by SELECT queries:

organizations_apis_keyvaluemaps_entries_get

Successful response

Name	Datatype	Description
name	string	Resource URI that can be used to identify the scope of the key value map entries.
value	string	Required. Data or payload that is being retrieved and associated with the unique key.

organizations_environments_keyvaluemaps_entries_get

Successful response

Name	Datatype	Description
name	string	Resource URI that can be used to identify the scope of the key value map entries.
value	string	Required. Data or payload that is being retrieved and associated with the unique key.

organizations_apis_keyvaluemaps_entries_list

Successful response

Name	Datatype	Description
name	string	Resource URI that can be used to identify the scope of the key value map entries.
value	string	Required. Data or payload that is being retrieved and associated with the unique key.

organizations_environments_keyvaluemaps_entries_list

Successful response

Name	Datatype	Description
name	string	Resource URI that can be used to identify the scope of the key value map entries.
value	string	Required. Data or payload that is being retrieved and associated with the unique key.

organizations_keyvaluemaps_entries_get

Successful response

Name	Datatype	Description
name	string	Resource URI that can be used to identify the scope of the key value map entries.
value	string	Required. Data or payload that is being retrieved and associated with the unique key.

organizations_keyvaluemaps_entries_list

Successful response

Name	Datatype	Description
name	string	Resource URI that can be used to identify the scope of the key value map entries.
value	string	Required. Data or payload that is being retrieved and associated with the unique key.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_apis_keyvaluemaps_entries_get	select	organizationsId, apisId, keyvaluemapsId, entriesId		Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.
organizations_environments_keyvaluemaps_entries_get	select	organizationsId, environmentsId, keyvaluemapsId, entriesId		Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.
organizations_apis_keyvaluemaps_entries_list	select	organizationsId, apisId, keyvaluemapsId	pageSize, pageToken	Lists key value entries for key values maps scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.
organizations_environments_keyvaluemaps_entries_list	select	organizationsId, environmentsId, keyvaluemapsId	pageSize, pageToken	Lists key value entries for key values maps scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.
organizations_keyvaluemaps_entries_get	select	organizationsId, keyvaluemapsId, entriesId		Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.
organizations_keyvaluemaps_entries_list	select	organizationsId, keyvaluemapsId	pageSize, pageToken	Lists key value entries for key values maps scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.
organizations_apis_keyvaluemaps_entries_create	insert	organizationsId, apisId, keyvaluemapsId		Creates key value entries in a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.
organizations_environments_keyvaluemaps_entries_create	insert	organizationsId, environmentsId, keyvaluemapsId		Creates key value entries in a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.
organizations_keyvaluemaps_entries_create	insert	organizationsId, keyvaluemapsId		Creates key value entries in a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.
organizations_apis_keyvaluemaps_entries_update	replace	organizationsId, apisId, keyvaluemapsId, entriesId		Update key value entry scoped to an organization, environment, or API proxy for an existing key.
organizations_environments_keyvaluemaps_entries_update	replace	organizationsId, environmentsId, keyvaluemapsId, entriesId		Update key value entry scoped to an organization, environment, or API proxy for an existing key.
organizations_keyvaluemaps_entries_update	replace	organizationsId, keyvaluemapsId, entriesId		Update key value entry scoped to an organization, environment, or API proxy for an existing key.
organizations_apis_keyvaluemaps_entries_delete	delete	organizationsId, apisId, keyvaluemapsId, entriesId		Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. Notes: * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher.
organizations_environments_keyvaluemaps_entries_delete	delete	organizationsId, environmentsId, keyvaluemapsId, entriesId		Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. Notes: * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher.
organizations_keyvaluemaps_entries_delete	delete	organizationsId, keyvaluemapsId, entriesId		Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. Notes: * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher.

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
entriesId	string
environmentsId	string
keyvaluemapsId	string
organizationsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

organizations_apis_keyvaluemaps_entries_get

Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.

SELECT
name,
value
FROM google.apigee.entries
WHERE organizationsId = '{{ organizationsId }}' -- required
AND apisId = '{{ apisId }}' -- required
AND keyvaluemapsId = '{{ keyvaluemapsId }}' -- required
AND entriesId = '{{ entriesId }}' -- required;

organizations_environments_keyvaluemaps_entries_get

Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.

SELECT
name,
value
FROM google.apigee.entries
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND keyvaluemapsId = '{{ keyvaluemapsId }}' -- required
AND entriesId = '{{ entriesId }}' -- required;

organizations_apis_keyvaluemaps_entries_list

Lists key value entries for key values maps scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.

SELECT
name,
value
FROM google.apigee.entries
WHERE organizationsId = '{{ organizationsId }}' -- required
AND apisId = '{{ apisId }}' -- required
AND keyvaluemapsId = '{{ keyvaluemapsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

organizations_environments_keyvaluemaps_entries_list

Lists key value entries for key values maps scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.

SELECT
name,
value
FROM google.apigee.entries
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND keyvaluemapsId = '{{ keyvaluemapsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

organizations_keyvaluemaps_entries_get

Get the key value entry value for a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.

SELECT
name,
value
FROM google.apigee.entries
WHERE organizationsId = '{{ organizationsId }}' -- required
AND keyvaluemapsId = '{{ keyvaluemapsId }}' -- required
AND entriesId = '{{ entriesId }}' -- required;

organizations_keyvaluemaps_entries_list

Lists key value entries for key values maps scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.

SELECT
name,
value
FROM google.apigee.entries
WHERE organizationsId = '{{ organizationsId }}' -- required
AND keyvaluemapsId = '{{ keyvaluemapsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

organizations_apis_keyvaluemaps_entries_create

Creates key value entries in a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.

INSERT INTO google.apigee.entries (
data__name,
data__value,
organizationsId,
apisId,
keyvaluemapsId
)
SELECT 
'{{ name }}',
'{{ value }}',
'{{ organizationsId }}',
'{{ apisId }}',
'{{ keyvaluemapsId }}'
RETURNING
name,
value
;

organizations_environments_keyvaluemaps_entries_create

Creates key value entries in a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.

INSERT INTO google.apigee.entries (
data__name,
data__value,
organizationsId,
environmentsId,
keyvaluemapsId
)
SELECT 
'{{ name }}',
'{{ value }}',
'{{ organizationsId }}',
'{{ environmentsId }}',
'{{ keyvaluemapsId }}'
RETURNING
name,
value
;

organizations_keyvaluemaps_entries_create

Creates key value entries in a key value map scoped to an organization, environment, or API proxy. Note: Supported for Apigee hybrid 1.8.x and higher.

INSERT INTO google.apigee.entries (
data__name,
data__value,
organizationsId,
keyvaluemapsId
)
SELECT 
'{{ name }}',
'{{ value }}',
'{{ organizationsId }}',
'{{ keyvaluemapsId }}'
RETURNING
name,
value
;

Manifest

# Description fields are for documentation purposes
- name: entries
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the entries resource.
    - name: apisId
      value: string
      description: Required parameter for the entries resource.
    - name: keyvaluemapsId
      value: string
      description: Required parameter for the entries resource.
    - name: environmentsId
      value: string
      description: Required parameter for the entries resource.
    - name: name
      value: string
      description: >
        Resource URI that can be used to identify the scope of the key value map entries.
        
    - name: value
      value: string
      description: >
        Required. Data or payload that is being retrieved and associated with the unique key.
        

REPLACE examples

organizations_apis_keyvaluemaps_entries_update

Update key value entry scoped to an organization, environment, or API proxy for an existing key.

REPLACE google.apigee.entries
SET 
data__name = '{{ name }}',
data__value = '{{ value }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND apisId = '{{ apisId }}' --required
AND keyvaluemapsId = '{{ keyvaluemapsId }}' --required
AND entriesId = '{{ entriesId }}' --required
RETURNING
name,
value;

organizations_environments_keyvaluemaps_entries_update

Update key value entry scoped to an organization, environment, or API proxy for an existing key.

REPLACE google.apigee.entries
SET 
data__name = '{{ name }}',
data__value = '{{ value }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND keyvaluemapsId = '{{ keyvaluemapsId }}' --required
AND entriesId = '{{ entriesId }}' --required
RETURNING
name,
value;

organizations_keyvaluemaps_entries_update

Update key value entry scoped to an organization, environment, or API proxy for an existing key.

REPLACE google.apigee.entries
SET 
data__name = '{{ name }}',
data__value = '{{ value }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND keyvaluemapsId = '{{ keyvaluemapsId }}' --required
AND entriesId = '{{ entriesId }}' --required
RETURNING
name,
value;

DELETE examples

organizations_apis_keyvaluemaps_entries_delete

Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. Notes: * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher.

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

organizations_environments_keyvaluemaps_entries_delete

Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. Notes: * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher.

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

organizations_keyvaluemaps_entries_delete

Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. Notes: * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher.

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