InfluxDB PHP Client
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
InfluxDB2\Service\TasksService Class Reference

Public Member Functions

 __construct (DefaultApi $defaultApi)
 
 deleteTasksID ($task_id, $zap_trace_span=null)
 
 deleteTasksIDWithHttpInfo ($task_id, $zap_trace_span=null)
 
 deleteTasksIDLabelsID ($task_id, $label_id, $zap_trace_span=null)
 
 deleteTasksIDLabelsIDWithHttpInfo ($task_id, $label_id, $zap_trace_span=null)
 
 deleteTasksIDMembersID ($user_id, $task_id, $zap_trace_span=null)
 
 deleteTasksIDMembersIDWithHttpInfo ($user_id, $task_id, $zap_trace_span=null)
 
 deleteTasksIDOwnersID ($user_id, $task_id, $zap_trace_span=null)
 
 deleteTasksIDOwnersIDWithHttpInfo ($user_id, $task_id, $zap_trace_span=null)
 
 deleteTasksIDRunsID ($task_id, $run_id, $zap_trace_span=null)
 
 deleteTasksIDRunsIDWithHttpInfo ($task_id, $run_id, $zap_trace_span=null)
 
 getTasks ($zap_trace_span=null, $name=null, $after=null, $user=null, $org=null, $org_id=null, $status=null, $limit=100, $type=null)
 
 getTasksWithHttpInfo ($zap_trace_span=null, $name=null, $after=null, $user=null, $org=null, $org_id=null, $status=null, $limit=100, $type=null)
 
 getTasksID ($task_id, $zap_trace_span=null)
 
 getTasksIDWithHttpInfo ($task_id, $zap_trace_span=null)
 
 getTasksIDLabels ($task_id, $zap_trace_span=null)
 
 getTasksIDLabelsWithHttpInfo ($task_id, $zap_trace_span=null)
 
 getTasksIDLogs ($task_id, $zap_trace_span=null)
 
 getTasksIDLogsWithHttpInfo ($task_id, $zap_trace_span=null)
 
 getTasksIDMembers ($task_id, $zap_trace_span=null)
 
 getTasksIDMembersWithHttpInfo ($task_id, $zap_trace_span=null)
 
 getTasksIDOwners ($task_id, $zap_trace_span=null)
 
 getTasksIDOwnersWithHttpInfo ($task_id, $zap_trace_span=null)
 
 getTasksIDRuns ($task_id, $zap_trace_span=null, $after=null, $limit=100, $after_time=null, $before_time=null)
 
 getTasksIDRunsWithHttpInfo ($task_id, $zap_trace_span=null, $after=null, $limit=100, $after_time=null, $before_time=null)
 
 getTasksIDRunsID ($task_id, $run_id, $zap_trace_span=null)
 
 getTasksIDRunsIDWithHttpInfo ($task_id, $run_id, $zap_trace_span=null)
 
 getTasksIDRunsIDLogs ($task_id, $run_id, $zap_trace_span=null)
 
 getTasksIDRunsIDLogsWithHttpInfo ($task_id, $run_id, $zap_trace_span=null)
 
 patchTasksID ($task_id, $task_update_request, $zap_trace_span=null)
 
 patchTasksIDWithHttpInfo ($task_id, $task_update_request, $zap_trace_span=null)
 
 postTasks ($task_create_request, $zap_trace_span=null)
 
 postTasksWithHttpInfo ($task_create_request, $zap_trace_span=null)
 
 postTasksIDLabels ($task_id, $label_mapping, $zap_trace_span=null)
 
 postTasksIDLabelsWithHttpInfo ($task_id, $label_mapping, $zap_trace_span=null)
 
 postTasksIDMembers ($task_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postTasksIDMembersWithHttpInfo ($task_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postTasksIDOwners ($task_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postTasksIDOwnersWithHttpInfo ($task_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postTasksIDRuns ($task_id, $zap_trace_span=null, $run_manually=null)
 
 postTasksIDRunsWithHttpInfo ($task_id, $zap_trace_span=null, $run_manually=null)
 
 postTasksIDRunsIDRetry ($task_id, $run_id, $zap_trace_span=null, $body=null)
 
 postTasksIDRunsIDRetryWithHttpInfo ($task_id, $run_id, $zap_trace_span=null, $body=null)
 

Protected Member Functions

 deleteTasksIDRequest ($task_id, $zap_trace_span=null)
 
 deleteTasksIDLabelsIDRequest ($task_id, $label_id, $zap_trace_span=null)
 
 deleteTasksIDMembersIDRequest ($user_id, $task_id, $zap_trace_span=null)
 
 deleteTasksIDOwnersIDRequest ($user_id, $task_id, $zap_trace_span=null)
 
 deleteTasksIDRunsIDRequest ($task_id, $run_id, $zap_trace_span=null)
 
 getTasksRequest ($zap_trace_span=null, $name=null, $after=null, $user=null, $org=null, $org_id=null, $status=null, $limit=100, $type=null)
 
 getTasksIDRequest ($task_id, $zap_trace_span=null)
 
 getTasksIDLabelsRequest ($task_id, $zap_trace_span=null)
 
 getTasksIDLogsRequest ($task_id, $zap_trace_span=null)
 
 getTasksIDMembersRequest ($task_id, $zap_trace_span=null)
 
 getTasksIDOwnersRequest ($task_id, $zap_trace_span=null)
 
 getTasksIDRunsRequest ($task_id, $zap_trace_span=null, $after=null, $limit=100, $after_time=null, $before_time=null)
 
 getTasksIDRunsIDRequest ($task_id, $run_id, $zap_trace_span=null)
 
 getTasksIDRunsIDLogsRequest ($task_id, $run_id, $zap_trace_span=null)
 
 patchTasksIDRequest ($task_id, $task_update_request, $zap_trace_span=null)
 
 postTasksRequest ($task_create_request, $zap_trace_span=null)
 
 postTasksIDLabelsRequest ($task_id, $label_mapping, $zap_trace_span=null)
 
 postTasksIDMembersRequest ($task_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postTasksIDOwnersRequest ($task_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postTasksIDRunsRequest ($task_id, $zap_trace_span=null, $run_manually=null)
 
 postTasksIDRunsIDRetryRequest ($task_id, $run_id, $zap_trace_span=null, $body=null)
 

Protected Attributes

 $defaultApi
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\TasksService::__construct ( DefaultApi $defaultApi)
Parameters
DefaultApi$defaultApi
HeaderSelector$selector

Member Function Documentation

◆ deleteTasksID()

InfluxDB2\Service\TasksService::deleteTasksID ( $task_id,
$zap_trace_span = null )

Operation deleteTasksID

Delete a task

Parameters
string$task_idThe ID of the task to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteTasksIDLabelsID()

InfluxDB2\Service\TasksService::deleteTasksIDLabelsID ( $task_id,
$label_id,
$zap_trace_span = null )

Operation deleteTasksIDLabelsID

Delete a label from a task

Parameters
string$task_idThe ID of the task to delete the label from. (required)
string$label_idThe ID of the label to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteTasksIDLabelsIDRequest()

InfluxDB2\Service\TasksService::deleteTasksIDLabelsIDRequest ( $task_id,
$label_id,
$zap_trace_span = null )
protected

Create request for operation 'deleteTasksIDLabelsID'

Parameters
string$task_idThe ID of the task to delete the label from. (required)
string$label_idThe ID of the label to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteTasksIDLabelsIDWithHttpInfo()

InfluxDB2\Service\TasksService::deleteTasksIDLabelsIDWithHttpInfo ( $task_id,
$label_id,
$zap_trace_span = null )

Operation deleteTasksIDLabelsIDWithHttpInfo

Delete a label from a task

Parameters
string$task_idThe ID of the task to delete the label from. (required)
string$label_idThe ID of the label to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of null, HTTP status code, HTTP response headers (array of strings)

◆ deleteTasksIDMembersID()

InfluxDB2\Service\TasksService::deleteTasksIDMembersID ( $user_id,
$task_id,
$zap_trace_span = null )

Operation deleteTasksIDMembersID

Remove a member from a task

Parameters
string$user_idThe ID of the member to remove. (required)
string$task_idThe task ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteTasksIDMembersIDRequest()

InfluxDB2\Service\TasksService::deleteTasksIDMembersIDRequest ( $user_id,
$task_id,
$zap_trace_span = null )
protected

Create request for operation 'deleteTasksIDMembersID'

Parameters
string$user_idThe ID of the member to remove. (required)
string$task_idThe task ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteTasksIDMembersIDWithHttpInfo()

InfluxDB2\Service\TasksService::deleteTasksIDMembersIDWithHttpInfo ( $user_id,
$task_id,
$zap_trace_span = null )

Operation deleteTasksIDMembersIDWithHttpInfo

Remove a member from a task

Parameters
string$user_idThe ID of the member to remove. (required)
string$task_idThe task ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of null, HTTP status code, HTTP response headers (array of strings)

◆ deleteTasksIDOwnersID()

InfluxDB2\Service\TasksService::deleteTasksIDOwnersID ( $user_id,
$task_id,
$zap_trace_span = null )

Operation deleteTasksIDOwnersID

Remove an owner from a task

Parameters
string$user_idThe ID of the owner to remove. (required)
string$task_idThe task ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteTasksIDOwnersIDRequest()

InfluxDB2\Service\TasksService::deleteTasksIDOwnersIDRequest ( $user_id,
$task_id,
$zap_trace_span = null )
protected

Create request for operation 'deleteTasksIDOwnersID'

Parameters
string$user_idThe ID of the owner to remove. (required)
string$task_idThe task ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteTasksIDOwnersIDWithHttpInfo()

InfluxDB2\Service\TasksService::deleteTasksIDOwnersIDWithHttpInfo ( $user_id,
$task_id,
$zap_trace_span = null )

Operation deleteTasksIDOwnersIDWithHttpInfo

Remove an owner from a task

Parameters
string$user_idThe ID of the owner to remove. (required)
string$task_idThe task ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of null, HTTP status code, HTTP response headers (array of strings)

◆ deleteTasksIDRequest()

InfluxDB2\Service\TasksService::deleteTasksIDRequest ( $task_id,
$zap_trace_span = null )
protected

Create request for operation 'deleteTasksID'

Parameters
string$task_idThe ID of the task to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteTasksIDRunsID()

InfluxDB2\Service\TasksService::deleteTasksIDRunsID ( $task_id,
$run_id,
$zap_trace_span = null )

Operation deleteTasksIDRunsID

Cancel a running task

Parameters
string$task_idThe ID of the task to cancel. (required)
string$run_idThe ID of the task run to cancel. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteTasksIDRunsIDRequest()

InfluxDB2\Service\TasksService::deleteTasksIDRunsIDRequest ( $task_id,
$run_id,
$zap_trace_span = null )
protected

Create request for operation 'deleteTasksIDRunsID'

Parameters
string$task_idThe ID of the task to cancel. (required)
string$run_idThe ID of the task run to cancel. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteTasksIDRunsIDWithHttpInfo()

InfluxDB2\Service\TasksService::deleteTasksIDRunsIDWithHttpInfo ( $task_id,
$run_id,
$zap_trace_span = null )

Operation deleteTasksIDRunsIDWithHttpInfo

Cancel a running task

Parameters
string$task_idThe ID of the task to cancel. (required)
string$run_idThe ID of the task run to cancel. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of null, HTTP status code, HTTP response headers (array of strings)

◆ deleteTasksIDWithHttpInfo()

InfluxDB2\Service\TasksService::deleteTasksIDWithHttpInfo ( $task_id,
$zap_trace_span = null )

Operation deleteTasksIDWithHttpInfo

Delete a task

Parameters
string$task_idThe ID of the task to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of null, HTTP status code, HTTP response headers (array of strings)

◆ getTasks()

InfluxDB2\Service\TasksService::getTasks ( $zap_trace_span = null,
$name = null,
$after = null,
$user = null,
$org = null,
$org_id = null,
$status = null,
$limit = 100,
$type = null )

Operation getTasks

List tasks

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$nameTask name. Only returns tasks with this name. Different tasks may have the same name. (optional)
string$afterTask ID. Only returns tasks created after this task. (optional)
string$userUser ID. Only returns tasks owned by this user. (optional)
string$orgOrganization name. Only returns tasks owned by this organization. (optional)
string$org_idOrganization ID. Only returns tasks owned by this organization. (optional)
string$statusTask status (`active` or `inactive`). Only returns tasks with this status. (optional)
int$limitLimits the number of tasks returned. The minimum is `1`, the maximum is `500`, and the default is `100`. (optional, default to 100)
string$typeTask type (`basic` or `system`). The default (`system`) response contains all the metadata properties for tasks. To reduce the payload size, pass `basic` to omit some task properties (`flux`, `createdAt`, `updatedAt`) from the response. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Tasks|object|\InfluxDB2\Model\Error|string

◆ getTasksID()

InfluxDB2\Service\TasksService::getTasksID ( $task_id,
$zap_trace_span = null )

Operation getTasksID

Retrieve a task

Parameters
string$task_idThe ID of the task to retrieve. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Task|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string

◆ getTasksIDLabels()

InfluxDB2\Service\TasksService::getTasksIDLabels ( $task_id,
$zap_trace_span = null )

Operation getTasksIDLabels

List labels for a task

Parameters
string$task_idThe ID of the task to retrieve labels for. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\LabelsResponse|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string

◆ getTasksIDLabelsRequest()

InfluxDB2\Service\TasksService::getTasksIDLabelsRequest ( $task_id,
$zap_trace_span = null )
protected

Create request for operation 'getTasksIDLabels'

Parameters
string$task_idThe ID of the task to retrieve labels for. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getTasksIDLabelsWithHttpInfo()

InfluxDB2\Service\TasksService::getTasksIDLabelsWithHttpInfo ( $task_id,
$zap_trace_span = null )

Operation getTasksIDLabelsWithHttpInfo

List labels for a task

Parameters
string$task_idThe ID of the task to retrieve labels for. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\LabelsResponse|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings)

◆ getTasksIDLogs()

InfluxDB2\Service\TasksService::getTasksIDLogs ( $task_id,
$zap_trace_span = null )

Operation getTasksIDLogs

Retrieve all logs for a task

Parameters
string$task_idThe task ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Logs|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string

◆ getTasksIDLogsRequest()

InfluxDB2\Service\TasksService::getTasksIDLogsRequest ( $task_id,
$zap_trace_span = null )
protected

Create request for operation 'getTasksIDLogs'

Parameters
string$task_idThe task ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getTasksIDLogsWithHttpInfo()

InfluxDB2\Service\TasksService::getTasksIDLogsWithHttpInfo ( $task_id,
$zap_trace_span = null )

Operation getTasksIDLogsWithHttpInfo

Retrieve all logs for a task

Parameters
string$task_idThe task ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Logs|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings)

◆ getTasksIDMembers()

InfluxDB2\Service\TasksService::getTasksIDMembers ( $task_id,
$zap_trace_span = null )

Operation getTasksIDMembers

List all task members

Parameters
string$task_idThe task ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\ResourceMembers|\InfluxDB2\Model\Error

◆ getTasksIDMembersRequest()

InfluxDB2\Service\TasksService::getTasksIDMembersRequest ( $task_id,
$zap_trace_span = null )
protected

Create request for operation 'getTasksIDMembers'

Parameters
string$task_idThe task ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getTasksIDMembersWithHttpInfo()

InfluxDB2\Service\TasksService::getTasksIDMembersWithHttpInfo ( $task_id,
$zap_trace_span = null )

Operation getTasksIDMembersWithHttpInfo

List all task members

Parameters
string$task_idThe task ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\ResourceMembers|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ getTasksIDOwners()

InfluxDB2\Service\TasksService::getTasksIDOwners ( $task_id,
$zap_trace_span = null )

Operation getTasksIDOwners

List all owners of a task

Parameters
string$task_idThe ID of the task to retrieve owners for. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\ResourceOwners|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ getTasksIDOwnersRequest()

InfluxDB2\Service\TasksService::getTasksIDOwnersRequest ( $task_id,
$zap_trace_span = null )
protected

Create request for operation 'getTasksIDOwners'

Parameters
string$task_idThe ID of the task to retrieve owners for. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getTasksIDOwnersWithHttpInfo()

InfluxDB2\Service\TasksService::getTasksIDOwnersWithHttpInfo ( $task_id,
$zap_trace_span = null )

Operation getTasksIDOwnersWithHttpInfo

List all owners of a task

Parameters
string$task_idThe ID of the task to retrieve owners for. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\ResourceOwners|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ getTasksIDRequest()

InfluxDB2\Service\TasksService::getTasksIDRequest ( $task_id,
$zap_trace_span = null )
protected

Create request for operation 'getTasksID'

Parameters
string$task_idThe ID of the task to retrieve. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getTasksIDRuns()

InfluxDB2\Service\TasksService::getTasksIDRuns ( $task_id,
$zap_trace_span = null,
$after = null,
$limit = 100,
$after_time = null,
$before_time = null )

Operation getTasksIDRuns

List runs for a task

Parameters
string$task_idThe ID of the task to get runs for. Only returns runs for this task. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$afterA task run ID. Only returns runs created after this run. (optional)
int$limitLimits the number of task runs returned. Default is `100`. (optional, default to 100)
\DateTime$after_timeA timestamp (RFC3339 date/time format). Only returns runs scheduled after this time. (optional)
\DateTime$before_timeA timestamp (RFC3339 date/time format). Only returns runs scheduled before this time. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Runs|object|\InfluxDB2\Model\Error|string

◆ getTasksIDRunsID()

InfluxDB2\Service\TasksService::getTasksIDRunsID ( $task_id,
$run_id,
$zap_trace_span = null )

Operation getTasksIDRunsID

Retrieve a run for a task.

Parameters
string$task_idThe ID of the task to retrieve runs for. (required)
string$run_idThe ID of the run to retrieve. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Run|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string

◆ getTasksIDRunsIDLogs()

InfluxDB2\Service\TasksService::getTasksIDRunsIDLogs ( $task_id,
$run_id,
$zap_trace_span = null )

Operation getTasksIDRunsIDLogs

Retrieve all logs for a run

Parameters
string$task_idThe ID of the task to get logs for. (required)
string$run_idThe ID of the run to get logs for. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Logs|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string

◆ getTasksIDRunsIDLogsRequest()

InfluxDB2\Service\TasksService::getTasksIDRunsIDLogsRequest ( $task_id,
$run_id,
$zap_trace_span = null )
protected

Create request for operation 'getTasksIDRunsIDLogs'

Parameters
string$task_idThe ID of the task to get logs for. (required)
string$run_idThe ID of the run to get logs for. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getTasksIDRunsIDLogsWithHttpInfo()

InfluxDB2\Service\TasksService::getTasksIDRunsIDLogsWithHttpInfo ( $task_id,
$run_id,
$zap_trace_span = null )

Operation getTasksIDRunsIDLogsWithHttpInfo

Retrieve all logs for a run

Parameters
string$task_idThe ID of the task to get logs for. (required)
string$run_idThe ID of the run to get logs for. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Logs|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings)

◆ getTasksIDRunsIDRequest()

InfluxDB2\Service\TasksService::getTasksIDRunsIDRequest ( $task_id,
$run_id,
$zap_trace_span = null )
protected

Create request for operation 'getTasksIDRunsID'

Parameters
string$task_idThe ID of the task to retrieve runs for. (required)
string$run_idThe ID of the run to retrieve. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getTasksIDRunsIDWithHttpInfo()

InfluxDB2\Service\TasksService::getTasksIDRunsIDWithHttpInfo ( $task_id,
$run_id,
$zap_trace_span = null )

Operation getTasksIDRunsIDWithHttpInfo

Retrieve a run for a task.

Parameters
string$task_idThe ID of the task to retrieve runs for. (required)
string$run_idThe ID of the run to retrieve. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Run|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings)

◆ getTasksIDRunsRequest()

InfluxDB2\Service\TasksService::getTasksIDRunsRequest ( $task_id,
$zap_trace_span = null,
$after = null,
$limit = 100,
$after_time = null,
$before_time = null )
protected

Create request for operation 'getTasksIDRuns'

Parameters
string$task_idThe ID of the task to get runs for. Only returns runs for this task. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$afterA task run ID. Only returns runs created after this run. (optional)
int$limitLimits the number of task runs returned. Default is `100`. (optional, default to 100)
\DateTime$after_timeA timestamp (RFC3339 date/time format). Only returns runs scheduled after this time. (optional)
\DateTime$before_timeA timestamp (RFC3339 date/time format). Only returns runs scheduled before this time. (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getTasksIDRunsWithHttpInfo()

InfluxDB2\Service\TasksService::getTasksIDRunsWithHttpInfo ( $task_id,
$zap_trace_span = null,
$after = null,
$limit = 100,
$after_time = null,
$before_time = null )

Operation getTasksIDRunsWithHttpInfo

List runs for a task

Parameters
string$task_idThe ID of the task to get runs for. Only returns runs for this task. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$afterA task run ID. Only returns runs created after this run. (optional)
int$limitLimits the number of task runs returned. Default is `100`. (optional, default to 100)
\DateTime$after_timeA timestamp (RFC3339 date/time format). Only returns runs scheduled after this time. (optional)
\DateTime$before_timeA timestamp (RFC3339 date/time format). Only returns runs scheduled before this time. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Runs|object|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings)

◆ getTasksIDWithHttpInfo()

InfluxDB2\Service\TasksService::getTasksIDWithHttpInfo ( $task_id,
$zap_trace_span = null )

Operation getTasksIDWithHttpInfo

Retrieve a task

Parameters
string$task_idThe ID of the task to retrieve. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Task|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings)

◆ getTasksRequest()

InfluxDB2\Service\TasksService::getTasksRequest ( $zap_trace_span = null,
$name = null,
$after = null,
$user = null,
$org = null,
$org_id = null,
$status = null,
$limit = 100,
$type = null )
protected

Create request for operation 'getTasks'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$nameTask name. Only returns tasks with this name. Different tasks may have the same name. (optional)
string$afterTask ID. Only returns tasks created after this task. (optional)
string$userUser ID. Only returns tasks owned by this user. (optional)
string$orgOrganization name. Only returns tasks owned by this organization. (optional)
string$org_idOrganization ID. Only returns tasks owned by this organization. (optional)
string$statusTask status (`active` or `inactive`). Only returns tasks with this status. (optional)
int$limitLimits the number of tasks returned. The minimum is `1`, the maximum is `500`, and the default is `100`. (optional, default to 100)
string$typeTask type (`basic` or `system`). The default (`system`) response contains all the metadata properties for tasks. To reduce the payload size, pass `basic` to omit some task properties (`flux`, `createdAt`, `updatedAt`) from the response. (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getTasksWithHttpInfo()

InfluxDB2\Service\TasksService::getTasksWithHttpInfo ( $zap_trace_span = null,
$name = null,
$after = null,
$user = null,
$org = null,
$org_id = null,
$status = null,
$limit = 100,
$type = null )

Operation getTasksWithHttpInfo

List tasks

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$nameTask name. Only returns tasks with this name. Different tasks may have the same name. (optional)
string$afterTask ID. Only returns tasks created after this task. (optional)
string$userUser ID. Only returns tasks owned by this user. (optional)
string$orgOrganization name. Only returns tasks owned by this organization. (optional)
string$org_idOrganization ID. Only returns tasks owned by this organization. (optional)
string$statusTask status (`active` or `inactive`). Only returns tasks with this status. (optional)
int$limitLimits the number of tasks returned. The minimum is `1`, the maximum is `500`, and the default is `100`. (optional, default to 100)
string$typeTask type (`basic` or `system`). The default (`system`) response contains all the metadata properties for tasks. To reduce the payload size, pass `basic` to omit some task properties (`flux`, `createdAt`, `updatedAt`) from the response. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Tasks|object|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings)

◆ patchTasksID()

InfluxDB2\Service\TasksService::patchTasksID ( $task_id,
$task_update_request,
$zap_trace_span = null )

Operation patchTasksID

Update a task

Parameters
string$task_idThe ID of the task to update. (required)
\InfluxDB2\Model\TaskUpdateRequest$task_update_requestAn object that contains updated task properties to apply. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Task|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string

◆ patchTasksIDRequest()

InfluxDB2\Service\TasksService::patchTasksIDRequest ( $task_id,
$task_update_request,
$zap_trace_span = null )
protected

Create request for operation 'patchTasksID'

Parameters
string$task_idThe ID of the task to update. (required)
\InfluxDB2\Model\TaskUpdateRequest$task_update_requestAn object that contains updated task properties to apply. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ patchTasksIDWithHttpInfo()

InfluxDB2\Service\TasksService::patchTasksIDWithHttpInfo ( $task_id,
$task_update_request,
$zap_trace_span = null )

Operation patchTasksIDWithHttpInfo

Update a task

Parameters
string$task_idThe ID of the task to update. (required)
\InfluxDB2\Model\TaskUpdateRequest$task_update_requestAn object that contains updated task properties to apply. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Task|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings)

◆ postTasks()

InfluxDB2\Service\TasksService::postTasks ( $task_create_request,
$zap_trace_span = null )

Operation postTasks

Create a task

Parameters
\InfluxDB2\Model\TaskCreateRequest$task_create_requestThe task to create. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Task|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ postTasksIDLabels()

InfluxDB2\Service\TasksService::postTasksIDLabels ( $task_id,
$label_mapping,
$zap_trace_span = null )

Operation postTasksIDLabels

Add a label to a task

Parameters
string$task_idThe ID of the task to label. (required)
\InfluxDB2\Model\LabelMapping$label_mappingAn object that contains a `labelID` to add to the task. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\LabelResponse|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string

◆ postTasksIDLabelsRequest()

InfluxDB2\Service\TasksService::postTasksIDLabelsRequest ( $task_id,
$label_mapping,
$zap_trace_span = null )
protected

Create request for operation 'postTasksIDLabels'

Parameters
string$task_idThe ID of the task to label. (required)
\InfluxDB2\Model\LabelMapping$label_mappingAn object that contains a `labelID` to add to the task. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postTasksIDLabelsWithHttpInfo()

InfluxDB2\Service\TasksService::postTasksIDLabelsWithHttpInfo ( $task_id,
$label_mapping,
$zap_trace_span = null )

Operation postTasksIDLabelsWithHttpInfo

Add a label to a task

Parameters
string$task_idThe ID of the task to label. (required)
\InfluxDB2\Model\LabelMapping$label_mappingAn object that contains a `labelID` to add to the task. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\LabelResponse|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings)

◆ postTasksIDMembers()

InfluxDB2\Service\TasksService::postTasksIDMembers ( $task_id,
$add_resource_member_request_body,
$zap_trace_span = null )

Operation postTasksIDMembers

Add a member to a task

Parameters
string$task_idThe task ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyA user to add as a member of the task. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\ResourceMember|\InfluxDB2\Model\Error

◆ postTasksIDMembersRequest()

InfluxDB2\Service\TasksService::postTasksIDMembersRequest ( $task_id,
$add_resource_member_request_body,
$zap_trace_span = null )
protected

Create request for operation 'postTasksIDMembers'

Parameters
string$task_idThe task ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyA user to add as a member of the task. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postTasksIDMembersWithHttpInfo()

InfluxDB2\Service\TasksService::postTasksIDMembersWithHttpInfo ( $task_id,
$add_resource_member_request_body,
$zap_trace_span = null )

Operation postTasksIDMembersWithHttpInfo

Add a member to a task

Parameters
string$task_idThe task ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyA user to add as a member of the task. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\ResourceMember|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ postTasksIDOwners()

InfluxDB2\Service\TasksService::postTasksIDOwners ( $task_id,
$add_resource_member_request_body,
$zap_trace_span = null )

Operation postTasksIDOwners

Add an owner for a task

Parameters
string$task_idThe task ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyA user to add as an owner of the task. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\ResourceOwner|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ postTasksIDOwnersRequest()

InfluxDB2\Service\TasksService::postTasksIDOwnersRequest ( $task_id,
$add_resource_member_request_body,
$zap_trace_span = null )
protected

Create request for operation 'postTasksIDOwners'

Parameters
string$task_idThe task ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyA user to add as an owner of the task. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postTasksIDOwnersWithHttpInfo()

InfluxDB2\Service\TasksService::postTasksIDOwnersWithHttpInfo ( $task_id,
$add_resource_member_request_body,
$zap_trace_span = null )

Operation postTasksIDOwnersWithHttpInfo

Add an owner for a task

Parameters
string$task_idThe task ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyA user to add as an owner of the task. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\ResourceOwner|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ postTasksIDRuns()

InfluxDB2\Service\TasksService::postTasksIDRuns ( $task_id,
$zap_trace_span = null,
$run_manually = null )

Operation postTasksIDRuns

Start a task run, overriding the schedule

Parameters
string$task_idtask_id (required)
string$zap_trace_spanOpenTracing span context (optional)
\InfluxDB2\Model\RunManually$run_manuallyrun_manually (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Run|object|\InfluxDB2\Model\Error|string

◆ postTasksIDRunsIDRetry()

InfluxDB2\Service\TasksService::postTasksIDRunsIDRetry ( $task_id,
$run_id,
$zap_trace_span = null,
$body = null )

Operation postTasksIDRunsIDRetry

Retry a task run

Parameters
string$task_idThe ID of the task to retry. (required)
string$run_idThe ID of the task run to retry. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$bodybody (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Run|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string

◆ postTasksIDRunsIDRetryRequest()

InfluxDB2\Service\TasksService::postTasksIDRunsIDRetryRequest ( $task_id,
$run_id,
$zap_trace_span = null,
$body = null )
protected

Create request for operation 'postTasksIDRunsIDRetry'

Parameters
string$task_idThe ID of the task to retry. (required)
string$run_idThe ID of the task run to retry. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$body(optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postTasksIDRunsIDRetryWithHttpInfo()

InfluxDB2\Service\TasksService::postTasksIDRunsIDRetryWithHttpInfo ( $task_id,
$run_id,
$zap_trace_span = null,
$body = null )

Operation postTasksIDRunsIDRetryWithHttpInfo

Retry a task run

Parameters
string$task_idThe ID of the task to retry. (required)
string$run_idThe ID of the task run to retry. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$body(optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Run|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings)

◆ postTasksIDRunsRequest()

InfluxDB2\Service\TasksService::postTasksIDRunsRequest ( $task_id,
$zap_trace_span = null,
$run_manually = null )
protected

Create request for operation 'postTasksIDRuns'

Parameters
string$task_id(required)
string$zap_trace_spanOpenTracing span context (optional)
\InfluxDB2\Model\RunManually$run_manually(optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postTasksIDRunsWithHttpInfo()

InfluxDB2\Service\TasksService::postTasksIDRunsWithHttpInfo ( $task_id,
$zap_trace_span = null,
$run_manually = null )

Operation postTasksIDRunsWithHttpInfo

Start a task run, overriding the schedule

Parameters
string$task_id(required)
string$zap_trace_spanOpenTracing span context (optional)
\InfluxDB2\Model\RunManually$run_manually(optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Run|object|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings)

◆ postTasksRequest()

InfluxDB2\Service\TasksService::postTasksRequest ( $task_create_request,
$zap_trace_span = null )
protected

Create request for operation 'postTasks'

Parameters
\InfluxDB2\Model\TaskCreateRequest$task_create_requestThe task to create. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postTasksWithHttpInfo()

InfluxDB2\Service\TasksService::postTasksWithHttpInfo ( $task_create_request,
$zap_trace_span = null )

Operation postTasksWithHttpInfo

Create a task

Parameters
\InfluxDB2\Model\TaskCreateRequest$task_create_requestThe task to create. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Task|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

The documentation for this class was generated from the following file: