Documentation

Google_Service_Script_Resource_Processes extends Google_Service_Resource
in package

The "processes" collection of methods.

Typical usage is: $scriptService = new Google_Service_Script(...); $processes = $scriptService->processes;

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.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
listProcesses()  : Google_Service_Script_ListUserProcessesResponse
List information about processes made by or on behalf of a user, such as process type and current status. (processes.listProcesses)
listScriptProcesses()  : Google_Service_Script_ListScriptProcessesResponse
List information about a script's executed processes, such as process type and current status. (processes.listScriptProcesses)
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 —

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

listProcesses()

List information about processes made by or on behalf of a user, such as process type and current status. (processes.listProcesses)

public listProcesses([array<string|int, mixed> $optParams = array() ]) : Google_Service_Script_ListUserProcessesResponse
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string userProcessFilter.deploymentId Optional field used to limit returned processes to those originating from projects with a specific deployment ID.

opt_param

string userProcessFilter.endTime Optional field used to limit returned processes to those that completed on or before the given timestamp.

opt_param

int pageSize The maximum number of returned processes per page of results. Defaults to 50.

opt_param

string userProcessFilter.scriptId Optional field used to limit returned processes to those originating from projects with a specific script ID.

opt_param

string userProcessFilter.startTime Optional field used to limit returned processes to those that were started on or after the given timestamp.

opt_param

string userProcessFilter.userAccessLevels Optional field used to limit returned processes to those having one of the specified user access levels.

opt_param

string userProcessFilter.projectName Optional field used to limit returned processes to those originating from projects with project names containing a specific string.

opt_param

string pageToken The token for continuing a previous list request on the next page. This should be set to the value of nextPageToken from a previous response.

opt_param

string userProcessFilter.types Optional field used to limit returned processes to those having one of the specified process types.

opt_param

string userProcessFilter.statuses Optional field used to limit returned processes to those having one of the specified process statuses.

opt_param

string userProcessFilter.functionName Optional field used to limit returned processes to those originating from a script function with the given function name.

Return values
Google_Service_Script_ListUserProcessesResponse —

listScriptProcesses()

List information about a script's executed processes, such as process type and current status. (processes.listScriptProcesses)

public listScriptProcesses([array<string|int, mixed> $optParams = array() ]) : Google_Service_Script_ListScriptProcessesResponse
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string scriptProcessFilter.startTime Optional field used to limit returned processes to those that were started on or after the given timestamp.

opt_param

string scriptId The script ID of the project whose processes are listed.

opt_param

string scriptProcessFilter.statuses Optional field used to limit returned processes to those having one of the specified process statuses.

opt_param

string scriptProcessFilter.functionName Optional field used to limit returned processes to those originating from a script function with the given function name.

opt_param

string scriptProcessFilter.userAccessLevels Optional field used to limit returned processes to those having one of the specified user access levels.

opt_param

int pageSize The maximum number of returned processes per page of results. Defaults to 50.

opt_param

string pageToken The token for continuing a previous list request on the next page. This should be set to the value of nextPageToken from a previous response.

opt_param

string scriptProcessFilter.endTime Optional field used to limit returned processes to those that completed on or before the given timestamp.

opt_param

string scriptProcessFilter.types Optional field used to limit returned processes to those having one of the specified process types.

opt_param

string scriptProcessFilter.deploymentId Optional field used to limit returned processes to those originating from projects with a specific deployment ID.

Return values
Google_Service_Script_ListScriptProcessesResponse —

convertToArrayAndStripNulls()

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

Search results