Documentation

Google_Service_WorkflowExecutions_Resource_ProjectsLocationsWorkflowsExecutions extends Google_Service_Resource
in package

Application

The "executions" collection of methods.

Typical usage is: $workflowexecutionsService = new Google_Service_WorkflowExecutions(...); $executions = $workflowexecutionsService->executions;

$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.
cancel() : Google_Service_WorkflowExecutions_Execution: Cancels an execution of the given name. (executions.cancel)
create() : Google_Service_WorkflowExecutions_Execution: Creates a new execution using the latest revision of the given workflow.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
get() : Google_Service_WorkflowExecutions_Execution: Returns an execution of the given name. (executions.get)
listProjectsLocationsWorkflowsExecutions() : Google_Service_WorkflowExecutions_ListExecutionsResponse: Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first).
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 —

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 —

cancel()

Cancels an execution of the given name. (executions.cancel)


    public
                cancel(string $name, Google_Service_WorkflowExecutions_CancelExecutionRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_WorkflowExecutions_Execution

Parameters

$name : string: Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{exec ution}
$postBody : Google_Service_WorkflowExecutions_CancelExecutionRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_WorkflowExecutions_Execution —

create()

Creates a new execution using the latest revision of the given workflow.


    public
                create(string $parent, Google_Service_WorkflowExecutions_Execution $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_WorkflowExecutions_Execution

(executions.create)

Parameters

$parent : string: Required. Name of the workflow for which an execution should be created. Format: projects/{project}/locations/{location}/workflows/{workflow} The latest revision of the workflow will be used.
$postBody : Google_Service_WorkflowExecutions_Execution
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_WorkflowExecutions_Execution —

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()

Returns an execution of the given name. (executions.get)


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

Parameters

$name : string: Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{exec ution}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_WorkflowExecutions_Execution —

listProjectsLocationsWorkflowsExecutions()

Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first).


    public
                listProjectsLocationsWorkflowsExecutions(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_WorkflowExecutions_ListExecutionsResponse

(executions.listProjectsLocationsWorkflowsExecutions)

Parameters

$parent : string: Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_WorkflowExecutions_ListExecutionsResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —