* $workflowsService = new Google\Service\Workflows(...); * $workflows = $workflowsService->workflows; * */ class ProjectsLocationsWorkflows extends \Google\Service\Resource { /** * 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) * * @param string $parent Required. Project and location in which the workflow * should be created. Format: projects/{project}/locations/{location} * @param Workflow $postBody * @param array $optParams Optional parameters. * * @opt_param string workflowId Required. The ID of the workflow to be created. * It has to fulfill the following requirements: * Must contain only letters, * numbers, underscores and hyphens. * Must start with a letter. * Must be * between 1-64 characters. * Must end with a number or a letter. * Must be * unique within the customer project and location. * @return Operation */ public function create($parent, Workflow $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], Operation::class); } /** * Deletes a workflow with the specified name. This method also cancels and * deletes all running executions of the workflow. (workflows.delete) * * @param string $name Required. Name of the workflow to be deleted. Format: * projects/{project}/locations/{location}/workflows/{workflow} * @param array $optParams Optional parameters. * @return Operation */ public function delete($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('delete', [$params], Operation::class); } /** * Gets details of a single Workflow. (workflows.get) * * @param string $name Required. Name of the workflow which information should * be retrieved. Format: * projects/{project}/locations/{location}/workflows/{workflow} * @param array $optParams Optional parameters. * @return Workflow */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], Workflow::class); } /** * Lists Workflows in a given project and location. The default order is not * specified. (workflows.listProjectsLocationsWorkflows) * * @param string $parent Required. Project and location from which the workflows * should be listed. Format: projects/{project}/locations/{location} * @param array $optParams Optional parameters. * * @opt_param string filter Filter to restrict results to specific workflows. * @opt_param string orderBy Comma-separated list of fields that that specify * the order of the results. Default sorting order for a field is ascending. To * specify descending order for a field, append a " desc" suffix. If not * specified, the results will be returned in an unspecified order. * @opt_param int pageSize Maximum number of workflows to return per call. The * service may return fewer than this value. If the value is not specified, a * default value of 500 will be used. The maximum permitted value is 1000 and * values greater than 1000 will be coerced down to 1000. * @opt_param string pageToken A page token, received from a previous * `ListWorkflows` call. Provide this to retrieve the subsequent page. When * paginating, all other parameters provided to `ListWorkflows` must match the * call that provided the page token. * @return ListWorkflowsResponse */ public function listProjectsLocationsWorkflows($parent, $optParams = []) { $params = ['parent' => $parent]; $params = array_merge($params, $optParams); return $this->call('list', [$params], ListWorkflowsResponse::class); } /** * 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) * * @param string $name The resource name of the workflow. Format: * projects/{project}/locations/{location}/workflows/{workflow} * @param Workflow $postBody * @param array $optParams Optional parameters. * * @opt_param string updateMask List of fields to be updated. If not present, * the entire workflow will be updated. * @return Operation */ public function patch($name, Workflow $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('patch', [$params], Operation::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(ProjectsLocationsWorkflows::class, 'Google_Service_Workflows_Resource_ProjectsLocationsWorkflows');