Documentation

Google_Service_ToolResults_Resource_ProjectsHistoriesExecutionsStepsPerfSampleSeriesSamples extends Google_Service_Resource
in package

The "samples" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
batchCreate()  : Google_Service_ToolResults_BatchCreatePerfSamplesResponse
Creates a batch of PerfSamples - a client can submit multiple batches of Perf Samples through repeated calls to this method in order to split up a large request payload - duplicates and existing timestamp entries will be ignored.
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
listProjectsHistoriesExecutionsStepsPerfSampleSeriesSamples()  : Google_Service_ToolResults_ListPerfSamplesResponse
Lists the Performance Samples of a given Sample Series - The list results are sorted by timestamps ascending - The default page size is 500 samples; and maximum size allowed 5000 - The response token indicates the last returned PerfSample timestamp - When the results size exceeds the page size, submit a subsequent request including the page token to return the rest of the samples up to the page limit May return any of the following canonical error codes: - OUT_OF_RANGE - The specified request page_token is out of valid range - NOT_FOUND - The containing PerfSampleSeries does not exist (samples.listProjectsHistoriesExecutionsStepsPerfSampleSeriesSamples)
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 —

batchCreate()

Creates a batch of PerfSamples - a client can submit multiple batches of Perf Samples through repeated calls to this method in order to split up a large request payload - duplicates and existing timestamp entries will be ignored.

public batchCreate(string $projectId, string $historyId, string $executionId, string $stepId, string $sampleSeriesId, Google_Service_ToolResults_BatchCreatePerfSamplesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ToolResults_BatchCreatePerfSamplesResponse
  • the batch operation may partially succeed - the set of elements successfully inserted is returned in the response (omits items which already existed in the database). May return any of the following canonical error codes: - NOT_FOUND - The containing PerfSampleSeries does not exist (samples.batchCreate)
Parameters
$projectId : string

The cloud project

$historyId : string

A tool results history ID.

$executionId : string

A tool results execution ID.

$stepId : string

A tool results step ID.

$sampleSeriesId : string

A sample series id

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

Optional parameters.

Return values
Google_Service_ToolResults_BatchCreatePerfSamplesResponse —

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

listProjectsHistoriesExecutionsStepsPerfSampleSeriesSamples()

Lists the Performance Samples of a given Sample Series - The list results are sorted by timestamps ascending - The default page size is 500 samples; and maximum size allowed 5000 - The response token indicates the last returned PerfSample timestamp - When the results size exceeds the page size, submit a subsequent request including the page token to return the rest of the samples up to the page limit May return any of the following canonical error codes: - OUT_OF_RANGE - The specified request page_token is out of valid range - NOT_FOUND - The containing PerfSampleSeries does not exist (samples.listProjectsHistoriesExecutionsStepsPerfSampleSeriesSamples)

public listProjectsHistoriesExecutionsStepsPerfSampleSeriesSamples(string $projectId, string $historyId, string $executionId, string $stepId, string $sampleSeriesId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ToolResults_ListPerfSamplesResponse
Parameters
$projectId : string

The cloud project

$historyId : string

A tool results history ID.

$executionId : string

A tool results execution ID.

$stepId : string

A tool results step ID.

$sampleSeriesId : string

A sample series id

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

Optional parameters.

Tags
opt_param

int pageSize The default page size is 500 samples, and the maximum size is 5000. If the page_size is greater than 5000, the effective page size will be 5000

opt_param

string pageToken Optional, the next_page_token returned in the previous response

Return values
Google_Service_ToolResults_ListPerfSamplesResponse —

convertToArrayAndStripNulls()

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

Search results