Documentation

Google_Service_Workflows_Resource_ProjectsLocationsWorkflows extends Google_Service_Resource
in package

Application

The "workflows" collection of methods.

Typical usage is: $workflowsService = new Google_Service_Workflows(...); $workflows = $workflowsService->workflows;

$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.
create() : Google_Service_Workflows_Operation: Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation will return ALREADY_EXISTS error. (workflows.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Workflows_Operation: Deletes a workflow with the specified name. This method also cancels and deletes all running executions of the workflow. (workflows.delete)
get() : Google_Service_Workflows_Workflow: Gets details of a single Workflow. (workflows.get)
listProjectsLocationsWorkflows() : Google_Service_Workflows_ListWorkflowsResponse: Lists Workflows in a given project and location. The default order is not specified. (workflows.listProjectsLocationsWorkflows)
patch() : Google_Service_Workflows_Operation: Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow may be created as a result of a successful update operation. In that case, such revision will be used in new workflow executions. (workflows.patch)
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 —

create()

Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation will return ALREADY_EXISTS error. (workflows.create)


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

Parameters

$parent : string: Required. Project and location in which the workflow should be created. Format: projects/{project}/locations/{location}
$postBody : Google_Service_Workflows_Workflow
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Workflows_Operation —

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

delete()

Deletes a workflow with the specified name. This method also cancels and deletes all running executions of the workflow. (workflows.delete)


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

Parameters

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

Return values

Google_Service_Workflows_Operation —

get()

Gets details of a single Workflow. (workflows.get)


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

Parameters

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

Return values

Google_Service_Workflows_Workflow —

listProjectsLocationsWorkflows()

Lists Workflows in a given project and location. The default order is not specified. (workflows.listProjectsLocationsWorkflows)


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

Parameters

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

Return values

Google_Service_Workflows_ListWorkflowsResponse —

patch()

Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow may be created as a result of a successful update operation. In that case, such revision will be used in new workflow executions. (workflows.patch)


    public
                patch(string $name, Google_Service_Workflows_Workflow $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Workflows_Operation

Parameters

$name : string: The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}
$postBody : Google_Service_Workflows_Workflow
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Workflows_Operation —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —