InfluxDB PHP Client
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
InfluxDB2\Service\TasksService Class Reference

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 deleteTasksID ($task_id, $zap_trace_span=null)
 
 deleteTasksIDWithHttpInfo ($task_id, $zap_trace_span=null)
 
 deleteTasksIDAsync ($task_id, $zap_trace_span=null)
 
 deleteTasksIDAsyncWithHttpInfo ($task_id, $zap_trace_span=null)
 
 deleteTasksIDLabelsID ($task_id, $label_id, $zap_trace_span=null)
 
 deleteTasksIDLabelsIDWithHttpInfo ($task_id, $label_id, $zap_trace_span=null)
 
 deleteTasksIDLabelsIDAsync ($task_id, $label_id, $zap_trace_span=null)
 
 deleteTasksIDLabelsIDAsyncWithHttpInfo ($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)
 
 deleteTasksIDMembersIDAsync ($user_id, $task_id, $zap_trace_span=null)
 
 deleteTasksIDMembersIDAsyncWithHttpInfo ($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)
 
 deleteTasksIDOwnersIDAsync ($user_id, $task_id, $zap_trace_span=null)
 
 deleteTasksIDOwnersIDAsyncWithHttpInfo ($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)
 
 deleteTasksIDRunsIDAsync ($task_id, $run_id, $zap_trace_span=null)
 
 deleteTasksIDRunsIDAsyncWithHttpInfo ($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)
 
 getTasksWithHttpInfo ($zap_trace_span=null, $name=null, $after=null, $user=null, $org=null, $org_id=null, $status=null, $limit=100)
 
 getTasksAsync ($zap_trace_span=null, $name=null, $after=null, $user=null, $org=null, $org_id=null, $status=null, $limit=100)
 
 getTasksAsyncWithHttpInfo ($zap_trace_span=null, $name=null, $after=null, $user=null, $org=null, $org_id=null, $status=null, $limit=100)
 
 getTasksID ($task_id, $zap_trace_span=null)
 
 getTasksIDWithHttpInfo ($task_id, $zap_trace_span=null)
 
 getTasksIDAsync ($task_id, $zap_trace_span=null)
 
 getTasksIDAsyncWithHttpInfo ($task_id, $zap_trace_span=null)
 
 getTasksIDLabels ($task_id, $zap_trace_span=null)
 
 getTasksIDLabelsWithHttpInfo ($task_id, $zap_trace_span=null)
 
 getTasksIDLabelsAsync ($task_id, $zap_trace_span=null)
 
 getTasksIDLabelsAsyncWithHttpInfo ($task_id, $zap_trace_span=null)
 
 getTasksIDLogs ($task_id, $zap_trace_span=null)
 
 getTasksIDLogsWithHttpInfo ($task_id, $zap_trace_span=null)
 
 getTasksIDLogsAsync ($task_id, $zap_trace_span=null)
 
 getTasksIDLogsAsyncWithHttpInfo ($task_id, $zap_trace_span=null)
 
 getTasksIDMembers ($task_id, $zap_trace_span=null)
 
 getTasksIDMembersWithHttpInfo ($task_id, $zap_trace_span=null)
 
 getTasksIDMembersAsync ($task_id, $zap_trace_span=null)
 
 getTasksIDMembersAsyncWithHttpInfo ($task_id, $zap_trace_span=null)
 
 getTasksIDOwners ($task_id, $zap_trace_span=null)
 
 getTasksIDOwnersWithHttpInfo ($task_id, $zap_trace_span=null)
 
 getTasksIDOwnersAsync ($task_id, $zap_trace_span=null)
 
 getTasksIDOwnersAsyncWithHttpInfo ($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)
 
 getTasksIDRunsAsync ($task_id, $zap_trace_span=null, $after=null, $limit=100, $after_time=null, $before_time=null)
 
 getTasksIDRunsAsyncWithHttpInfo ($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)
 
 getTasksIDRunsIDAsync ($task_id, $run_id, $zap_trace_span=null)
 
 getTasksIDRunsIDAsyncWithHttpInfo ($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)
 
 getTasksIDRunsIDLogsAsync ($task_id, $run_id, $zap_trace_span=null)
 
 getTasksIDRunsIDLogsAsyncWithHttpInfo ($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)
 
 patchTasksIDAsync ($task_id, $task_update_request, $zap_trace_span=null)
 
 patchTasksIDAsyncWithHttpInfo ($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)
 
 postTasksAsync ($task_create_request, $zap_trace_span=null)
 
 postTasksAsyncWithHttpInfo ($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)
 
 postTasksIDLabelsAsync ($task_id, $label_mapping, $zap_trace_span=null)
 
 postTasksIDLabelsAsyncWithHttpInfo ($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)
 
 postTasksIDMembersAsync ($task_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postTasksIDMembersAsyncWithHttpInfo ($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)
 
 postTasksIDOwnersAsync ($task_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postTasksIDOwnersAsyncWithHttpInfo ($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)
 
 postTasksIDRunsAsync ($task_id, $zap_trace_span=null, $run_manually=null)
 
 postTasksIDRunsAsyncWithHttpInfo ($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)
 
 postTasksIDRunsIDRetryAsync ($task_id, $run_id, $zap_trace_span=null, $body=null)
 
 postTasksIDRunsIDRetryAsyncWithHttpInfo ($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)
 
 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)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\TasksService::__construct ( ClientInterface  $client = null,
Configuration  $config = null,
HeaderSelector  $selector = null 
)
Parameters
ClientInterface$client
Configuration$config
HeaderSelector$selector

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\TasksService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ 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

◆ deleteTasksIDAsync()

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

Operation deleteTasksIDAsync

Delete a task

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteTasksIDAsyncWithHttpInfo()

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

Operation deleteTasksIDAsyncWithHttpInfo

Delete a task

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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 task ID. (required)
string$label_idThe label ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteTasksIDLabelsIDAsync()

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

Operation deleteTasksIDLabelsIDAsync

Delete a label from a task

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteTasksIDLabelsIDAsyncWithHttpInfo()

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

Operation deleteTasksIDLabelsIDAsyncWithHttpInfo

Delete a label from a task

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteTasksIDLabelsIDRequest()

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

Create request for operation 'deleteTasksIDLabelsID'

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

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ 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 task ID. (required)
string$label_idThe label 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)

