class ProjectsHistoriesExecutionsSteps extends Resource (View source)

The "steps" collection of methods.

Typical usage is:

 $toolresultsService = new Google\Service\ToolResults(...);
 $steps = $toolresultsService->projects_histories_executions_steps;

Methods

accessibilityClusters(string $name, array $optParams = [])

Lists accessibility clusters for a given Step 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 - FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g. if the locale format is incorrect - NOT_FOUND - if the containing Step does not exist (steps.accessibilityClusters)

create(string $projectId, string $historyId, string $executionId, Step $postBody, array $optParams = [])

Creates a Step. The returned Step 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 - FAILED_PRECONDITION - if the step is too large (more than 10Mib)

  • NOT_FOUND - if the containing Execution does not exist (steps.create)

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

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

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

Retrieves a PerfMetricsSummary. May return any of the following error code(s): - NOT_FOUND - The specified PerfMetricsSummary does not exist (steps.getPerfMetricsSummary)

listProjectsHistoriesExecutionsSteps(string $projectId, string $historyId, string $executionId, array $optParams = [])

Lists Steps for a given Execution. The steps are sorted by creation_time in descending order. The step_id key will be used to order the steps 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 - FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g. if an attempt is made to list the children of a nonexistent Step - NOT_FOUND - if the containing Execution does not exist (steps.listProjectsHistoriesExecutionsSteps)

patch(string $projectId, string $historyId, string $executionId, string $stepId, Step $postBody, array $optParams = [])

Updates an existing Step with the supplied partial entity. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed

  • FAILED_PRECONDITION - if the requested state transition is illegal (e.g try to upload a duplicate xml file), if the updated step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist (steps.patch)

publishXunitXmlFiles(string $projectId, string $historyId, string $executionId, string $stepId, PublishXunitXmlFilesRequest $postBody, array $optParams = [])

Publish xml files to an existing Step. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal, e.g. try to upload a duplicate xml file or a file too large. - NOT_FOUND - if the containing Execution does not exist (steps.publishXunitXmlFiles)

Details

ListStepAccessibilityClustersResponse accessibilityClusters(string $name, array $optParams = [])

Lists accessibility clusters for a given Step 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 - FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g. if the locale format is incorrect - NOT_FOUND - if the containing Step does not exist (steps.accessibilityClusters)

Parameters

string $name

A full resource name of the step. For example, projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef Required.

array $optParams

Optional parameters.

Return Value

ListStepAccessibilityClustersResponse

Exceptions

Exception

Step create(string $projectId, string $historyId, string $executionId, Step $postBody, array $optParams = [])

Creates a Step. The returned Step 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 - FAILED_PRECONDITION - if the step is too large (more than 10Mib)

  • NOT_FOUND - if the containing Execution does not exist (steps.create)

Parameters

string $projectId

Required. A Project id.

string $historyId

Required. A History id.

string $executionId

Required. An Execution id.

Step $postBody
array $optParams

Optional parameters.

Return Value

Step

Exceptions

Exception

Step get(string $projectId, string $historyId, string $executionId, string $stepId, array $optParams = [])

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

Parameters

string $projectId

A Project id. Required.

string $historyId

A History id. Required.

string $executionId

A Execution id. Required.

string $stepId

A Step id. Required.

array $optParams

Optional parameters.

Return Value

Step

Exceptions

Exception

PerfMetricsSummary getPerfMetricsSummary(string $projectId, string $historyId, string $executionId, string $stepId, array $optParams = [])

Retrieves a PerfMetricsSummary. May return any of the following error code(s): - NOT_FOUND - The specified PerfMetricsSummary does not exist (steps.getPerfMetricsSummary)

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.

array $optParams

Optional parameters.

Return Value

PerfMetricsSummary

Exceptions

Exception

ListStepsResponse listProjectsHistoriesExecutionsSteps(string $projectId, string $historyId, string $executionId, array $optParams = [])

Lists Steps for a given Execution. The steps are sorted by creation_time in descending order. The step_id key will be used to order the steps 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 - FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g. if an attempt is made to list the children of a nonexistent Step - NOT_FOUND - if the containing Execution does not exist (steps.listProjectsHistoriesExecutionsSteps)

Parameters

string $projectId

A Project id. Required.

string $historyId

A History id. Required.

string $executionId

A Execution id. Required.

array $optParams

Optional parameters.

Return Value

ListStepsResponse

Exceptions

Exception

Step patch(string $projectId, string $historyId, string $executionId, string $stepId, Step $postBody, array $optParams = [])

Updates an existing Step with the supplied partial entity. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed

  • FAILED_PRECONDITION - if the requested state transition is illegal (e.g try to upload a duplicate xml file), if the updated step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist (steps.patch)

Parameters

string $projectId

A Project id. Required.

string $historyId

A History id. Required.

string $executionId

A Execution id. Required.

string $stepId

A Step id. Required.

Step $postBody
array $optParams

Optional parameters.

Return Value

Step

Exceptions

Exception

Step publishXunitXmlFiles(string $projectId, string $historyId, string $executionId, string $stepId, PublishXunitXmlFilesRequest $postBody, array $optParams = [])

Publish xml files to an existing Step. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal, e.g. try to upload a duplicate xml file or a file too large. - NOT_FOUND - if the containing Execution does not exist (steps.publishXunitXmlFiles)

Parameters

string $projectId

A Project id. Required.

string $historyId

A History id. Required.

string $executionId

A Execution id. Required.

string $stepId

A Step id. Note: This step must include a TestExecutionStep. Required.

PublishXunitXmlFilesRequest $postBody
array $optParams

Optional parameters.

Return Value

Step

Exceptions

Exception