Documentation

Google_Service_Apigee_Resource_OrganizationsEnvironmentsApisRevisionsDebugsessions extends Google_Service_Resource
in package

The "debugsessions" collection of methods.

Typical usage is: $apigeeService = new Google_Service_Apigee(...); $debugsessions = $apigeeService->debugsessions;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_Apigee_GoogleCloudApigeeV1DebugSession
Creates a debug session for a deployed API Proxy revision.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
deleteData()  : Google_Service_Apigee_GoogleProtobufEmpty
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. (debugsessions.deleteData)
get()  : Google_Service_Apigee_GoogleCloudApigeeV1DebugSession
Retrieves a debug session. (debugsessions.get)
listOrganizationsEnvironmentsApisRevisionsDebugsessions()  : Google_Service_Apigee_GoogleCloudApigeeV1ListDebugSessionsResponse
Lists debug sessions that are currently active in the given API Proxy revision.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

create()

Creates a debug session for a deployed API Proxy revision.

public create(string $parent, Google_Service_Apigee_GoogleCloudApigeeV1DebugSession $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1DebugSession

(debugsessions.create)

Parameters
$parent : string

Required. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form organiz ations/{organization}/environments/{environment}/apis/{api}/revisions/{revisi on}.

$postBody : Google_Service_Apigee_GoogleCloudApigeeV1DebugSession
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string timeout Optional. The time in seconds after which this DebugSession should end. A timeout specified in DebugSession will overwrite this value.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1DebugSession

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

deleteData()

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. (debugsessions.deleteData)

public deleteData(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleProtobufEmpty
Parameters
$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}.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Apigee_GoogleProtobufEmpty

get()

Retrieves a debug session. (debugsessions.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1DebugSession
Parameters
$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}.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1DebugSession

listOrganizationsEnvironmentsApisRevisionsDebugsessions()

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

public listOrganizationsEnvironmentsApisRevisionsDebugsessions(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Apigee_GoogleCloudApigeeV1ListDebugSessionsResponse

(debugsessions.listOrganizationsEnvironmentsApisRevisionsDebugsessions)

Parameters
$parent : string

Required. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: organizations/{organi zation}/environments/{environment}/apis/{api}/revisions/{revision}.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int pageSize Maximum number of debug sessions to return. The page size defaults to 25.

opt_param

string pageToken Page token, returned from a previous ListDebugSessions call, that you can use to retrieve the next page.

Return values
Google_Service_Apigee_GoogleCloudApigeeV1ListDebugSessionsResponse

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results