|
InfluxDB PHP Client
|
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 | |
| InfluxDB2\Service\TasksService::__construct | ( | DefaultApi | $defaultApi | ) |
| DefaultApi | $defaultApi | |
| HeaderSelector | $selector |
| InfluxDB2\Service\TasksService::deleteTasksID | ( | $task_id, | |
| $zap_trace_span = null ) |
Operation deleteTasksID
Delete a task
| string | $task_id | The ID of the task to delete. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
| InfluxDB2\Service\TasksService::deleteTasksIDLabelsID | ( | $task_id, | |
| $label_id, | |||
| $zap_trace_span = null ) |
Operation deleteTasksIDLabelsID
Delete a label from a task
| string | $task_id | The ID of the task to delete the label from. (required) |
| string | $label_id | The ID of the label to delete. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
|
protected |
Create request for operation 'deleteTasksIDLabelsID'
| string | $task_id | The ID of the task to delete the label from. (required) |
| string | $label_id | The ID of the label to delete. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InvalidArgumentException
| InfluxDB2\Service\TasksService::deleteTasksIDLabelsIDWithHttpInfo | ( | $task_id, | |
| $label_id, | |||
| $zap_trace_span = null ) |
Operation deleteTasksIDLabelsIDWithHttpInfo
Delete a label from a task
| string | $task_id | The ID of the task to delete the label from. (required) |
| string | $label_id | The ID of the label to delete. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
| InfluxDB2\Service\TasksService::deleteTasksIDMembersID | ( | $user_id, | |
| $task_id, | |||
| $zap_trace_span = null ) |
Operation deleteTasksIDMembersID
Remove a member from a task
| string | $user_id | The ID of the member to remove. (required) |
| string | $task_id | The task ID. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
|
protected |
Create request for operation 'deleteTasksIDMembersID'
| string | $user_id | The ID of the member to remove. (required) |
| string | $task_id | The task ID. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InvalidArgumentException
| InfluxDB2\Service\TasksService::deleteTasksIDMembersIDWithHttpInfo | ( | $user_id, | |
| $task_id, | |||
| $zap_trace_span = null ) |
Operation deleteTasksIDMembersIDWithHttpInfo
Remove a member from a task
| string | $user_id | The ID of the member to remove. (required) |
| string | $task_id | The task ID. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
| InfluxDB2\Service\TasksService::deleteTasksIDOwnersID | ( | $user_id, | |
| $task_id, | |||
| $zap_trace_span = null ) |
Operation deleteTasksIDOwnersID
Remove an owner from a task
| string | $user_id | The ID of the owner to remove. (required) |
| string | $task_id | The task ID. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
|
protected |
Create request for operation 'deleteTasksIDOwnersID'
| string | $user_id | The ID of the owner to remove. (required) |
| string | $task_id | The task ID. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InvalidArgumentException
| InfluxDB2\Service\TasksService::deleteTasksIDOwnersIDWithHttpInfo | ( | $user_id, | |
| $task_id, | |||
| $zap_trace_span = null ) |
Operation deleteTasksIDOwnersIDWithHttpInfo
Remove an owner from a task
| string | $user_id | The ID of the owner to remove. (required) |
| string | $task_id | The task ID. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
|
protected |
Create request for operation 'deleteTasksID'
| string | $task_id | The ID of the task to delete. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InvalidArgumentException
| InfluxDB2\Service\TasksService::deleteTasksIDRunsID | ( | $task_id, | |
| $run_id, | |||
| $zap_trace_span = null ) |
Operation deleteTasksIDRunsID
Cancel a running task
| string | $task_id | The ID of the task to cancel. (required) |
| string | $run_id | The ID of the task run to cancel. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
|
protected |
Create request for operation 'deleteTasksIDRunsID'
| string | $task_id | The ID of the task to cancel. (required) |
| string | $run_id | The ID of the task run to cancel. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InvalidArgumentException
| InfluxDB2\Service\TasksService::deleteTasksIDRunsIDWithHttpInfo | ( | $task_id, | |
| $run_id, | |||
| $zap_trace_span = null ) |
Operation deleteTasksIDRunsIDWithHttpInfo
Cancel a running task
| string | $task_id | The ID of the task to cancel. (required) |
| string | $run_id | The ID of the task run to cancel. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
| InfluxDB2\Service\TasksService::deleteTasksIDWithHttpInfo | ( | $task_id, | |
| $zap_trace_span = null ) |
Operation deleteTasksIDWithHttpInfo
Delete a task
| string | $task_id | The ID of the task to delete. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
| 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
| string | $zap_trace_span | OpenTracing span context (optional) |
| string | $name | Task name. Only returns tasks with this name. Different tasks may have the same name. (optional) |
| string | $after | Task ID. Only returns tasks created after this task. (optional) |
| string | $user | User ID. Only returns tasks owned by this user. (optional) |
| string | $org | Organization name. Only returns tasks owned by this organization. (optional) |
| string | $org_id | Organization ID. Only returns tasks owned by this organization. (optional) |
| string | $status | Task status (`active` or `inactive`). Only returns tasks with this status. (optional) |
| int | $limit | Limits the number of tasks returned. The minimum is `1`, the maximum is `500`, and the default is `100`. (optional, default to 100) |
| string | $type | Task 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) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
| InfluxDB2\Service\TasksService::getTasksID | ( | $task_id, | |
| $zap_trace_span = null ) |
Operation getTasksID
Retrieve a task
| string | $task_id | The ID of the task to retrieve. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
| InfluxDB2\Service\TasksService::getTasksIDLabels | ( | $task_id, | |
| $zap_trace_span = null ) |
Operation getTasksIDLabels
List labels for a task
| string | $task_id | The ID of the task to retrieve labels for. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
|
protected |
Create request for operation 'getTasksIDLabels'
| string | $task_id | The ID of the task to retrieve labels for. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InvalidArgumentException
| InfluxDB2\Service\TasksService::getTasksIDLabelsWithHttpInfo | ( | $task_id, | |
| $zap_trace_span = null ) |
Operation getTasksIDLabelsWithHttpInfo
List labels for a task
| string | $task_id | The ID of the task to retrieve labels for. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
| InfluxDB2\Service\TasksService::getTasksIDLogs | ( | $task_id, | |
| $zap_trace_span = null ) |
Operation getTasksIDLogs
Retrieve all logs for a task
| string | $task_id | The task ID. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
|
protected |
Create request for operation 'getTasksIDLogs'
| string | $task_id | The task ID. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InvalidArgumentException
| InfluxDB2\Service\TasksService::getTasksIDLogsWithHttpInfo | ( | $task_id, | |
| $zap_trace_span = null ) |
Operation getTasksIDLogsWithHttpInfo
Retrieve all logs for a task
| string | $task_id | The task ID. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
| InfluxDB2\Service\TasksService::getTasksIDMembers | ( | $task_id, | |
| $zap_trace_span = null ) |
Operation getTasksIDMembers
List all task members
| string | $task_id | The task ID. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
|
protected |
Create request for operation 'getTasksIDMembers'
| string | $task_id | The task ID. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InvalidArgumentException
| InfluxDB2\Service\TasksService::getTasksIDMembersWithHttpInfo | ( | $task_id, | |
| $zap_trace_span = null ) |
Operation getTasksIDMembersWithHttpInfo
List all task members
| string | $task_id | The task ID. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
| InfluxDB2\Service\TasksService::getTasksIDOwners | ( | $task_id, | |
| $zap_trace_span = null ) |
Operation getTasksIDOwners
List all owners of a task
| string | $task_id | The ID of the task to retrieve owners for. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
|
protected |
Create request for operation 'getTasksIDOwners'
| string | $task_id | The ID of the task to retrieve owners for. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InvalidArgumentException
| InfluxDB2\Service\TasksService::getTasksIDOwnersWithHttpInfo | ( | $task_id, | |
| $zap_trace_span = null ) |
Operation getTasksIDOwnersWithHttpInfo
List all owners of a task
| string | $task_id | The ID of the task to retrieve owners for. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
|
protected |
Create request for operation 'getTasksID'
| string | $task_id | The ID of the task to retrieve. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InvalidArgumentException
| 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
| string | $task_id | The ID of the task to get runs for. Only returns runs for this task. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
| string | $after | A task run ID. Only returns runs created after this run. (optional) |
| int | $limit | Limits the number of task runs returned. Default is `100`. (optional, default to 100) |
| \DateTime | $after_time | A timestamp (RFC3339 date/time format). Only returns runs scheduled after this time. (optional) |
| \DateTime | $before_time | A timestamp (RFC3339 date/time format). Only returns runs scheduled before this time. (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
| InfluxDB2\Service\TasksService::getTasksIDRunsID | ( | $task_id, | |
| $run_id, | |||
| $zap_trace_span = null ) |
Operation getTasksIDRunsID
Retrieve a run for a task.
| string | $task_id | The ID of the task to retrieve runs for. (required) |
| string | $run_id | The ID of the run to retrieve. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
| InfluxDB2\Service\TasksService::getTasksIDRunsIDLogs | ( | $task_id, | |
| $run_id, | |||
| $zap_trace_span = null ) |
Operation getTasksIDRunsIDLogs
Retrieve all logs for a run
| string | $task_id | The ID of the task to get logs for. (required) |
| string | $run_id | The ID of the run to get logs for. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
|
protected |
Create request for operation 'getTasksIDRunsIDLogs'
| string | $task_id | The ID of the task to get logs for. (required) |
| string | $run_id | The ID of the run to get logs for. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InvalidArgumentException
| InfluxDB2\Service\TasksService::getTasksIDRunsIDLogsWithHttpInfo | ( | $task_id, | |
| $run_id, | |||
| $zap_trace_span = null ) |
Operation getTasksIDRunsIDLogsWithHttpInfo
Retrieve all logs for a run
| string | $task_id | The ID of the task to get logs for. (required) |
| string | $run_id | The ID of the run to get logs for. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
|
protected |
Create request for operation 'getTasksIDRunsID'
| string | $task_id | The ID of the task to retrieve runs for. (required) |
| string | $run_id | The ID of the run to retrieve. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InvalidArgumentException
| InfluxDB2\Service\TasksService::getTasksIDRunsIDWithHttpInfo | ( | $task_id, | |
| $run_id, | |||
| $zap_trace_span = null ) |
Operation getTasksIDRunsIDWithHttpInfo
Retrieve a run for a task.
| string | $task_id | The ID of the task to retrieve runs for. (required) |
| string | $run_id | The ID of the run to retrieve. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
|
protected |
Create request for operation 'getTasksIDRuns'
| string | $task_id | The ID of the task to get runs for. Only returns runs for this task. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
| string | $after | A task run ID. Only returns runs created after this run. (optional) |
| int | $limit | Limits the number of task runs returned. Default is `100`. (optional, default to 100) |
| \DateTime | $after_time | A timestamp (RFC3339 date/time format). Only returns runs scheduled after this time. (optional) |
| \DateTime | $before_time | A timestamp (RFC3339 date/time format). Only returns runs scheduled before this time. (optional) |
InvalidArgumentException
| 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
| string | $task_id | The ID of the task to get runs for. Only returns runs for this task. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
| string | $after | A task run ID. Only returns runs created after this run. (optional) |
| int | $limit | Limits the number of task runs returned. Default is `100`. (optional, default to 100) |
| \DateTime | $after_time | A timestamp (RFC3339 date/time format). Only returns runs scheduled after this time. (optional) |
| \DateTime | $before_time | A timestamp (RFC3339 date/time format). Only returns runs scheduled before this time. (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
| InfluxDB2\Service\TasksService::getTasksIDWithHttpInfo | ( | $task_id, | |
| $zap_trace_span = null ) |
Operation getTasksIDWithHttpInfo
Retrieve a task
| string | $task_id | The ID of the task to retrieve. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
|
protected |
Create request for operation 'getTasks'
| string | $zap_trace_span | OpenTracing span context (optional) |
| string | $name | Task name. Only returns tasks with this name. Different tasks may have the same name. (optional) |
| string | $after | Task ID. Only returns tasks created after this task. (optional) |
| string | $user | User ID. Only returns tasks owned by this user. (optional) |
| string | $org | Organization name. Only returns tasks owned by this organization. (optional) |
| string | $org_id | Organization ID. Only returns tasks owned by this organization. (optional) |
| string | $status | Task status (`active` or `inactive`). Only returns tasks with this status. (optional) |
| int | $limit | Limits the number of tasks returned. The minimum is `1`, the maximum is `500`, and the default is `100`. (optional, default to 100) |
| string | $type | Task 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) |
InvalidArgumentException
| 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
| string | $zap_trace_span | OpenTracing span context (optional) |
| string | $name | Task name. Only returns tasks with this name. Different tasks may have the same name. (optional) |
| string | $after | Task ID. Only returns tasks created after this task. (optional) |
| string | $user | User ID. Only returns tasks owned by this user. (optional) |
| string | $org | Organization name. Only returns tasks owned by this organization. (optional) |
| string | $org_id | Organization ID. Only returns tasks owned by this organization. (optional) |
| string | $status | Task status (`active` or `inactive`). Only returns tasks with this status. (optional) |
| int | $limit | Limits the number of tasks returned. The minimum is `1`, the maximum is `500`, and the default is `100`. (optional, default to 100) |
| string | $type | Task 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) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
| InfluxDB2\Service\TasksService::patchTasksID | ( | $task_id, | |
| $task_update_request, | |||
| $zap_trace_span = null ) |
Operation patchTasksID
Update a task
| string | $task_id | The ID of the task to update. (required) |
| \InfluxDB2\Model\TaskUpdateRequest | $task_update_request | An object that contains updated task properties to apply. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
|
protected |
Create request for operation 'patchTasksID'
| string | $task_id | The ID of the task to update. (required) |
| \InfluxDB2\Model\TaskUpdateRequest | $task_update_request | An object that contains updated task properties to apply. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InvalidArgumentException
| InfluxDB2\Service\TasksService::patchTasksIDWithHttpInfo | ( | $task_id, | |
| $task_update_request, | |||
| $zap_trace_span = null ) |
Operation patchTasksIDWithHttpInfo
Update a task
| string | $task_id | The ID of the task to update. (required) |
| \InfluxDB2\Model\TaskUpdateRequest | $task_update_request | An object that contains updated task properties to apply. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
| InfluxDB2\Service\TasksService::postTasks | ( | $task_create_request, | |
| $zap_trace_span = null ) |
Operation postTasks
Create a task
| \InfluxDB2\Model\TaskCreateRequest | $task_create_request | The task to create. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
| InfluxDB2\Service\TasksService::postTasksIDLabels | ( | $task_id, | |
| $label_mapping, | |||
| $zap_trace_span = null ) |
Operation postTasksIDLabels
Add a label to a task
| string | $task_id | The ID of the task to label. (required) |
| \InfluxDB2\Model\LabelMapping | $label_mapping | An object that contains a `labelID` to add to the task. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
|
protected |
Create request for operation 'postTasksIDLabels'
| string | $task_id | The ID of the task to label. (required) |
| \InfluxDB2\Model\LabelMapping | $label_mapping | An object that contains a `labelID` to add to the task. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InvalidArgumentException
| InfluxDB2\Service\TasksService::postTasksIDLabelsWithHttpInfo | ( | $task_id, | |
| $label_mapping, | |||
| $zap_trace_span = null ) |
Operation postTasksIDLabelsWithHttpInfo
Add a label to a task
| string | $task_id | The ID of the task to label. (required) |
| \InfluxDB2\Model\LabelMapping | $label_mapping | An object that contains a `labelID` to add to the task. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
| InfluxDB2\Service\TasksService::postTasksIDMembers | ( | $task_id, | |
| $add_resource_member_request_body, | |||
| $zap_trace_span = null ) |
Operation postTasksIDMembers
Add a member to a task
| string | $task_id | The task ID. (required) |
| \InfluxDB2\Model\AddResourceMemberRequestBody | $add_resource_member_request_body | A user to add as a member of the task. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
|
protected |
Create request for operation 'postTasksIDMembers'
| string | $task_id | The task ID. (required) |
| \InfluxDB2\Model\AddResourceMemberRequestBody | $add_resource_member_request_body | A user to add as a member of the task. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InvalidArgumentException
| InfluxDB2\Service\TasksService::postTasksIDMembersWithHttpInfo | ( | $task_id, | |
| $add_resource_member_request_body, | |||
| $zap_trace_span = null ) |
Operation postTasksIDMembersWithHttpInfo
Add a member to a task
| string | $task_id | The task ID. (required) |
| \InfluxDB2\Model\AddResourceMemberRequestBody | $add_resource_member_request_body | A user to add as a member of the task. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
| InfluxDB2\Service\TasksService::postTasksIDOwners | ( | $task_id, | |
| $add_resource_member_request_body, | |||
| $zap_trace_span = null ) |
Operation postTasksIDOwners
Add an owner for a task
| string | $task_id | The task ID. (required) |
| \InfluxDB2\Model\AddResourceMemberRequestBody | $add_resource_member_request_body | A user to add as an owner of the task. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
|
protected |
Create request for operation 'postTasksIDOwners'
| string | $task_id | The task ID. (required) |
| \InfluxDB2\Model\AddResourceMemberRequestBody | $add_resource_member_request_body | A user to add as an owner of the task. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InvalidArgumentException
| InfluxDB2\Service\TasksService::postTasksIDOwnersWithHttpInfo | ( | $task_id, | |
| $add_resource_member_request_body, | |||
| $zap_trace_span = null ) |
Operation postTasksIDOwnersWithHttpInfo
Add an owner for a task
| string | $task_id | The task ID. (required) |
| \InfluxDB2\Model\AddResourceMemberRequestBody | $add_resource_member_request_body | A user to add as an owner of the task. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
| InfluxDB2\Service\TasksService::postTasksIDRuns | ( | $task_id, | |
| $zap_trace_span = null, | |||
| $run_manually = null ) |
Operation postTasksIDRuns
Start a task run, overriding the schedule
| string | $task_id | task_id (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
| \InfluxDB2\Model\RunManually | $run_manually | run_manually (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
| InfluxDB2\Service\TasksService::postTasksIDRunsIDRetry | ( | $task_id, | |
| $run_id, | |||
| $zap_trace_span = null, | |||
| $body = null ) |
Operation postTasksIDRunsIDRetry
Retry a task run
| string | $task_id | The ID of the task to retry. (required) |
| string | $run_id | The ID of the task run to retry. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
| string | $body | body (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
|
protected |
Create request for operation 'postTasksIDRunsIDRetry'
| string | $task_id | The ID of the task to retry. (required) |
| string | $run_id | The ID of the task run to retry. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
| string | $body | (optional) |
InvalidArgumentException
| InfluxDB2\Service\TasksService::postTasksIDRunsIDRetryWithHttpInfo | ( | $task_id, | |
| $run_id, | |||
| $zap_trace_span = null, | |||
| $body = null ) |
Operation postTasksIDRunsIDRetryWithHttpInfo
Retry a task run
| string | $task_id | The ID of the task to retry. (required) |
| string | $run_id | The ID of the task run to retry. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
| string | $body | (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
|
protected |
Create request for operation 'postTasksIDRuns'
| string | $task_id | (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
| \InfluxDB2\Model\RunManually | $run_manually | (optional) |
InvalidArgumentException
| InfluxDB2\Service\TasksService::postTasksIDRunsWithHttpInfo | ( | $task_id, | |
| $zap_trace_span = null, | |||
| $run_manually = null ) |
Operation postTasksIDRunsWithHttpInfo
Start a task run, overriding the schedule
| string | $task_id | (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
| \InfluxDB2\Model\RunManually | $run_manually | (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException
|
protected |
Create request for operation 'postTasks'
| \InfluxDB2\Model\TaskCreateRequest | $task_create_request | The task to create. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InvalidArgumentException
| InfluxDB2\Service\TasksService::postTasksWithHttpInfo | ( | $task_create_request, | |
| $zap_trace_span = null ) |
Operation postTasksWithHttpInfo
Create a task
| \InfluxDB2\Model\TaskCreateRequest | $task_create_request | The task to create. (required) |
| string | $zap_trace_span | OpenTracing span context (optional) |
InfluxDB2\ApiException on non-2xx response
InvalidArgumentException