◆ 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

◆ deleteTasksIDMembersIDAsync()

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

Operation deleteTasksIDMembersIDAsync

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteTasksIDMembersIDAsyncWithHttpInfo()

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

Operation deleteTasksIDMembersIDAsyncWithHttpInfo

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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
\GuzzleHttp\Psr7\Request

◆ 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

◆ deleteTasksIDOwnersIDAsync()

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

Operation deleteTasksIDOwnersIDAsync

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteTasksIDOwnersIDAsyncWithHttpInfo()

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

Operation deleteTasksIDOwnersIDAsyncWithHttpInfo

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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
\GuzzleHttp\Psr7\Request

◆ 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
\GuzzleHttp\Psr7\Request

◆ deleteTasksIDRunsID()

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

Operation deleteTasksIDRunsID

Cancel a running task

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteTasksIDRunsIDAsync()

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

Operation deleteTasksIDRunsIDAsync

Cancel a running task

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteTasksIDRunsIDAsyncWithHttpInfo()

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

Operation deleteTasksIDRunsIDAsyncWithHttpInfo

Cancel a running task

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteTasksIDRunsIDRequest()

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

Create request for operation 'deleteTasksIDRunsID'

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

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ deleteTasksIDRunsIDWithHttpInfo()

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

Operation deleteTasksIDRunsIDWithHttpInfo

Cancel a running task

Parameters
string$task_idThe task ID. (required)
string$run_idThe run 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)

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

◆ getConfig()

InfluxDB2\Service\TasksService::getConfig ( )
Returns
Configuration

◆ getTasks()

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

Operation getTasks

List all tasks

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$nameReturns task with a specific name. (optional)
string$afterReturn tasks after a specified ID. (optional)
string$userFilter tasks to a specific user ID. (optional)
string$orgFilter tasks to a specific organization name. (optional)
string$org_idFilter tasks to a specific organization ID. (optional)
string$statusFilter tasks by a status–"inactive" or "active". (optional)
int$limitThe number of tasks to return (optional, default to 100)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Tasks|\InfluxDB2\Model\Error

◆ getTasksAsync()

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

Operation getTasksAsync

List all tasks

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$nameReturns task with a specific name. (optional)
string$afterReturn tasks after a specified ID. (optional)
string$userFilter tasks to a specific user ID. (optional)
string$orgFilter tasks to a specific organization name. (optional)
string$org_idFilter tasks to a specific organization ID. (optional)
string$statusFilter tasks by a status–"inactive" or "active". (optional)
int$limitThe number of tasks to return (optional, default to 100)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getTasksAsyncWithHttpInfo()

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

Operation getTasksAsyncWithHttpInfo

List all tasks

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$nameReturns task with a specific name. (optional)
string$afterReturn tasks after a specified ID. (optional)
string$userFilter tasks to a specific user ID. (optional)
string$orgFilter tasks to a specific organization name. (optional)
string$org_idFilter tasks to a specific organization ID. (optional)
string$statusFilter tasks by a status–"inactive" or "active". (optional)
int$limitThe number of tasks to return (optional, default to 100)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getTasksID()

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

Operation getTasksID

Retrieve 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\Task|\InfluxDB2\Model\Error

◆ getTasksIDAsync()

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

Operation getTasksIDAsync

Retrieve a task

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getTasksIDAsyncWithHttpInfo()

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

Operation getTasksIDAsyncWithHttpInfo

Retrieve a task

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getTasksIDLabels()

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

Operation getTasksIDLabels

List all labels 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\LabelsResponse|\InfluxDB2\Model\Error

◆ getTasksIDLabelsAsync()

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

Operation getTasksIDLabelsAsync

List all labels for a task

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getTasksIDLabelsAsyncWithHttpInfo()

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

Operation getTasksIDLabelsAsyncWithHttpInfo

List all labels for a task

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getTasksIDLabelsRequest()

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

Create request for operation 'getTasksIDLabels'

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

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getTasksIDLabelsWithHttpInfo()

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

Operation getTasksIDLabelsWithHttpInfo

List all labels 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\LabelsResponse|\InfluxDB2\Model\Error, 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

◆ getTasksIDLogsAsync()

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

Operation getTasksIDLogsAsync

Retrieve all logs for a task

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getTasksIDLogsAsyncWithHttpInfo()

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

Operation getTasksIDLogsAsyncWithHttpInfo

Retrieve all logs for a task

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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
\GuzzleHttp\Psr7\Request

◆ 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, 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

◆ getTasksIDMembersAsync()

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

Operation getTasksIDMembersAsync

List all task members

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getTasksIDMembersAsyncWithHttpInfo()

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

Operation getTasksIDMembersAsyncWithHttpInfo

List all task members

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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
\GuzzleHttp\Psr7\Request

◆ 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 task ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getTasksIDOwnersAsync()

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

Operation getTasksIDOwnersAsync

List all owners of a task

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getTasksIDOwnersAsyncWithHttpInfo()

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

Operation getTasksIDOwnersAsyncWithHttpInfo

List all owners of a task

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getTasksIDOwnersRequest()

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

Create request for operation 'getTasksIDOwners'

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

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getTasksIDOwnersWithHttpInfo()

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

Operation getTasksIDOwnersWithHttpInfo

