blob: 68a708ca83459ad3f9258eee1dbb055b56b34325 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\TaskProcessing;
/**
* This is the interface that is implemented by apps that
* implement a task processing provider
* @since 30.0.0
*/
interface IProvider {
/**
* The unique id of this provider
* @since 30.0.0
*/
public function getId(): string;
/**
* The localized name of this provider
* @since 30.0.0
*/
public function getName(): string;
/**
* Returns the task type id of the task type, that this
* provider handles
*
* @since 30.0.0
* @return string
*/
public function getTaskTypeId(): string;
/**
* @return int The expected average runtime of a task in seconds
* @since 30.0.0
*/
public function getExpectedRuntime(): int;
/**
* Returns the shape of optional input parameters
*
* @since 30.0.0
* @psalm-return ShapeDescriptor[]
*/
public function getOptionalInputShape(): array;
/**
* Returns the shape of optional output parameters
*
* @since 30.0.0
* @psalm-return ShapeDescriptor[]
*/
public function getOptionalOutputShape(): array;
}
|
