Google_Service_ToolResults_Resource_ProjectsHistoriesExecutions
extends Google_Service_Resource
in package
The "executions" collection of methods.
Typical usage is:
$toolresultsService = new Google_Service_ToolResults(...);
$executions = $toolresultsService->executions;
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_ToolResults_Execution
- Creates an Execution. The returned Execution will have the id set. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist (executions.create)
- createRequestUri() : string
- Parse/expand request parameters and create a fully qualified request uri.
- get() : Google_Service_ToolResults_Execution
- Gets an Execution. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Execution does not exist (executions.get)
- listProjectsHistoriesExecutions() : Google_Service_ToolResults_ListExecutionsResponse
- Lists Executions for a given History. The executions are sorted by creation_time in descending order. The execution_id key will be used to order the executions with the same creation_time. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist (executions.listProjectsHistoriesExecutions)
- patch() : Google_Service_ToolResults_Execution
- Updates an existing Execution with the supplied partial entity. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal - NOT_FOUND - if the containing History does not exist (executions.patch)
- convertToArrayAndStripNulls() : mixed
Properties
$client
private
Google_Client
$client
$methods
private
array<string|int, mixed>
$methods
$resourceName
private
string
$resourceName
$rootUrl
private
string
$rootUrl
$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
Tags
Return values
Google_Http_Request|expectedClass —create()
Creates an Execution. The returned Execution will have the id set. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist (executions.create)
public
create(string $projectId, string $historyId, Google_Service_ToolResults_Execution $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ToolResults_Execution
Parameters
- $projectId : string
-
A Project id. Required.
- $historyId : string
-
A History id. Required.
- $postBody : Google_Service_ToolResults_Execution
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Tags
Return values
Google_Service_ToolResults_Execution —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
Return values
string —$requestUrl
get()
Gets an Execution. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Execution does not exist (executions.get)
public
get(string $projectId, string $historyId, string $executionId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ToolResults_Execution
Parameters
- $projectId : string
-
A Project id. Required.
- $historyId : string
-
A History id. Required.
- $executionId : string
-
An Execution id. Required.
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Return values
Google_Service_ToolResults_Execution —listProjectsHistoriesExecutions()
Lists Executions for a given History. The executions are sorted by creation_time in descending order. The execution_id key will be used to order the executions with the same creation_time. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist (executions.listProjectsHistoriesExecutions)
public
listProjectsHistoriesExecutions(string $projectId, string $historyId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ToolResults_ListExecutionsResponse
Parameters
- $projectId : string
-
A Project id. Required.
- $historyId : string
-
A History id. Required.
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Tags
Return values
Google_Service_ToolResults_ListExecutionsResponse —patch()
Updates an existing Execution with the supplied partial entity. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal - NOT_FOUND - if the containing History does not exist (executions.patch)
public
patch(string $projectId, string $historyId, string $executionId, Google_Service_ToolResults_Execution $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ToolResults_Execution
Parameters
- $projectId : string
-
A Project id. Required.
- $historyId : string
-
Required.
- $executionId : string
-
Required.
- $postBody : Google_Service_ToolResults_Execution
- $optParams : array<string|int, mixed> = array()
-
Optional parameters.
Tags
Return values
Google_Service_ToolResults_Execution —convertToArrayAndStripNulls()
protected
convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
- $o : mixed