List all owners of 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\ResourceOwners|\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 task ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ 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. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$afterReturns runs after a specific ID. (optional)
int$limitThe number of runs to return (optional, default to 100)
\DateTime$after_timeFilter runs to those scheduled after this time, RFC3339 (optional)
\DateTime$before_timeFilter runs to those scheduled before this time, RFC3339 (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Runs|\InfluxDB2\Model\Error

◆ getTasksIDRunsAsync()

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

Operation getTasksIDRunsAsync

List runs for a task

Parameters
string$task_idThe ID of the task to get runs for. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$afterReturns runs after a specific ID. (optional)
int$limitThe number of runs to return (optional, default to 100)
\DateTime$after_timeFilter runs to those scheduled after this time, RFC3339 (optional)
\DateTime$before_timeFilter runs to those scheduled before this time, RFC3339 (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getTasksIDRunsAsyncWithHttpInfo()

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

Operation getTasksIDRunsAsyncWithHttpInfo

List runs for a task

Parameters
string$task_idThe ID of the task to get runs for. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$afterReturns runs after a specific ID. (optional)
int$limitThe number of runs to return (optional, default to 100)
\DateTime$after_timeFilter runs to those scheduled after this time, RFC3339 (optional)
\DateTime$before_timeFilter runs to those scheduled before this time, RFC3339 (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getTasksIDRunsID()

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

Operation getTasksIDRunsID

Retrieve a single run for a task

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Run|\InfluxDB2\Model\Error

◆ getTasksIDRunsIDAsync()

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

Operation getTasksIDRunsIDAsync

Retrieve a single run for a task

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getTasksIDRunsIDAsyncWithHttpInfo()

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

Operation getTasksIDRunsIDAsyncWithHttpInfo

Retrieve a single run for a task

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getTasksIDRunsIDLogs()

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

Operation getTasksIDRunsIDLogs

Retrieve all logs for a run

Parameters
string$task_idID of task to get logs for. (required)
string$run_idID of 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

◆ getTasksIDRunsIDLogsAsync()

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

Operation getTasksIDRunsIDLogsAsync

Retrieve all logs for a run

Parameters
string$task_idID of task to get logs for. (required)
string$run_idID of run to get logs for. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getTasksIDRunsIDLogsAsyncWithHttpInfo()

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

Operation getTasksIDRunsIDLogsAsyncWithHttpInfo

Retrieve all logs for a run

Parameters
string$task_idID of task to get logs for. (required)
string$run_idID of run to get logs for. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getTasksIDRunsIDLogsRequest()

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

Create request for operation 'getTasksIDRunsIDLogs'

Parameters
string$task_idID of task to get logs for. (required)
string$run_idID of run to get logs for. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getTasksIDRunsIDLogsWithHttpInfo()

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

Operation getTasksIDRunsIDLogsWithHttpInfo

Retrieve all logs for a run

Parameters
string$task_idID of task to get logs for. (required)
string$run_idID of 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, 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 task ID. (required)
string$run_idThe run ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getTasksIDRunsIDWithHttpInfo()

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

Operation getTasksIDRunsIDWithHttpInfo

Retrieve a single run for a task

Parameters
string$task_idThe task ID. (required)
string$run_idThe run ID. (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, 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. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$afterReturns runs after a specific ID. (optional)
int$limitThe number of runs to return (optional, default to 100)
\DateTime$after_timeFilter runs to those scheduled after this time, RFC3339 (optional)
\DateTime$before_timeFilter runs to those scheduled before this time, RFC3339 (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ 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. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$afterReturns runs after a specific ID. (optional)
int$limitThe number of runs to return (optional, default to 100)
\DateTime$after_timeFilter runs to those scheduled after this time, RFC3339 (optional)
\DateTime$before_timeFilter runs to those scheduled before this time, RFC3339 (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Runs|\InfluxDB2\Model\Error, 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 task ID. (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, 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 
)
protected

Create request for operation 'getTasks'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$nameReturns task with a specific name. (optional)
string$afterReturn tasks after a specified ID. (optional)
string$userFilter tasks to a specific user ID. (optional)
string$orgFilter tasks to a specific organization name. (optional)
string$org_idFilter tasks to a specific organization ID. (optional)
string$statusFilter tasks by a status–"inactive" or "active". (optional)
int$limitThe number of tasks to return (optional, default to 100)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getTasksWithHttpInfo()

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

Operation getTasksWithHttpInfo

List all tasks

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$nameReturns task with a specific name. (optional)
string$afterReturn tasks after a specified ID. (optional)
string$userFilter tasks to a specific user ID. (optional)
string$orgFilter tasks to a specific organization name. (optional)
string$org_idFilter tasks to a specific organization ID. (optional)
string$statusFilter tasks by a status–"inactive" or "active". (optional)
int$limitThe number of tasks to return (optional, default to 100)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Tasks|\InfluxDB2\Model\Error, 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 task ID. (required)
\InfluxDB2\Model\TaskUpdateRequest$task_update_requestTask update 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

◆ patchTasksIDAsync()

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

Operation patchTasksIDAsync

Update a task

Parameters
string$task_idThe task ID. (required)
\InfluxDB2\Model\TaskUpdateRequest$task_update_requestTask update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchTasksIDAsyncWithHttpInfo()

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

Operation patchTasksIDAsyncWithHttpInfo

Update a task

Parameters
string$task_idThe task ID. (required)
\InfluxDB2\Model\TaskUpdateRequest$task_update_requestTask update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchTasksIDRequest()

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

Create request for operation 'patchTasksID'

Parameters
string$task_idThe task ID. (required)
\InfluxDB2\Model\TaskUpdateRequest$task_update_requestTask update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ patchTasksIDWithHttpInfo()

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

Operation patchTasksIDWithHttpInfo

Update a task

Parameters
string$task_idThe task ID. (required)
\InfluxDB2\Model\TaskUpdateRequest$task_update_requestTask update 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, 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 new task

Parameters
\InfluxDB2\Model\TaskCreateRequest$task_create_requestTask 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

◆ postTasksAsync()

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

Operation postTasksAsync

Create a new task

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postTasksAsyncWithHttpInfo()

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

Operation postTasksAsyncWithHttpInfo

Create a new task

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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 task ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\LabelResponse|\InfluxDB2\Model\Error

◆ postTasksIDLabelsAsync()

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

Operation postTasksIDLabelsAsync

Add a label to a task

Parameters
string$task_idThe task ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postTasksIDLabelsAsyncWithHttpInfo()

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

Operation postTasksIDLabelsAsyncWithHttpInfo

Add a label to a task

Parameters
string$task_idThe task ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postTasksIDLabelsRequest()

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

Create request for operation 'postTasksIDLabels'

Parameters
string$task_idThe task ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ 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 task ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (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, 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_bodyUser to add as member (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postTasksIDMembersAsync()

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

Operation postTasksIDMembersAsync

Add a member to a task

Parameters
string$task_idThe task ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as member (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postTasksIDMembersAsyncWithHttpInfo()

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

Operation postTasksIDMembersAsyncWithHttpInfo

Add a member to a task

Parameters
string$task_idThe task ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as member (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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_bodyUser to add as member (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ 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_bodyUser to add as member (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 to a task

Parameters
string$task_idThe task ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as owner (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postTasksIDOwnersAsync()

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

Operation postTasksIDOwnersAsync

Add an owner to a task

Parameters
string$task_idThe task ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as owner (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postTasksIDOwnersAsyncWithHttpInfo()

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

Operation postTasksIDOwnersAsyncWithHttpInfo

Add an owner to a task

Parameters
string$task_idThe task ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as owner (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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_bodyUser to add as owner (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postTasksIDOwnersWithHttpInfo()

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

Operation postTasksIDOwnersWithHttpInfo

Add an owner to a task

Parameters
string$task_idThe task ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as owner (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\ResourceOwner|\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

Manually start a task run, overriding the current 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|\InfluxDB2\Model\Error

◆ postTasksIDRunsAsync()

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

Operation postTasksIDRunsAsync

Manually start a task run, overriding the current schedule

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postTasksIDRunsAsyncWithHttpInfo()

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

Operation postTasksIDRunsAsyncWithHttpInfo

Manually start a task run, overriding the current schedule

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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 task ID. (required)
string$run_idThe run ID. (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

◆ postTasksIDRunsIDRetryAsync()

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

Operation postTasksIDRunsIDRetryAsync

Retry a task run

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postTasksIDRunsIDRetryAsyncWithHttpInfo()

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

Operation postTasksIDRunsIDRetryAsyncWithHttpInfo

Retry a task run

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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 task ID. (required)
string$run_idThe run ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$body(optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ 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 task ID. (required)
string$run_idThe run ID. (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, 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
\GuzzleHttp\Psr7\Request

◆ postTasksIDRunsWithHttpInfo()

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

Operation postTasksIDRunsWithHttpInfo

Manually start a task run, overriding the current 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|\InfluxDB2\Model\Error, 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_requestTask to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postTasksWithHttpInfo()

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

Operation postTasksWithHttpInfo

Create a new task

Parameters
\InfluxDB2\Model\TaskCreateRequest$task_create_requestTask 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, HTTP status code, HTTP response headers (array of strings)

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