debugsessions

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

Overview

Name	debugsessions
Type	Resource
Id	google.apigee.debugsessions

Fields

Name	Datatype	Description
name	string	A unique ID for this DebugSession.
count	integer	Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10.
createTime	string	Output only. The first transaction creation timestamp, recorded by UAP.
filter	string	Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition.
timeout	string	Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided.
tracesize	integer	Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120.
validity	integer	Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10.

Methods

Name	Accessible by	Required Params	Description
organizations_environments_apis_revisions_debugsessions_get	SELECT	apisId, debugsessionsId, environmentsId, organizationsId, revisionsId	Retrieves a debug session.
organizations_environments_apis_revisions_debugsessions_list	SELECT	apisId, environmentsId, organizationsId, revisionsId	Lists debug sessions that are currently active in the given API Proxy revision.
organizations_environments_apis_revisions_debugsessions_create	INSERT	apisId, environmentsId, organizationsId, revisionsId	Creates a debug session for a deployed API Proxy revision.

SELECT examples

Lists debug sessions that are currently active in the given API Proxy revision.

SELECT
name,
count,
createTime,
filter,
timeout,
tracesize,
validity
FROM google.apigee.debugsessions
WHERE apisId = '{{ apisId }}'
AND environmentsId = '{{ environmentsId }}'
AND organizationsId = '{{ organizationsId }}'
AND revisionsId = '{{ revisionsId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.apigee.debugsessions (
apisId,
environmentsId,
organizationsId,
revisionsId,
timeout,
validity,
name,
count,
filter,
tracesize
)
SELECT 
'{{ apisId }}',
'{{ environmentsId }}',
'{{ organizationsId }}',
'{{ revisionsId }}',
'{{ timeout }}',
'{{ validity }}',
'{{ name }}',
'{{ count }}',
'{{ filter }}',
'{{ tracesize }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: timeout
      value: string
    - name: validity
      value: integer
    - name: name
      value: string
    - name: count
      value: integer
    - name: filter
      value: string
    - name: tracesize
      value: integer
    - name: createTime
      value: string