1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.environments.html">environments</a> . <a href="apigee_v1.organizations.environments.apis.html">apis</a> . <a href="apigee_v1.organizations.environments.apis.revisions.html">revisions</a> . <a href="apigee_v1.organizations.environments.apis.revisions.debugsessions.html">debugsessions</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="apigee_v1.organizations.environments.apis.revisions.debugsessions.data.html">data()</a></code> 79</p> 80<p class="firstline">Returns the data Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#create">create(parent, body=None, timeout=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Creates a debug session for a deployed API Proxy revision.</p> 88<p class="toc_element"> 89 <code><a href="#deleteData">deleteData(name, x__xgafv=None)</a></code></p> 90<p class="firstline">Deletes the data from a debug session. This does not cancel the debug session or prevent further data from being collected if the session is still active in runtime pods.</p> 91<p class="toc_element"> 92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 93<p class="firstline">Retrieves a debug session.</p> 94<p class="toc_element"> 95 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 96<p class="firstline">Lists debug sessions that are currently active in the given API Proxy revision.</p> 97<p class="toc_element"> 98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 99<p class="firstline">Retrieves the next page of results.</p> 100<h3>Method Details</h3> 101<div class="method"> 102 <code class="details" id="close">close()</code> 103 <pre>Close httplib2 connections.</pre> 104</div> 105 106<div class="method"> 107 <code class="details" id="create">create(parent, body=None, timeout=None, x__xgafv=None)</code> 108 <pre>Creates a debug session for a deployed API Proxy revision. 109 110Args: 111 parent: string, Required. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`. (required) 112 body: object, The request body. 113 The object takes the form of: 114 115{ 116 "count": 42, # Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10. 117 "filter": "A 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. 118 "name": "A String", # A unique ID for this DebugSession. 119 "timeout": "A 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. 120 "tracesize": 42, # Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120. 121 "validity": 42, # 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. 122} 123 124 timeout: string, Optional. The time in seconds after which this DebugSession should end. A timeout specified in DebugSession will overwrite this value. 125 x__xgafv: string, V1 error format. 126 Allowed values 127 1 - v1 error format 128 2 - v2 error format 129 130Returns: 131 An object of the form: 132 133 { 134 "count": 42, # Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10. 135 "filter": "A 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. 136 "name": "A String", # A unique ID for this DebugSession. 137 "timeout": "A 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. 138 "tracesize": 42, # Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120. 139 "validity": 42, # 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. 140}</pre> 141</div> 142 143<div class="method"> 144 <code class="details" id="deleteData">deleteData(name, x__xgafv=None)</code> 145 <pre>Deletes the data from a debug session. This does not cancel the debug session or prevent further data from being collected if the session is still active in runtime pods. 146 147Args: 148 name: string, Required. The name of the debug session to delete. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`. (required) 149 x__xgafv: string, V1 error format. 150 Allowed values 151 1 - v1 error format 152 2 - v2 error format 153 154Returns: 155 An object of the form: 156 157 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 158}</pre> 159</div> 160 161<div class="method"> 162 <code class="details" id="get">get(name, x__xgafv=None)</code> 163 <pre>Retrieves a debug session. 164 165Args: 166 name: string, Required. The name of the debug session to retrieve. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}`. (required) 167 x__xgafv: string, V1 error format. 168 Allowed values 169 1 - v1 error format 170 2 - v2 error format 171 172Returns: 173 An object of the form: 174 175 { 176 "count": 42, # Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10. 177 "filter": "A 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. 178 "name": "A String", # A unique ID for this DebugSession. 179 "timeout": "A 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. 180 "tracesize": 42, # Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120. 181 "validity": 42, # 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. 182}</pre> 183</div> 184 185<div class="method"> 186 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 187 <pre>Lists debug sessions that are currently active in the given API Proxy revision. 188 189Args: 190 parent: string, Required. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`. (required) 191 pageSize: integer, Maximum number of debug sessions to return. The page size defaults to 25. 192 pageToken: string, Page token, returned from a previous ListDebugSessions call, that you can use to retrieve the next page. 193 x__xgafv: string, V1 error format. 194 Allowed values 195 1 - v1 error format 196 2 - v2 error format 197 198Returns: 199 An object of the form: 200 201 { 202 "nextPageToken": "A String", # Page token that you can include in a ListDebugSessionsRequest to retrieve the next page. If omitted, no subsequent pages exist. 203 "sessions": [ # Session info that includes debug session ID and the first transaction creation timestamp. 204 { # Session carries the debug session id and its creation time. 205 "id": "A String", # The debug session ID. 206 "timestampMs": "A String", # The first transaction creation timestamp in millisecond, recoreded by UAP. 207 }, 208 ], 209}</pre> 210</div> 211 212<div class="method"> 213 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 214 <pre>Retrieves the next page of results. 215 216Args: 217 previous_request: The request for the previous page. (required) 218 previous_response: The response from the request for the previous page. (required) 219 220Returns: 221 A request object that you can call 'execute()' on to request the next 222 page. Returns None if there are no more items in the collection. 223 </pre> 224</div> 225 226</body></html>