class ProjectsHistoriesExecutionsStepsPerfSampleSeriesSamples extends Resource (View source)

The "samples" collection of methods.

Typical usage is:

 $toolresultsService = new Google\Service\ToolResults(...);
 $samples = $toolresultsService->projects_histories_executions_steps_perfSampleSeries_samples;

Methods

batchCreate(string $projectId, string $historyId, string $executionId, string $stepId, string $sampleSeriesId, BatchCreatePerfSamplesRequest $postBody, array $optParams = [])

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.

listProjectsHistoriesExecutionsStepsPerfSampleSeriesSamples(string $projectId, string $historyId, string $executionId, string $stepId, string $sampleSeriesId, array $optParams = [])

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)

Details

BatchCreatePerfSamplesResponse batchCreate(string $projectId, string $historyId, string $executionId, string $stepId, string $sampleSeriesId, BatchCreatePerfSamplesRequest $postBody, array $optParams = [])

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.

  • 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

string $projectId

The cloud project

string $historyId

A tool results history ID.

string $executionId

A tool results execution ID.

string $stepId

A tool results step ID.

string $sampleSeriesId

A sample series id

BatchCreatePerfSamplesRequest $postBody
array $optParams

Optional parameters.

Return Value

BatchCreatePerfSamplesResponse

Exceptions

Exception

ListPerfSamplesResponse listProjectsHistoriesExecutionsStepsPerfSampleSeriesSamples(string $projectId, string $historyId, string $executionId, string $stepId, string $sampleSeriesId, array $optParams = [])

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)

Parameters

string $projectId

The cloud project

string $historyId

A tool results history ID.

string $executionId

A tool results execution ID.

string $stepId

A tool results step ID.

string $sampleSeriesId

A sample series id

array $optParams

Optional parameters.

Return Value

ListPerfSamplesResponse

Exceptions

Exception