Apigee API . organizations . apis . debugsessions

Instance Methods

close()

Close httplib2 connections.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

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

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists debug sessions that are currently active in the given API Proxy.

Args:
  parent: string, Required. The name of the API Proxy for which to list debug sessions. Must be of the form: `organizations/{organization}/apis/{api}`. (required)
  pageSize: integer, Optional. Maximum number of debug sessions to return. The page size defaults to 25.
  pageToken: string, Optional. Page token, returned from a previous ListApiDebugSessions call, that you can use to retrieve the next page.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListApiDebugSessions.
  "nextPageToken": "A String", # Page token that you can include in a ListApiDebugSessionsRequest to retrieve the next page. If omitted, no subsequent pages exist.
  "sessions": [ # Session info that includes debug session ID, environment ID, api proxy revision ID and the first transaction creation timestamp.
    { # Session carries the debug session id and its creation time.
      "apiProxyRevisionId": "A String", # The revision ID of the deployed API proxy.
      "createTime": "A String", # The first transaction creation timestamp in millisecond, recorded by UAP.
      "environmentId": "A String", # The environment ID of the deployed API proxy.
      "id": "A String", # The debug session ID.
    },
  ],
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.