Documentation

Google_Service_ToolResults_Resource_ProjectsHistoriesExecutionsSteps extends Google_Service_Resource
in package

Application

The "steps" collection of methods.

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

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
accessibilityClusters() : Google_Service_ToolResults_ListStepAccessibilityClustersResponse: 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)
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_ToolResults_Step: 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)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
get() : Google_Service_ToolResults_Step: 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() : Google_Service_ToolResults_PerfMetricsSummary: Retrieves a PerfMetricsSummary. May return any of the following error code(s): - NOT_FOUND - The specified PerfMetricsSummary does not exist (steps.getPerfMetricsSummary)
listProjectsHistoriesExecutionsSteps() : Google_Service_ToolResults_ListStepsResponse: 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() : Google_Service_ToolResults_Step: 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() : Google_Service_ToolResults_Step: 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)
convertToArrayAndStripNulls() : mixed

$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'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

accessibilityClusters()

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)


    public
                accessibilityClusters(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ToolResults_ListStepAccessibilityClustersResponse

Parameters

$name : string: A full resource name of the step. For example, projects /my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef Required.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ToolResults_ListStepAccessibilityClustersResponse —

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

Return values

Google_Http_Request|expectedClass —

create()

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)


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

Parameters

$projectId : string: Required. A Project id.
$historyId : string: Required. A History id.
$executionId : string: Required. An Execution id.
$postBody : Google_Service_ToolResults_Step
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ToolResults_Step —

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>

Return values

string —

$requestUrl

get()

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)


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

Parameters

$projectId : string: A Project id. Required.
$historyId : string: A History id. Required.
$executionId : string: A Execution id. Required.
$stepId : string: A Step id. Required.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ToolResults_Step —

getPerfMetricsSummary()

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


    public
                getPerfMetricsSummary(string $projectId, string $historyId, string $executionId, string $stepId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ToolResults_PerfMetricsSummary

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.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ToolResults_PerfMetricsSummary —

listProjectsHistoriesExecutionsSteps()

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)


    public
                listProjectsHistoriesExecutionsSteps(string $projectId, string $historyId, string $executionId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ToolResults_ListStepsResponse

Parameters

$projectId : string: A Project id. Required.
$historyId : string: A History id. Required.
$executionId : string: A Execution id. Required.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ToolResults_ListStepsResponse —

patch()

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)


    public
                patch(string $projectId, string $historyId, string $executionId, string $stepId, Google_Service_ToolResults_Step $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ToolResults_Step

Parameters

$projectId : string: A Project id. Required.
$historyId : string: A History id. Required.
$executionId : string: A Execution id. Required.
$stepId : string: A Step id. Required.
$postBody : Google_Service_ToolResults_Step
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ToolResults_Step —

publishXunitXmlFiles()

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)


    public
                publishXunitXmlFiles(string $projectId, string $historyId, string $executionId, string $stepId, Google_Service_ToolResults_PublishXunitXmlFilesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ToolResults_Step

Parameters

$projectId : string: A Project id. Required.
$historyId : string: A History id. Required.
$executionId : string: A Execution id. Required.
$stepId : string: A Step id. Note: This step must include a TestExecutionStep. Required.
$postBody : Google_Service_ToolResults_PublishXunitXmlFilesRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ToolResults_Step —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —