environments_debugmask

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

Overview

Name	environments_debugmask
Type	Resource
Id	google.apigee.environments_debugmask

Fields

The following fields are returned by SELECT queries:

organizations_environments_get_debugmask

Successful response

Name	Datatype	Description
name	string	Name of the debug mask.
faultJSONPaths	array	List of JSON paths that specify the JSON elements to be filtered from JSON payloads in error flows.
faultXPaths	array	List of XPaths that specify the XML elements to be filtered from XML payloads in error flows.
namespaces	object	Map of namespaces to URIs.
requestJSONPaths	array	List of JSON paths that specify the JSON elements to be filtered from JSON request message payloads.
requestXPaths	array	List of XPaths that specify the XML elements to be filtered from XML request message payloads.
responseJSONPaths	array	List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads.
responseXPaths	array	List of XPaths that specify the XML elements to be filtered from XML response message payloads.
variables	array	List of variables that should be masked from the debug output.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_environments_get_debugmask	select	organizationsId, environmentsId		Gets the debug mask singleton resource for an environment.
organizations_environments_update_debugmask	update	organizationsId, environmentsId	updateMask, replaceRepeatedFields	Updates the debug mask singleton resource for an environment.

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
replaceRepeatedFields	boolean
updateMask	string (google-fieldmask)

SELECT examples

organizations_environments_get_debugmask

Gets the debug mask singleton resource for an environment.

SELECT
name,
faultJSONPaths,
faultXPaths,
namespaces,
requestJSONPaths,
requestXPaths,
responseJSONPaths,
responseXPaths,
variables
FROM google.apigee.environments_debugmask
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required;

UPDATE examples

organizations_environments_update_debugmask

Updates the debug mask singleton resource for an environment.

UPDATE google.apigee.environments_debugmask
SET 
data__name = '{{ name }}',
data__namespaces = '{{ namespaces }}',
data__requestXPaths = '{{ requestXPaths }}',
data__responseXPaths = '{{ responseXPaths }}',
data__faultXPaths = '{{ faultXPaths }}',
data__requestJSONPaths = '{{ requestJSONPaths }}',
data__responseJSONPaths = '{{ responseJSONPaths }}',
data__faultJSONPaths = '{{ faultJSONPaths }}',
data__variables = '{{ variables }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND updateMask = '{{ updateMask}}'
AND replaceRepeatedFields = {{ replaceRepeatedFields}}
RETURNING
name,
faultJSONPaths,
faultXPaths,
namespaces,
requestJSONPaths,
requestXPaths,
responseJSONPaths,
responseXPaths,
variables;