Documentation

Google_Service_ToolResults_Resource_ProjectsHistories extends Google_Service_Resource
in package

The "histories" collection of methods.

Typical usage is: $toolresultsService = new Google_Service_ToolResults(...); $histories = $toolresultsService->histories;

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_History
Creates a History. The returned History 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 project does not exist (histories.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_ToolResults_History
Gets a History. 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 History does not exist (histories.get)
listProjectsHistories()  : Google_Service_ToolResults_ListHistoriesResponse
Lists Histories for a given Project. The histories are sorted by modification time in descending order. The history_id key will be used to order the history with the same modification 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 History does not exist (histories.listProjectsHistories)
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 History. The returned History 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 project does not exist (histories.create)

public create(string $projectId, Google_Service_ToolResults_History $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ToolResults_History
Parameters
$projectId : string

A Project id. Required.

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

Optional parameters.

Tags
opt_param

string requestId A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended.

Return values
Google_Service_ToolResults_History —

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

get()

Gets a History. 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 History does not exist (histories.get)

public get(string $projectId, string $historyId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ToolResults_History
Parameters
$projectId : string

A Project id. Required.

$historyId : string

A History id. Required.

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

Optional parameters.

Return values
Google_Service_ToolResults_History —

listProjectsHistories()

Lists Histories for a given Project. The histories are sorted by modification time in descending order. The history_id key will be used to order the history with the same modification 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 History does not exist (histories.listProjectsHistories)

public listProjectsHistories(string $projectId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ToolResults_ListHistoriesResponse
Parameters
$projectId : string

A Project id. Required.

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

Optional parameters.

Tags
opt_param

string pageToken A continuation token to resume the query at the next item. Optional.

opt_param

int pageSize The maximum number of Histories to fetch. Default value: 20. The server will use this default if the field is not set or has a value of 0. Any value greater than 100 will be treated as 100. Optional.

opt_param

string filterByName If set, only return histories with the given name. Optional.

Return values
Google_Service_ToolResults_ListHistoriesResponse —

convertToArrayAndStripNulls()

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

Search results