code
stringlengths 17
296k
| docstring
stringlengths 30
30.3k
| func_name
stringlengths 1
89
| language
stringclasses 1
value | repo
stringlengths 7
63
| path
stringlengths 7
153
| url
stringlengths 51
209
| license
stringclasses 4
values |
|---|---|---|---|---|---|---|---|
public function putNotificationRulesIDWithHttpInfo($rule_id, $notification_rule, $zap_trace_span = null)
{
$request = $this->putNotificationRulesIDRequest($rule_id, $notification_rule, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\NotificationRule';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation putNotificationRulesIDWithHttpInfo
Update a notification rule
@param string $rule_id The notification rule ID. (required)
@param \InfluxDB2\Model\NotificationRule $notification_rule Notification rule update to apply (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\NotificationRule|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | putNotificationRulesIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationRulesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationRulesService.php | MIT |
protected function putNotificationRulesIDRequest($rule_id, $notification_rule, $zap_trace_span = null)
{
// verify the required parameter 'rule_id' is set
if ($rule_id === null || (is_array($rule_id) && count($rule_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $rule_id when calling putNotificationRulesID'
);
}
// verify the required parameter 'notification_rule' is set
if ($notification_rule === null || (is_array($notification_rule) && count($notification_rule) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $notification_rule when calling putNotificationRulesID'
);
}
$resourcePath = '/api/v2/notificationRules/{ruleID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($rule_id !== null) {
$resourcePath = str_replace(
'{' . 'ruleID' . '}',
ObjectSerializer::toPathValue($rule_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($notification_rule)) {
$_tempBody = $notification_rule;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('PUT', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'putNotificationRulesID'
@param string $rule_id The notification rule ID. (required)
@param \InfluxDB2\Model\NotificationRule $notification_rule Notification rule update to apply (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | putNotificationRulesIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationRulesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationRulesService.php | MIT |
public function deleteOrgsIDSecretsID($org_id, $secret_id, $zap_trace_span = null)
{
$this->deleteOrgsIDSecretsIDWithHttpInfo($org_id, $secret_id, $zap_trace_span);
} | Operation deleteOrgsIDSecretsID
Delete a secret from an organization
@param string $org_id The organization ID. (required)
@param string $secret_id The secret ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return void | deleteOrgsIDSecretsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/SecretsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/SecretsService.php | MIT |
public function deleteOrgsIDSecretsIDWithHttpInfo($org_id, $secret_id, $zap_trace_span = null)
{
$request = $this->deleteOrgsIDSecretsIDRequest($org_id, $secret_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteOrgsIDSecretsIDWithHttpInfo
Delete a secret from an organization
@param string $org_id The organization ID. (required)
@param string $secret_id The secret ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of null, HTTP status code, HTTP response headers (array of strings) | deleteOrgsIDSecretsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/SecretsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/SecretsService.php | MIT |
protected function deleteOrgsIDSecretsIDRequest($org_id, $secret_id, $zap_trace_span = null)
{
// verify the required parameter 'org_id' is set
if ($org_id === null || (is_array($org_id) && count($org_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $org_id when calling deleteOrgsIDSecretsID'
);
}
// verify the required parameter 'secret_id' is set
if ($secret_id === null || (is_array($secret_id) && count($secret_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $secret_id when calling deleteOrgsIDSecretsID'
);
}
$resourcePath = '/api/v2/orgs/{orgID}/secrets/{secretID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($org_id !== null) {
$resourcePath = str_replace(
'{' . 'orgID' . '}',
ObjectSerializer::toPathValue($org_id),
$resourcePath
);
}
// path params
if ($secret_id !== null) {
$resourcePath = str_replace(
'{' . 'secretID' . '}',
ObjectSerializer::toPathValue($secret_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('DELETE', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'deleteOrgsIDSecretsID'
@param string $org_id The organization ID. (required)
@param string $secret_id The secret ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | deleteOrgsIDSecretsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/SecretsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/SecretsService.php | MIT |
public function getOrgsIDSecrets($org_id, $zap_trace_span = null)
{
list($response) = $this->getOrgsIDSecretsWithHttpInfo($org_id, $zap_trace_span);
return $response;
} | Operation getOrgsIDSecrets
List all secret keys for an organization
@param string $org_id The organization ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\SecretKeysResponse|\InfluxDB2\Model\Error | getOrgsIDSecrets | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/SecretsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/SecretsService.php | MIT |
public function getOrgsIDSecretsWithHttpInfo($org_id, $zap_trace_span = null)
{
$request = $this->getOrgsIDSecretsRequest($org_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\SecretKeysResponse';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation getOrgsIDSecretsWithHttpInfo
List all secret keys for an organization
@param string $org_id The organization ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\SecretKeysResponse|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getOrgsIDSecretsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/SecretsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/SecretsService.php | MIT |
protected function getOrgsIDSecretsRequest($org_id, $zap_trace_span = null)
{
// verify the required parameter 'org_id' is set
if ($org_id === null || (is_array($org_id) && count($org_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $org_id when calling getOrgsIDSecrets'
);
}
$resourcePath = '/api/v2/orgs/{orgID}/secrets';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($org_id !== null) {
$resourcePath = str_replace(
'{' . 'orgID' . '}',
ObjectSerializer::toPathValue($org_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('GET', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'getOrgsIDSecrets'
@param string $org_id The organization ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getOrgsIDSecretsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/SecretsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/SecretsService.php | MIT |
public function patchOrgsIDSecrets($org_id, $request_body, $zap_trace_span = null)
{
$this->patchOrgsIDSecretsWithHttpInfo($org_id, $request_body, $zap_trace_span);
} | Operation patchOrgsIDSecrets
Update secrets in an organization
@param string $org_id The organization ID. (required)
@param map[string,string] $request_body Secret key value pairs to update/add (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return void | patchOrgsIDSecrets | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/SecretsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/SecretsService.php | MIT |
public function patchOrgsIDSecretsWithHttpInfo($org_id, $request_body, $zap_trace_span = null)
{
$request = $this->patchOrgsIDSecretsRequest($org_id, $request_body, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation patchOrgsIDSecretsWithHttpInfo
Update secrets in an organization
@param string $org_id The organization ID. (required)
@param map[string,string] $request_body Secret key value pairs to update/add (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of null, HTTP status code, HTTP response headers (array of strings) | patchOrgsIDSecretsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/SecretsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/SecretsService.php | MIT |
protected function patchOrgsIDSecretsRequest($org_id, $request_body, $zap_trace_span = null)
{
// verify the required parameter 'org_id' is set
if ($org_id === null || (is_array($org_id) && count($org_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $org_id when calling patchOrgsIDSecrets'
);
}
// verify the required parameter 'request_body' is set
if ($request_body === null || (is_array($request_body) && count($request_body) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $request_body when calling patchOrgsIDSecrets'
);
}
$resourcePath = '/api/v2/orgs/{orgID}/secrets';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($org_id !== null) {
$resourcePath = str_replace(
'{' . 'orgID' . '}',
ObjectSerializer::toPathValue($org_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($request_body)) {
$_tempBody = $request_body;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('PATCH', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'patchOrgsIDSecrets'
@param string $org_id The organization ID. (required)
@param map[string,string] $request_body Secret key value pairs to update/add (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | patchOrgsIDSecretsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/SecretsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/SecretsService.php | MIT |
public function postOrgsIDSecrets($org_id, $secret_keys, $zap_trace_span = null)
{
$this->postOrgsIDSecretsWithHttpInfo($org_id, $secret_keys, $zap_trace_span);
} | Operation postOrgsIDSecrets
Delete secrets from an organization
@param string $org_id The organization ID. (required)
@param \InfluxDB2\Model\SecretKeys $secret_keys Secret key to delete (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return void | postOrgsIDSecrets | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/SecretsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/SecretsService.php | MIT |
public function postOrgsIDSecretsWithHttpInfo($org_id, $secret_keys, $zap_trace_span = null)
{
$request = $this->postOrgsIDSecretsRequest($org_id, $secret_keys, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation postOrgsIDSecretsWithHttpInfo
Delete secrets from an organization
@param string $org_id The organization ID. (required)
@param \InfluxDB2\Model\SecretKeys $secret_keys Secret key to delete (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of null, HTTP status code, HTTP response headers (array of strings) | postOrgsIDSecretsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/SecretsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/SecretsService.php | MIT |
protected function postOrgsIDSecretsRequest($org_id, $secret_keys, $zap_trace_span = null)
{
// verify the required parameter 'org_id' is set
if ($org_id === null || (is_array($org_id) && count($org_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $org_id when calling postOrgsIDSecrets'
);
}
// verify the required parameter 'secret_keys' is set
if ($secret_keys === null || (is_array($secret_keys) && count($secret_keys) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $secret_keys when calling postOrgsIDSecrets'
);
}
$resourcePath = '/api/v2/orgs/{orgID}/secrets/delete';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($org_id !== null) {
$resourcePath = str_replace(
'{' . 'orgID' . '}',
ObjectSerializer::toPathValue($org_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($secret_keys)) {
$_tempBody = $secret_keys;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('POST', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'postOrgsIDSecrets'
@param string $org_id The organization ID. (required)
@param \InfluxDB2\Model\SecretKeys $secret_keys Secret key to delete (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | postOrgsIDSecretsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/SecretsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/SecretsService.php | MIT |
public function deleteTasksID($task_id, $zap_trace_span = null)
{
$this->deleteTasksIDWithHttpInfo($task_id, $zap_trace_span);
} | Operation deleteTasksID
Delete a task
@param string $task_id The ID of the task to delete. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return void | deleteTasksID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function deleteTasksIDWithHttpInfo($task_id, $zap_trace_span = null)
{
$request = $this->deleteTasksIDRequest($task_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteTasksIDWithHttpInfo
Delete a task
@param string $task_id The ID of the task to delete. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of null, HTTP status code, HTTP response headers (array of strings) | deleteTasksIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
protected function deleteTasksIDRequest($task_id, $zap_trace_span = null)
{
// verify the required parameter 'task_id' is set
if ($task_id === null || (is_array($task_id) && count($task_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $task_id when calling deleteTasksID'
);
}
$resourcePath = '/api/v2/tasks/{taskID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($task_id !== null) {
$resourcePath = str_replace(
'{' . 'taskID' . '}',
ObjectSerializer::toPathValue($task_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('DELETE', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'deleteTasksID'
@param string $task_id The ID of the task to delete. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | deleteTasksIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function deleteTasksIDLabelsID($task_id, $label_id, $zap_trace_span = null)
{
$this->deleteTasksIDLabelsIDWithHttpInfo($task_id, $label_id, $zap_trace_span);
} | Operation deleteTasksIDLabelsID
Delete a label from a task
@param string $task_id The ID of the task to delete the label from. (required)
@param string $label_id The ID of the label to delete. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return void | deleteTasksIDLabelsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function deleteTasksIDLabelsIDWithHttpInfo($task_id, $label_id, $zap_trace_span = null)
{
$request = $this->deleteTasksIDLabelsIDRequest($task_id, $label_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteTasksIDLabelsIDWithHttpInfo
Delete a label from a task
@param string $task_id The ID of the task to delete the label from. (required)
@param string $label_id The ID of the label to delete. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of null, HTTP status code, HTTP response headers (array of strings) | deleteTasksIDLabelsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
protected function deleteTasksIDLabelsIDRequest($task_id, $label_id, $zap_trace_span = null)
{
// verify the required parameter 'task_id' is set
if ($task_id === null || (is_array($task_id) && count($task_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $task_id when calling deleteTasksIDLabelsID'
);
}
// verify the required parameter 'label_id' is set
if ($label_id === null || (is_array($label_id) && count($label_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $label_id when calling deleteTasksIDLabelsID'
);
}
$resourcePath = '/api/v2/tasks/{taskID}/labels/{labelID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($task_id !== null) {
$resourcePath = str_replace(
'{' . 'taskID' . '}',
ObjectSerializer::toPathValue($task_id),
$resourcePath
);
}
// path params
if ($label_id !== null) {
$resourcePath = str_replace(
'{' . 'labelID' . '}',
ObjectSerializer::toPathValue($label_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('DELETE', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'deleteTasksIDLabelsID'
@param string $task_id The ID of the task to delete the label from. (required)
@param string $label_id The ID of the label to delete. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | deleteTasksIDLabelsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function deleteTasksIDMembersID($user_id, $task_id, $zap_trace_span = null)
{
$this->deleteTasksIDMembersIDWithHttpInfo($user_id, $task_id, $zap_trace_span);
} | Operation deleteTasksIDMembersID
Remove a member from a task
@param string $user_id The ID of the member to remove. (required)
@param string $task_id The task ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return void | deleteTasksIDMembersID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function deleteTasksIDMembersIDWithHttpInfo($user_id, $task_id, $zap_trace_span = null)
{
$request = $this->deleteTasksIDMembersIDRequest($user_id, $task_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteTasksIDMembersIDWithHttpInfo
Remove a member from a task
@param string $user_id The ID of the member to remove. (required)
@param string $task_id The task ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of null, HTTP status code, HTTP response headers (array of strings) | deleteTasksIDMembersIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
protected function deleteTasksIDMembersIDRequest($user_id, $task_id, $zap_trace_span = null)
{
// verify the required parameter 'user_id' is set
if ($user_id === null || (is_array($user_id) && count($user_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $user_id when calling deleteTasksIDMembersID'
);
}
// verify the required parameter 'task_id' is set
if ($task_id === null || (is_array($task_id) && count($task_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $task_id when calling deleteTasksIDMembersID'
);
}
$resourcePath = '/api/v2/tasks/{taskID}/members/{userID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($user_id !== null) {
$resourcePath = str_replace(
'{' . 'userID' . '}',
ObjectSerializer::toPathValue($user_id),
$resourcePath
);
}
// path params
if ($task_id !== null) {
$resourcePath = str_replace(
'{' . 'taskID' . '}',
ObjectSerializer::toPathValue($task_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('DELETE', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'deleteTasksIDMembersID'
@param string $user_id The ID of the member to remove. (required)
@param string $task_id The task ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | deleteTasksIDMembersIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function deleteTasksIDOwnersID($user_id, $task_id, $zap_trace_span = null)
{
$this->deleteTasksIDOwnersIDWithHttpInfo($user_id, $task_id, $zap_trace_span);
} | Operation deleteTasksIDOwnersID
Remove an owner from a task
@param string $user_id The ID of the owner to remove. (required)
@param string $task_id The task ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return void | deleteTasksIDOwnersID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function deleteTasksIDOwnersIDWithHttpInfo($user_id, $task_id, $zap_trace_span = null)
{
$request = $this->deleteTasksIDOwnersIDRequest($user_id, $task_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteTasksIDOwnersIDWithHttpInfo
Remove an owner from a task
@param string $user_id The ID of the owner to remove. (required)
@param string $task_id The task ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of null, HTTP status code, HTTP response headers (array of strings) | deleteTasksIDOwnersIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
protected function deleteTasksIDOwnersIDRequest($user_id, $task_id, $zap_trace_span = null)
{
// verify the required parameter 'user_id' is set
if ($user_id === null || (is_array($user_id) && count($user_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $user_id when calling deleteTasksIDOwnersID'
);
}
// verify the required parameter 'task_id' is set
if ($task_id === null || (is_array($task_id) && count($task_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $task_id when calling deleteTasksIDOwnersID'
);
}
$resourcePath = '/api/v2/tasks/{taskID}/owners/{userID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($user_id !== null) {
$resourcePath = str_replace(
'{' . 'userID' . '}',
ObjectSerializer::toPathValue($user_id),
$resourcePath
);
}
// path params
if ($task_id !== null) {
$resourcePath = str_replace(
'{' . 'taskID' . '}',
ObjectSerializer::toPathValue($task_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('DELETE', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'deleteTasksIDOwnersID'
@param string $user_id The ID of the owner to remove. (required)
@param string $task_id The task ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | deleteTasksIDOwnersIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function deleteTasksIDRunsID($task_id, $run_id, $zap_trace_span = null)
{
$this->deleteTasksIDRunsIDWithHttpInfo($task_id, $run_id, $zap_trace_span);
} | Operation deleteTasksIDRunsID
Cancel a running task
@param string $task_id The ID of the task to cancel. (required)
@param string $run_id The ID of the task run to cancel. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return void | deleteTasksIDRunsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function deleteTasksIDRunsIDWithHttpInfo($task_id, $run_id, $zap_trace_span = null)
{
$request = $this->deleteTasksIDRunsIDRequest($task_id, $run_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteTasksIDRunsIDWithHttpInfo
Cancel a running task
@param string $task_id The ID of the task to cancel. (required)
@param string $run_id The ID of the task run to cancel. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of null, HTTP status code, HTTP response headers (array of strings) | deleteTasksIDRunsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
protected function deleteTasksIDRunsIDRequest($task_id, $run_id, $zap_trace_span = null)
{
// verify the required parameter 'task_id' is set
if ($task_id === null || (is_array($task_id) && count($task_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $task_id when calling deleteTasksIDRunsID'
);
}
// verify the required parameter 'run_id' is set
if ($run_id === null || (is_array($run_id) && count($run_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $run_id when calling deleteTasksIDRunsID'
);
}
$resourcePath = '/api/v2/tasks/{taskID}/runs/{runID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($task_id !== null) {
$resourcePath = str_replace(
'{' . 'taskID' . '}',
ObjectSerializer::toPathValue($task_id),
$resourcePath
);
}
// path params
if ($run_id !== null) {
$resourcePath = str_replace(
'{' . 'runID' . '}',
ObjectSerializer::toPathValue($run_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('DELETE', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'deleteTasksIDRunsID'
@param string $task_id The ID of the task to cancel. (required)
@param string $run_id The ID of the task run to cancel. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | deleteTasksIDRunsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function getTasksWithHttpInfo($zap_trace_span = null, $name = null, $after = null, $user = null, $org = null, $org_id = null, $status = null, $limit = 100, $type = null)
{
$request = $this->getTasksRequest($zap_trace_span, $name, $after, $user, $org, $org_id, $status, $limit, $type);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Tasks';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation getTasksWithHttpInfo
List tasks
@param string $zap_trace_span OpenTracing span context (optional)
@param string $name Task name. Only returns tasks with this name. Different tasks may have the same name. (optional)
@param string $after Task ID. Only returns tasks created after this task. (optional)
@param string $user User ID. Only returns tasks owned by this user. (optional)
@param string $org Organization name. Only returns tasks owned by this organization. (optional)
@param string $org_id Organization ID. Only returns tasks owned by this organization. (optional)
@param string $status Task status (`active` or `inactive`). Only returns tasks with this status. (optional)
@param 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)
@param 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)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Tasks|object|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings) | getTasksWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
protected function getTasksRequest($zap_trace_span = null, $name = null, $after = null, $user = null, $org = null, $org_id = null, $status = null, $limit = 100, $type = null)
{
if ($limit !== null && $limit > 500) {
throw new \InvalidArgumentException('invalid value for "$limit" when calling TasksService.getTasks, must be smaller than or equal to 500.');
}
if ($limit !== null && $limit < 1) {
throw new \InvalidArgumentException('invalid value for "$limit" when calling TasksService.getTasks, must be bigger than or equal to 1.');
}
$resourcePath = '/api/v2/tasks';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// query params
if ($name !== null) {
$queryParams['name'] = ObjectSerializer::toQueryValue($name);
}
// query params
if ($after !== null) {
$queryParams['after'] = ObjectSerializer::toQueryValue($after);
}
// query params
if ($user !== null) {
$queryParams['user'] = ObjectSerializer::toQueryValue($user);
}
// query params
if ($org !== null) {
$queryParams['org'] = ObjectSerializer::toQueryValue($org);
}
// query params
if ($org_id !== null) {
$queryParams['orgID'] = ObjectSerializer::toQueryValue($org_id);
}
// query params
if ($status !== null) {
$queryParams['status'] = ObjectSerializer::toQueryValue($status);
}
// query params
if ($limit !== null) {
$queryParams['limit'] = ObjectSerializer::toQueryValue($limit);
}
// query params
if ($type !== null) {
$queryParams['type'] = ObjectSerializer::toQueryValue($type);
}
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('GET', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'getTasks'
@param string $zap_trace_span OpenTracing span context (optional)
@param string $name Task name. Only returns tasks with this name. Different tasks may have the same name. (optional)
@param string $after Task ID. Only returns tasks created after this task. (optional)
@param string $user User ID. Only returns tasks owned by this user. (optional)
@param string $org Organization name. Only returns tasks owned by this organization. (optional)
@param string $org_id Organization ID. Only returns tasks owned by this organization. (optional)
@param string $status Task status (`active` or `inactive`). Only returns tasks with this status. (optional)
@param 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)
@param 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)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getTasksRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function getTasksID($task_id, $zap_trace_span = null)
{
list($response) = $this->getTasksIDWithHttpInfo($task_id, $zap_trace_span);
return $response;
} | Operation getTasksID
Retrieve a task
@param string $task_id The ID of the task to retrieve. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Task|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string | getTasksID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function getTasksIDWithHttpInfo($task_id, $zap_trace_span = null)
{
$request = $this->getTasksIDRequest($task_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Task';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation getTasksIDWithHttpInfo
Retrieve a task
@param string $task_id The ID of the task to retrieve. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Task|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings) | getTasksIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
protected function getTasksIDRequest($task_id, $zap_trace_span = null)
{
// verify the required parameter 'task_id' is set
if ($task_id === null || (is_array($task_id) && count($task_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $task_id when calling getTasksID'
);
}
$resourcePath = '/api/v2/tasks/{taskID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($task_id !== null) {
$resourcePath = str_replace(
'{' . 'taskID' . '}',
ObjectSerializer::toPathValue($task_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('GET', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'getTasksID'
@param string $task_id The ID of the task to retrieve. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getTasksIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function getTasksIDLabels($task_id, $zap_trace_span = null)
{
list($response) = $this->getTasksIDLabelsWithHttpInfo($task_id, $zap_trace_span);
return $response;
} | Operation getTasksIDLabels
List labels for a task
@param string $task_id The ID of the task to retrieve labels for. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\LabelsResponse|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string | getTasksIDLabels | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function getTasksIDLabelsWithHttpInfo($task_id, $zap_trace_span = null)
{
$request = $this->getTasksIDLabelsRequest($task_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\LabelsResponse';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation getTasksIDLabelsWithHttpInfo
List labels for a task
@param string $task_id The ID of the task to retrieve labels for. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\LabelsResponse|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings) | getTasksIDLabelsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
protected function getTasksIDLabelsRequest($task_id, $zap_trace_span = null)
{
// verify the required parameter 'task_id' is set
if ($task_id === null || (is_array($task_id) && count($task_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $task_id when calling getTasksIDLabels'
);
}
$resourcePath = '/api/v2/tasks/{taskID}/labels';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($task_id !== null) {
$resourcePath = str_replace(
'{' . 'taskID' . '}',
ObjectSerializer::toPathValue($task_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('GET', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'getTasksIDLabels'
@param string $task_id The ID of the task to retrieve labels for. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getTasksIDLabelsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function getTasksIDLogs($task_id, $zap_trace_span = null)
{
list($response) = $this->getTasksIDLogsWithHttpInfo($task_id, $zap_trace_span);
return $response;
} | Operation getTasksIDLogs
Retrieve all logs for a task
@param string $task_id The task ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Logs|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string | getTasksIDLogs | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function getTasksIDLogsWithHttpInfo($task_id, $zap_trace_span = null)
{
$request = $this->getTasksIDLogsRequest($task_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Logs';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation getTasksIDLogsWithHttpInfo
Retrieve all logs for a task
@param string $task_id The task ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Logs|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings) | getTasksIDLogsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
protected function getTasksIDLogsRequest($task_id, $zap_trace_span = null)
{
// verify the required parameter 'task_id' is set
if ($task_id === null || (is_array($task_id) && count($task_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $task_id when calling getTasksIDLogs'
);
}
$resourcePath = '/api/v2/tasks/{taskID}/logs';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($task_id !== null) {
$resourcePath = str_replace(
'{' . 'taskID' . '}',
ObjectSerializer::toPathValue($task_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('GET', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'getTasksIDLogs'
@param string $task_id The task ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getTasksIDLogsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function getTasksIDMembers($task_id, $zap_trace_span = null)
{
list($response) = $this->getTasksIDMembersWithHttpInfo($task_id, $zap_trace_span);
return $response;
} | Operation getTasksIDMembers
List all task members
@param string $task_id The task ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\ResourceMembers|\InfluxDB2\Model\Error | getTasksIDMembers | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function getTasksIDMembersWithHttpInfo($task_id, $zap_trace_span = null)
{
$request = $this->getTasksIDMembersRequest($task_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\ResourceMembers';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation getTasksIDMembersWithHttpInfo
List all task members
@param string $task_id The task ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\ResourceMembers|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getTasksIDMembersWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
protected function getTasksIDMembersRequest($task_id, $zap_trace_span = null)
{
// verify the required parameter 'task_id' is set
if ($task_id === null || (is_array($task_id) && count($task_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $task_id when calling getTasksIDMembers'
);
}
$resourcePath = '/api/v2/tasks/{taskID}/members';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($task_id !== null) {
$resourcePath = str_replace(
'{' . 'taskID' . '}',
ObjectSerializer::toPathValue($task_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('GET', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'getTasksIDMembers'
@param string $task_id The task ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getTasksIDMembersRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function getTasksIDOwners($task_id, $zap_trace_span = null)
{
list($response) = $this->getTasksIDOwnersWithHttpInfo($task_id, $zap_trace_span);
return $response;
} | Operation getTasksIDOwners
List all owners of a task
@param string $task_id The ID of the task to retrieve owners for. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\ResourceOwners|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | getTasksIDOwners | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function getTasksIDOwnersWithHttpInfo($task_id, $zap_trace_span = null)
{
$request = $this->getTasksIDOwnersRequest($task_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\ResourceOwners';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation getTasksIDOwnersWithHttpInfo
List all owners of a task
@param string $task_id The ID of the task to retrieve owners for. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\ResourceOwners|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getTasksIDOwnersWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
protected function getTasksIDOwnersRequest($task_id, $zap_trace_span = null)
{
// verify the required parameter 'task_id' is set
if ($task_id === null || (is_array($task_id) && count($task_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $task_id when calling getTasksIDOwners'
);
}
$resourcePath = '/api/v2/tasks/{taskID}/owners';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($task_id !== null) {
$resourcePath = str_replace(
'{' . 'taskID' . '}',
ObjectSerializer::toPathValue($task_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('GET', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'getTasksIDOwners'
@param string $task_id The ID of the task to retrieve owners for. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getTasksIDOwnersRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function getTasksIDRuns($task_id, $zap_trace_span = null, $after = null, $limit = 100, $after_time = null, $before_time = null)
{
list($response) = $this->getTasksIDRunsWithHttpInfo($task_id, $zap_trace_span, $after, $limit, $after_time, $before_time);
return $response;
} | Operation getTasksIDRuns
List runs for a task
@param string $task_id The ID of the task to get runs for. Only returns runs for this task. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $after A task run ID. Only returns runs created after this run. (optional)
@param int $limit Limits the number of task runs returned. Default is `100`. (optional, default to 100)
@param \DateTime $after_time A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)). Only returns runs scheduled after this time. (optional)
@param \DateTime $before_time A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)). Only returns runs scheduled before this time. (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Runs|object|\InfluxDB2\Model\Error|string | getTasksIDRuns | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function getTasksIDRunsWithHttpInfo($task_id, $zap_trace_span = null, $after = null, $limit = 100, $after_time = null, $before_time = null)
{
$request = $this->getTasksIDRunsRequest($task_id, $zap_trace_span, $after, $limit, $after_time, $before_time);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Runs';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation getTasksIDRunsWithHttpInfo
List runs for a task
@param string $task_id The ID of the task to get runs for. Only returns runs for this task. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $after A task run ID. Only returns runs created after this run. (optional)
@param int $limit Limits the number of task runs returned. Default is `100`. (optional, default to 100)
@param \DateTime $after_time A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)). Only returns runs scheduled after this time. (optional)
@param \DateTime $before_time A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)). Only returns runs scheduled before this time. (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Runs|object|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings) | getTasksIDRunsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
protected function getTasksIDRunsRequest($task_id, $zap_trace_span = null, $after = null, $limit = 100, $after_time = null, $before_time = null)
{
// verify the required parameter 'task_id' is set
if ($task_id === null || (is_array($task_id) && count($task_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $task_id when calling getTasksIDRuns'
);
}
if ($limit !== null && $limit > 500) {
throw new \InvalidArgumentException('invalid value for "$limit" when calling TasksService.getTasksIDRuns, must be smaller than or equal to 500.');
}
if ($limit !== null && $limit < 1) {
throw new \InvalidArgumentException('invalid value for "$limit" when calling TasksService.getTasksIDRuns, must be bigger than or equal to 1.');
}
$resourcePath = '/api/v2/tasks/{taskID}/runs';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// query params
if ($after !== null) {
$queryParams['after'] = ObjectSerializer::toQueryValue($after);
}
// query params
if ($limit !== null) {
$queryParams['limit'] = ObjectSerializer::toQueryValue($limit);
}
// query params
if ($after_time !== null) {
$queryParams['afterTime'] = ObjectSerializer::toQueryValue($after_time);
}
// query params
if ($before_time !== null) {
$queryParams['beforeTime'] = ObjectSerializer::toQueryValue($before_time);
}
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($task_id !== null) {
$resourcePath = str_replace(
'{' . 'taskID' . '}',
ObjectSerializer::toPathValue($task_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('GET', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'getTasksIDRuns'
@param string $task_id The ID of the task to get runs for. Only returns runs for this task. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $after A task run ID. Only returns runs created after this run. (optional)
@param int $limit Limits the number of task runs returned. Default is `100`. (optional, default to 100)
@param \DateTime $after_time A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)). Only returns runs scheduled after this time. (optional)
@param \DateTime $before_time A timestamp ([RFC3339 date/time format](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#rfc3339-timestamp)). Only returns runs scheduled before this time. (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getTasksIDRunsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function getTasksIDRunsID($task_id, $run_id, $zap_trace_span = null)
{
list($response) = $this->getTasksIDRunsIDWithHttpInfo($task_id, $run_id, $zap_trace_span);
return $response;
} | Operation getTasksIDRunsID
Retrieve a run for a task.
@param string $task_id The ID of the task to retrieve runs for. (required)
@param string $run_id The ID of the run to retrieve. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Run|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string | getTasksIDRunsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function getTasksIDRunsIDWithHttpInfo($task_id, $run_id, $zap_trace_span = null)
{
$request = $this->getTasksIDRunsIDRequest($task_id, $run_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Run';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation getTasksIDRunsIDWithHttpInfo
Retrieve a run for a task.
@param string $task_id The ID of the task to retrieve runs for. (required)
@param string $run_id The ID of the run to retrieve. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Run|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings) | getTasksIDRunsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
protected function getTasksIDRunsIDRequest($task_id, $run_id, $zap_trace_span = null)
{
// verify the required parameter 'task_id' is set
if ($task_id === null || (is_array($task_id) && count($task_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $task_id when calling getTasksIDRunsID'
);
}
// verify the required parameter 'run_id' is set
if ($run_id === null || (is_array($run_id) && count($run_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $run_id when calling getTasksIDRunsID'
);
}
$resourcePath = '/api/v2/tasks/{taskID}/runs/{runID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($task_id !== null) {
$resourcePath = str_replace(
'{' . 'taskID' . '}',
ObjectSerializer::toPathValue($task_id),
$resourcePath
);
}
// path params
if ($run_id !== null) {
$resourcePath = str_replace(
'{' . 'runID' . '}',
ObjectSerializer::toPathValue($run_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('GET', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'getTasksIDRunsID'
@param string $task_id The ID of the task to retrieve runs for. (required)
@param string $run_id The ID of the run to retrieve. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getTasksIDRunsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function getTasksIDRunsIDLogs($task_id, $run_id, $zap_trace_span = null)
{
list($response) = $this->getTasksIDRunsIDLogsWithHttpInfo($task_id, $run_id, $zap_trace_span);
return $response;
} | Operation getTasksIDRunsIDLogs
Retrieve all logs for a run
@param string $task_id The ID of the task to get logs for. (required)
@param string $run_id The ID of the run to get logs for. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Logs|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string | getTasksIDRunsIDLogs | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function getTasksIDRunsIDLogsWithHttpInfo($task_id, $run_id, $zap_trace_span = null)
{
$request = $this->getTasksIDRunsIDLogsRequest($task_id, $run_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Logs';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation getTasksIDRunsIDLogsWithHttpInfo
Retrieve all logs for a run
@param string $task_id The ID of the task to get logs for. (required)
@param string $run_id The ID of the run to get logs for. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Logs|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings) | getTasksIDRunsIDLogsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
protected function getTasksIDRunsIDLogsRequest($task_id, $run_id, $zap_trace_span = null)
{
// verify the required parameter 'task_id' is set
if ($task_id === null || (is_array($task_id) && count($task_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $task_id when calling getTasksIDRunsIDLogs'
);
}
// verify the required parameter 'run_id' is set
if ($run_id === null || (is_array($run_id) && count($run_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $run_id when calling getTasksIDRunsIDLogs'
);
}
$resourcePath = '/api/v2/tasks/{taskID}/runs/{runID}/logs';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($task_id !== null) {
$resourcePath = str_replace(
'{' . 'taskID' . '}',
ObjectSerializer::toPathValue($task_id),
$resourcePath
);
}
// path params
if ($run_id !== null) {
$resourcePath = str_replace(
'{' . 'runID' . '}',
ObjectSerializer::toPathValue($run_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('GET', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'getTasksIDRunsIDLogs'
@param string $task_id The ID of the task to get logs for. (required)
@param string $run_id The ID of the run to get logs for. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getTasksIDRunsIDLogsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function patchTasksID($task_id, $task_update_request, $zap_trace_span = null)
{
list($response) = $this->patchTasksIDWithHttpInfo($task_id, $task_update_request, $zap_trace_span);
return $response;
} | Operation patchTasksID
Update a task
@param string $task_id The ID of the task to update. (required)
@param \InfluxDB2\Model\TaskUpdateRequest $task_update_request An object that contains updated task properties to apply. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Task|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string | patchTasksID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function patchTasksIDWithHttpInfo($task_id, $task_update_request, $zap_trace_span = null)
{
$request = $this->patchTasksIDRequest($task_id, $task_update_request, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Task';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation patchTasksIDWithHttpInfo
Update a task
@param string $task_id The ID of the task to update. (required)
@param \InfluxDB2\Model\TaskUpdateRequest $task_update_request An object that contains updated task properties to apply. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Task|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings) | patchTasksIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
protected function patchTasksIDRequest($task_id, $task_update_request, $zap_trace_span = null)
{
// verify the required parameter 'task_id' is set
if ($task_id === null || (is_array($task_id) && count($task_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $task_id when calling patchTasksID'
);
}
// verify the required parameter 'task_update_request' is set
if ($task_update_request === null || (is_array($task_update_request) && count($task_update_request) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $task_update_request when calling patchTasksID'
);
}
$resourcePath = '/api/v2/tasks/{taskID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($task_id !== null) {
$resourcePath = str_replace(
'{' . 'taskID' . '}',
ObjectSerializer::toPathValue($task_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($task_update_request)) {
$_tempBody = $task_update_request;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('PATCH', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'patchTasksID'
@param string $task_id The ID of the task to update. (required)
@param \InfluxDB2\Model\TaskUpdateRequest $task_update_request An object that contains updated task properties to apply. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | patchTasksIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function postTasks($task_create_request, $zap_trace_span = null)
{
list($response) = $this->postTasksWithHttpInfo($task_create_request, $zap_trace_span);
return $response;
} | Operation postTasks
Create a task
@param \InfluxDB2\Model\TaskCreateRequest $task_create_request The task to create. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Task|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | postTasks | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function postTasksWithHttpInfo($task_create_request, $zap_trace_span = null)
{
$request = $this->postTasksRequest($task_create_request, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Task';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation postTasksWithHttpInfo
Create a task
@param \InfluxDB2\Model\TaskCreateRequest $task_create_request The task to create. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Task|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | postTasksWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
protected function postTasksRequest($task_create_request, $zap_trace_span = null)
{
// verify the required parameter 'task_create_request' is set
if ($task_create_request === null || (is_array($task_create_request) && count($task_create_request) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $task_create_request when calling postTasks'
);
}
$resourcePath = '/api/v2/tasks';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// body params
$_tempBody = null;
if (isset($task_create_request)) {
$_tempBody = $task_create_request;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('POST', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'postTasks'
@param \InfluxDB2\Model\TaskCreateRequest $task_create_request The task to create. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | postTasksRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function postTasksIDLabels($task_id, $label_mapping, $zap_trace_span = null)
{
list($response) = $this->postTasksIDLabelsWithHttpInfo($task_id, $label_mapping, $zap_trace_span);
return $response;
} | Operation postTasksIDLabels
Add a label to a task
@param string $task_id The ID of the task to label. (required)
@param \InfluxDB2\Model\LabelMapping $label_mapping An object that contains a _`labelID`_ to add to the task. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\LabelResponse|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string | postTasksIDLabels | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function postTasksIDLabelsWithHttpInfo($task_id, $label_mapping, $zap_trace_span = null)
{
$request = $this->postTasksIDLabelsRequest($task_id, $label_mapping, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\LabelResponse';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation postTasksIDLabelsWithHttpInfo
Add a label to a task
@param string $task_id The ID of the task to label. (required)
@param \InfluxDB2\Model\LabelMapping $label_mapping An object that contains a _`labelID`_ to add to the task. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\LabelResponse|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings) | postTasksIDLabelsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
protected function postTasksIDLabelsRequest($task_id, $label_mapping, $zap_trace_span = null)
{
// verify the required parameter 'task_id' is set
if ($task_id === null || (is_array($task_id) && count($task_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $task_id when calling postTasksIDLabels'
);
}
// verify the required parameter 'label_mapping' is set
if ($label_mapping === null || (is_array($label_mapping) && count($label_mapping) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $label_mapping when calling postTasksIDLabels'
);
}
$resourcePath = '/api/v2/tasks/{taskID}/labels';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($task_id !== null) {
$resourcePath = str_replace(
'{' . 'taskID' . '}',
ObjectSerializer::toPathValue($task_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($label_mapping)) {
$_tempBody = $label_mapping;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('POST', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'postTasksIDLabels'
@param string $task_id The ID of the task to label. (required)
@param \InfluxDB2\Model\LabelMapping $label_mapping An object that contains a _`labelID`_ to add to the task. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | postTasksIDLabelsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function postTasksIDMembers($task_id, $add_resource_member_request_body, $zap_trace_span = null)
{
list($response) = $this->postTasksIDMembersWithHttpInfo($task_id, $add_resource_member_request_body, $zap_trace_span);
return $response;
} | Operation postTasksIDMembers
Add a member to a task
@param string $task_id The task ID. (required)
@param \InfluxDB2\Model\AddResourceMemberRequestBody $add_resource_member_request_body A user to add as a member of the task. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\ResourceMember|\InfluxDB2\Model\Error | postTasksIDMembers | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function postTasksIDMembersWithHttpInfo($task_id, $add_resource_member_request_body, $zap_trace_span = null)
{
$request = $this->postTasksIDMembersRequest($task_id, $add_resource_member_request_body, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\ResourceMember';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation postTasksIDMembersWithHttpInfo
Add a member to a task
@param string $task_id The task ID. (required)
@param \InfluxDB2\Model\AddResourceMemberRequestBody $add_resource_member_request_body A user to add as a member of the task. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\ResourceMember|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | postTasksIDMembersWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
protected function postTasksIDMembersRequest($task_id, $add_resource_member_request_body, $zap_trace_span = null)
{
// verify the required parameter 'task_id' is set
if ($task_id === null || (is_array($task_id) && count($task_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $task_id when calling postTasksIDMembers'
);
}
// verify the required parameter 'add_resource_member_request_body' is set
if ($add_resource_member_request_body === null || (is_array($add_resource_member_request_body) && count($add_resource_member_request_body) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $add_resource_member_request_body when calling postTasksIDMembers'
);
}
$resourcePath = '/api/v2/tasks/{taskID}/members';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($task_id !== null) {
$resourcePath = str_replace(
'{' . 'taskID' . '}',
ObjectSerializer::toPathValue($task_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($add_resource_member_request_body)) {
$_tempBody = $add_resource_member_request_body;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('POST', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'postTasksIDMembers'
@param string $task_id The task ID. (required)
@param \InfluxDB2\Model\AddResourceMemberRequestBody $add_resource_member_request_body A user to add as a member of the task. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | postTasksIDMembersRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function postTasksIDOwners($task_id, $add_resource_member_request_body, $zap_trace_span = null)
{
list($response) = $this->postTasksIDOwnersWithHttpInfo($task_id, $add_resource_member_request_body, $zap_trace_span);
return $response;
} | Operation postTasksIDOwners
Add an owner for a task
@param string $task_id The task ID. (required)
@param \InfluxDB2\Model\AddResourceMemberRequestBody $add_resource_member_request_body A user to add as an owner of the task. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\ResourceOwner|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | postTasksIDOwners | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function postTasksIDOwnersWithHttpInfo($task_id, $add_resource_member_request_body, $zap_trace_span = null)
{
$request = $this->postTasksIDOwnersRequest($task_id, $add_resource_member_request_body, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\ResourceOwner';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation postTasksIDOwnersWithHttpInfo
Add an owner for a task
@param string $task_id The task ID. (required)
@param \InfluxDB2\Model\AddResourceMemberRequestBody $add_resource_member_request_body A user to add as an owner of the task. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\ResourceOwner|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | postTasksIDOwnersWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
protected function postTasksIDOwnersRequest($task_id, $add_resource_member_request_body, $zap_trace_span = null)
{
// verify the required parameter 'task_id' is set
if ($task_id === null || (is_array($task_id) && count($task_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $task_id when calling postTasksIDOwners'
);
}
// verify the required parameter 'add_resource_member_request_body' is set
if ($add_resource_member_request_body === null || (is_array($add_resource_member_request_body) && count($add_resource_member_request_body) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $add_resource_member_request_body when calling postTasksIDOwners'
);
}
$resourcePath = '/api/v2/tasks/{taskID}/owners';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($task_id !== null) {
$resourcePath = str_replace(
'{' . 'taskID' . '}',
ObjectSerializer::toPathValue($task_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($add_resource_member_request_body)) {
$_tempBody = $add_resource_member_request_body;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('POST', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'postTasksIDOwners'
@param string $task_id The task ID. (required)
@param \InfluxDB2\Model\AddResourceMemberRequestBody $add_resource_member_request_body A user to add as an owner of the task. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | postTasksIDOwnersRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function postTasksIDRuns($task_id, $zap_trace_span = null, $run_manually = null)
{
list($response) = $this->postTasksIDRunsWithHttpInfo($task_id, $zap_trace_span, $run_manually);
return $response;
} | Operation postTasksIDRuns
Start a task run, overriding the schedule
@param string $task_id task_id (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param \InfluxDB2\Model\RunManually $run_manually run_manually (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Run|object|\InfluxDB2\Model\Error|string | postTasksIDRuns | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function postTasksIDRunsWithHttpInfo($task_id, $zap_trace_span = null, $run_manually = null)
{
$request = $this->postTasksIDRunsRequest($task_id, $zap_trace_span, $run_manually);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Run';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation postTasksIDRunsWithHttpInfo
Start a task run, overriding the schedule
@param string $task_id (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param \InfluxDB2\Model\RunManually $run_manually (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Run|object|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings) | postTasksIDRunsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
protected function postTasksIDRunsRequest($task_id, $zap_trace_span = null, $run_manually = null)
{
// verify the required parameter 'task_id' is set
if ($task_id === null || (is_array($task_id) && count($task_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $task_id when calling postTasksIDRuns'
);
}
$resourcePath = '/api/v2/tasks/{taskID}/runs';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($task_id !== null) {
$resourcePath = str_replace(
'{' . 'taskID' . '}',
ObjectSerializer::toPathValue($task_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($run_manually)) {
$_tempBody = $run_manually;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('POST', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'postTasksIDRuns'
@param string $task_id (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param \InfluxDB2\Model\RunManually $run_manually (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | postTasksIDRunsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function postTasksIDRunsIDRetry($task_id, $run_id, $zap_trace_span = null, $body = null)
{
list($response) = $this->postTasksIDRunsIDRetryWithHttpInfo($task_id, $run_id, $zap_trace_span, $body);
return $response;
} | Operation postTasksIDRunsIDRetry
Retry a task run
@param string $task_id The ID of the task to retry. (required)
@param string $run_id The ID of the task run to retry. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $body body (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Run|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string | postTasksIDRunsIDRetry | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function postTasksIDRunsIDRetryWithHttpInfo($task_id, $run_id, $zap_trace_span = null, $body = null)
{
$request = $this->postTasksIDRunsIDRetryRequest($task_id, $run_id, $zap_trace_span, $body);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Run';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation postTasksIDRunsIDRetryWithHttpInfo
Retry a task run
@param string $task_id The ID of the task to retry. (required)
@param string $run_id The ID of the task run to retry. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $body (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Run|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings) | postTasksIDRunsIDRetryWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
protected function postTasksIDRunsIDRetryRequest($task_id, $run_id, $zap_trace_span = null, $body = null)
{
// verify the required parameter 'task_id' is set
if ($task_id === null || (is_array($task_id) && count($task_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $task_id when calling postTasksIDRunsIDRetry'
);
}
// verify the required parameter 'run_id' is set
if ($run_id === null || (is_array($run_id) && count($run_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $run_id when calling postTasksIDRunsIDRetry'
);
}
$resourcePath = '/api/v2/tasks/{taskID}/runs/{runID}/retry';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($task_id !== null) {
$resourcePath = str_replace(
'{' . 'taskID' . '}',
ObjectSerializer::toPathValue($task_id),
$resourcePath
);
}
// path params
if ($run_id !== null) {
$resourcePath = str_replace(
'{' . 'runID' . '}',
ObjectSerializer::toPathValue($run_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($body)) {
$_tempBody = $body;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json; charset=utf-8']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('POST', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'postTasksIDRunsIDRetry'
@param string $task_id The ID of the task to retry. (required)
@param string $run_id The ID of the task run to retry. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $body (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | postTasksIDRunsIDRetryRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TasksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TasksService.php | MIT |
public function deleteDBRPID($dbrp_id, $zap_trace_span = null, $org_id = null, $org = null)
{
$this->deleteDBRPIDWithHttpInfo($dbrp_id, $zap_trace_span, $org_id, $org);
} | Operation deleteDBRPID
Delete a database retention policy
@param string $dbrp_id The database retention policy mapping (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $org_id Specifies the organization ID of the mapping (optional)
@param string $org Specifies the organization name of the mapping (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return void | deleteDBRPID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DBRPsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DBRPsService.php | MIT |
public function deleteDBRPIDWithHttpInfo($dbrp_id, $zap_trace_span = null, $org_id = null, $org = null)
{
$request = $this->deleteDBRPIDRequest($dbrp_id, $zap_trace_span, $org_id, $org);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteDBRPIDWithHttpInfo
Delete a database retention policy
@param string $dbrp_id The database retention policy mapping (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $org_id Specifies the organization ID of the mapping (optional)
@param string $org Specifies the organization name of the mapping (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of null, HTTP status code, HTTP response headers (array of strings) | deleteDBRPIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DBRPsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DBRPsService.php | MIT |
protected function deleteDBRPIDRequest($dbrp_id, $zap_trace_span = null, $org_id = null, $org = null)
{
// verify the required parameter 'dbrp_id' is set
if ($dbrp_id === null || (is_array($dbrp_id) && count($dbrp_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dbrp_id when calling deleteDBRPID'
);
}
$resourcePath = '/api/v2/dbrps/{dbrpID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// query params
if ($org_id !== null) {
$queryParams['orgID'] = ObjectSerializer::toQueryValue($org_id);
}
// query params
if ($org !== null) {
$queryParams['org'] = ObjectSerializer::toQueryValue($org);
}
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($dbrp_id !== null) {
$resourcePath = str_replace(
'{' . 'dbrpID' . '}',
ObjectSerializer::toPathValue($dbrp_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('DELETE', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'deleteDBRPID'
@param string $dbrp_id The database retention policy mapping (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $org_id Specifies the organization ID of the mapping (optional)
@param string $org Specifies the organization name of the mapping (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | deleteDBRPIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DBRPsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DBRPsService.php | MIT |
public function getDBRPs($zap_trace_span = null, $org_id = null, $org = null, $id = null, $bucket_id = null, $default = null, $db = null, $rp = null)
{
list($response) = $this->getDBRPsWithHttpInfo($zap_trace_span, $org_id, $org, $id, $bucket_id, $default, $db, $rp);
return $response;
} | Operation getDBRPs
List database retention policy mappings
@param string $zap_trace_span OpenTracing span context (optional)
@param string $org_id Specifies the organization ID to filter on (optional)
@param string $org Specifies the organization name to filter on (optional)
@param string $id Specifies the mapping ID to filter on (optional)
@param string $bucket_id Specifies the bucket ID to filter on (optional)
@param bool $default Specifies filtering on default (optional)
@param string $db Specifies the database to filter on (optional)
@param string $rp Specifies the retention policy to filter on (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\DBRPs|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | getDBRPs | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DBRPsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DBRPsService.php | MIT |
public function getDBRPsWithHttpInfo($zap_trace_span = null, $org_id = null, $org = null, $id = null, $bucket_id = null, $default = null, $db = null, $rp = null)
{
$request = $this->getDBRPsRequest($zap_trace_span, $org_id, $org, $id, $bucket_id, $default, $db, $rp);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\DBRPs';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation getDBRPsWithHttpInfo
List database retention policy mappings
@param string $zap_trace_span OpenTracing span context (optional)
@param string $org_id Specifies the organization ID to filter on (optional)
@param string $org Specifies the organization name to filter on (optional)
@param string $id Specifies the mapping ID to filter on (optional)
@param string $bucket_id Specifies the bucket ID to filter on (optional)
@param bool $default Specifies filtering on default (optional)
@param string $db Specifies the database to filter on (optional)
@param string $rp Specifies the retention policy to filter on (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\DBRPs|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getDBRPsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DBRPsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DBRPsService.php | MIT |
protected function getDBRPsRequest($zap_trace_span = null, $org_id = null, $org = null, $id = null, $bucket_id = null, $default = null, $db = null, $rp = null)
{
$resourcePath = '/api/v2/dbrps';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// query params
if ($org_id !== null) {
$queryParams['orgID'] = ObjectSerializer::toQueryValue($org_id);
}
// query params
if ($org !== null) {
$queryParams['org'] = ObjectSerializer::toQueryValue($org);
}
// query params
if ($id !== null) {
$queryParams['id'] = ObjectSerializer::toQueryValue($id);
}
// query params
if ($bucket_id !== null) {
$queryParams['bucketID'] = ObjectSerializer::toQueryValue($bucket_id);
}
// query params
if ($default !== null) {
$queryParams['default'] = ObjectSerializer::toQueryValue($default);
}
// query params
if ($db !== null) {
$queryParams['db'] = ObjectSerializer::toQueryValue($db);
}
// query params
if ($rp !== null) {
$queryParams['rp'] = ObjectSerializer::toQueryValue($rp);
}
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('GET', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'getDBRPs'
@param string $zap_trace_span OpenTracing span context (optional)
@param string $org_id Specifies the organization ID to filter on (optional)
@param string $org Specifies the organization name to filter on (optional)
@param string $id Specifies the mapping ID to filter on (optional)
@param string $bucket_id Specifies the bucket ID to filter on (optional)
@param bool $default Specifies filtering on default (optional)
@param string $db Specifies the database to filter on (optional)
@param string $rp Specifies the retention policy to filter on (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getDBRPsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DBRPsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DBRPsService.php | MIT |
public function getDBRPsID($dbrp_id, $zap_trace_span = null, $org_id = null, $org = null)
{
list($response) = $this->getDBRPsIDWithHttpInfo($dbrp_id, $zap_trace_span, $org_id, $org);
return $response;
} | Operation getDBRPsID
Retrieve a database retention policy mapping
@param string $dbrp_id The database retention policy mapping ID (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $org_id Specifies the organization ID of the mapping (optional)
@param string $org Specifies the organization name of the mapping (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\DBRPGet|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | getDBRPsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DBRPsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DBRPsService.php | MIT |
public function getDBRPsIDWithHttpInfo($dbrp_id, $zap_trace_span = null, $org_id = null, $org = null)
{
$request = $this->getDBRPsIDRequest($dbrp_id, $zap_trace_span, $org_id, $org);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\DBRPGet';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation getDBRPsIDWithHttpInfo
Retrieve a database retention policy mapping
@param string $dbrp_id The database retention policy mapping ID (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $org_id Specifies the organization ID of the mapping (optional)
@param string $org Specifies the organization name of the mapping (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\DBRPGet|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getDBRPsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DBRPsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DBRPsService.php | MIT |
protected function getDBRPsIDRequest($dbrp_id, $zap_trace_span = null, $org_id = null, $org = null)
{
// verify the required parameter 'dbrp_id' is set
if ($dbrp_id === null || (is_array($dbrp_id) && count($dbrp_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dbrp_id when calling getDBRPsID'
);
}
$resourcePath = '/api/v2/dbrps/{dbrpID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// query params
if ($org_id !== null) {
$queryParams['orgID'] = ObjectSerializer::toQueryValue($org_id);
}
// query params
if ($org !== null) {
$queryParams['org'] = ObjectSerializer::toQueryValue($org);
}
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($dbrp_id !== null) {
$resourcePath = str_replace(
'{' . 'dbrpID' . '}',
ObjectSerializer::toPathValue($dbrp_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('GET', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'getDBRPsID'
@param string $dbrp_id The database retention policy mapping ID (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $org_id Specifies the organization ID of the mapping (optional)
@param string $org Specifies the organization name of the mapping (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getDBRPsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DBRPsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DBRPsService.php | MIT |
public function patchDBRPID($dbrp_id, $dbrp_update, $zap_trace_span = null, $org_id = null, $org = null)
{
list($response) = $this->patchDBRPIDWithHttpInfo($dbrp_id, $dbrp_update, $zap_trace_span, $org_id, $org);
return $response;
} | Operation patchDBRPID
Update a database retention policy mapping
@param string $dbrp_id The database retention policy mapping. (required)
@param \InfluxDB2\Model\DBRPUpdate $dbrp_update Database retention policy update to apply (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $org_id Specifies the organization ID of the mapping (optional)
@param string $org Specifies the organization name of the mapping (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\DBRPGet|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | patchDBRPID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DBRPsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DBRPsService.php | MIT |
public function patchDBRPIDWithHttpInfo($dbrp_id, $dbrp_update, $zap_trace_span = null, $org_id = null, $org = null)
{
$request = $this->patchDBRPIDRequest($dbrp_id, $dbrp_update, $zap_trace_span, $org_id, $org);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\DBRPGet';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation patchDBRPIDWithHttpInfo
Update a database retention policy mapping
@param string $dbrp_id The database retention policy mapping. (required)
@param \InfluxDB2\Model\DBRPUpdate $dbrp_update Database retention policy update to apply (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $org_id Specifies the organization ID of the mapping (optional)
@param string $org Specifies the organization name of the mapping (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\DBRPGet|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | patchDBRPIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DBRPsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DBRPsService.php | MIT |
protected function patchDBRPIDRequest($dbrp_id, $dbrp_update, $zap_trace_span = null, $org_id = null, $org = null)
{
// verify the required parameter 'dbrp_id' is set
if ($dbrp_id === null || (is_array($dbrp_id) && count($dbrp_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dbrp_id when calling patchDBRPID'
);
}
// verify the required parameter 'dbrp_update' is set
if ($dbrp_update === null || (is_array($dbrp_update) && count($dbrp_update) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dbrp_update when calling patchDBRPID'
);
}
$resourcePath = '/api/v2/dbrps/{dbrpID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// query params
if ($org_id !== null) {
$queryParams['orgID'] = ObjectSerializer::toQueryValue($org_id);
}
// query params
if ($org !== null) {
$queryParams['org'] = ObjectSerializer::toQueryValue($org);
}
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($dbrp_id !== null) {
$resourcePath = str_replace(
'{' . 'dbrpID' . '}',
ObjectSerializer::toPathValue($dbrp_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($dbrp_update)) {
$_tempBody = $dbrp_update;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('PATCH', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'patchDBRPID'
@param string $dbrp_id The database retention policy mapping. (required)
@param \InfluxDB2\Model\DBRPUpdate $dbrp_update Database retention policy update to apply (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $org_id Specifies the organization ID of the mapping (optional)
@param string $org Specifies the organization name of the mapping (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | patchDBRPIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DBRPsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DBRPsService.php | MIT |
public function postDBRP($dbrp_create, $zap_trace_span = null)
{
list($response) = $this->postDBRPWithHttpInfo($dbrp_create, $zap_trace_span);
return $response;
} | Operation postDBRP
Add a database retention policy mapping
@param \InfluxDB2\Model\DBRPCreate $dbrp_create The database retention policy mapping to add (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\DBRP|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | postDBRP | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DBRPsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DBRPsService.php | MIT |
public function postDBRPWithHttpInfo($dbrp_create, $zap_trace_span = null)
{
$request = $this->postDBRPRequest($dbrp_create, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\DBRP';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation postDBRPWithHttpInfo
Add a database retention policy mapping
@param \InfluxDB2\Model\DBRPCreate $dbrp_create The database retention policy mapping to add (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\DBRP|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | postDBRPWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DBRPsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DBRPsService.php | MIT |
protected function postDBRPRequest($dbrp_create, $zap_trace_span = null)
{
// verify the required parameter 'dbrp_create' is set
if ($dbrp_create === null || (is_array($dbrp_create) && count($dbrp_create) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dbrp_create when calling postDBRP'
);
}
$resourcePath = '/api/v2/dbrps';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// body params
$_tempBody = null;
if (isset($dbrp_create)) {
$_tempBody = $dbrp_create;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('POST', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'postDBRP'
@param \InfluxDB2\Model\DBRPCreate $dbrp_create The database retention policy mapping to add (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | postDBRPRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DBRPsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DBRPsService.php | MIT |
public function deleteDashboardsIDCellsID($dashboard_id, $cell_id, $zap_trace_span = null)
{
$this->deleteDashboardsIDCellsIDWithHttpInfo($dashboard_id, $cell_id, $zap_trace_span);
} | Operation deleteDashboardsIDCellsID
Delete a dashboard cell
@param string $dashboard_id The ID of the dashboard to delete. (required)
@param string $cell_id The ID of the cell to delete. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return void | deleteDashboardsIDCellsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/CellsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/CellsService.php | MIT |
public function deleteDashboardsIDCellsIDWithHttpInfo($dashboard_id, $cell_id, $zap_trace_span = null)
{
$request = $this->deleteDashboardsIDCellsIDRequest($dashboard_id, $cell_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteDashboardsIDCellsIDWithHttpInfo
Delete a dashboard cell
@param string $dashboard_id The ID of the dashboard to delete. (required)
@param string $cell_id The ID of the cell to delete. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of null, HTTP status code, HTTP response headers (array of strings) | deleteDashboardsIDCellsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/CellsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/CellsService.php | MIT |
protected function deleteDashboardsIDCellsIDRequest($dashboard_id, $cell_id, $zap_trace_span = null)
{
// verify the required parameter 'dashboard_id' is set
if ($dashboard_id === null || (is_array($dashboard_id) && count($dashboard_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dashboard_id when calling deleteDashboardsIDCellsID'
);
}
// verify the required parameter 'cell_id' is set
if ($cell_id === null || (is_array($cell_id) && count($cell_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $cell_id when calling deleteDashboardsIDCellsID'
);
}
$resourcePath = '/api/v2/dashboards/{dashboardID}/cells/{cellID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($dashboard_id !== null) {
$resourcePath = str_replace(
'{' . 'dashboardID' . '}',
ObjectSerializer::toPathValue($dashboard_id),
$resourcePath
);
}
// path params
if ($cell_id !== null) {
$resourcePath = str_replace(
'{' . 'cellID' . '}',
ObjectSerializer::toPathValue($cell_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('DELETE', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'deleteDashboardsIDCellsID'
@param string $dashboard_id The ID of the dashboard to delete. (required)
@param string $cell_id The ID of the cell to delete. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | deleteDashboardsIDCellsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/CellsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/CellsService.php | MIT |
public function getDashboardsIDCellsIDView($dashboard_id, $cell_id, $zap_trace_span = null)
{
list($response) = $this->getDashboardsIDCellsIDViewWithHttpInfo($dashboard_id, $cell_id, $zap_trace_span);
return $response;
} | Operation getDashboardsIDCellsIDView
Retrieve the view for a cell
@param string $dashboard_id The dashboard ID. (required)
@param string $cell_id The cell ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\View|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | getDashboardsIDCellsIDView | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/CellsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/CellsService.php | MIT |
public function getDashboardsIDCellsIDViewWithHttpInfo($dashboard_id, $cell_id, $zap_trace_span = null)
{
$request = $this->getDashboardsIDCellsIDViewRequest($dashboard_id, $cell_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\View';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation getDashboardsIDCellsIDViewWithHttpInfo
Retrieve the view for a cell
@param string $dashboard_id The dashboard ID. (required)
@param string $cell_id The cell ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\View|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getDashboardsIDCellsIDViewWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/CellsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/CellsService.php | MIT |
protected function getDashboardsIDCellsIDViewRequest($dashboard_id, $cell_id, $zap_trace_span = null)
{
// verify the required parameter 'dashboard_id' is set
if ($dashboard_id === null || (is_array($dashboard_id) && count($dashboard_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dashboard_id when calling getDashboardsIDCellsIDView'
);
}
// verify the required parameter 'cell_id' is set
if ($cell_id === null || (is_array($cell_id) && count($cell_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $cell_id when calling getDashboardsIDCellsIDView'
);
}
$resourcePath = '/api/v2/dashboards/{dashboardID}/cells/{cellID}/view';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($dashboard_id !== null) {
$resourcePath = str_replace(
'{' . 'dashboardID' . '}',
ObjectSerializer::toPathValue($dashboard_id),
$resourcePath
);
}
// path params
if ($cell_id !== null) {
$resourcePath = str_replace(
'{' . 'cellID' . '}',
ObjectSerializer::toPathValue($cell_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('GET', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'getDashboardsIDCellsIDView'
@param string $dashboard_id The dashboard ID. (required)
@param string $cell_id The cell ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getDashboardsIDCellsIDViewRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/CellsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/CellsService.php | MIT |
public function patchDashboardsIDCellsID($dashboard_id, $cell_id, $cell_update, $zap_trace_span = null)
{
list($response) = $this->patchDashboardsIDCellsIDWithHttpInfo($dashboard_id, $cell_id, $cell_update, $zap_trace_span);
return $response;
} | Operation patchDashboardsIDCellsID
Update the non-positional information related to a cell
@param string $dashboard_id The ID of the dashboard to update. (required)
@param string $cell_id The ID of the cell to update. (required)
@param \InfluxDB2\Model\CellUpdate $cell_update cell_update (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Cell|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | patchDashboardsIDCellsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/CellsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/CellsService.php | MIT |
public function patchDashboardsIDCellsIDWithHttpInfo($dashboard_id, $cell_id, $cell_update, $zap_trace_span = null)
{
$request = $this->patchDashboardsIDCellsIDRequest($dashboard_id, $cell_id, $cell_update, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Cell';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation patchDashboardsIDCellsIDWithHttpInfo
Update the non-positional information related to a cell
@param string $dashboard_id The ID of the dashboard to update. (required)
@param string $cell_id The ID of the cell to update. (required)
@param \InfluxDB2\Model\CellUpdate $cell_update (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Cell|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | patchDashboardsIDCellsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/CellsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/CellsService.php | MIT |
protected function patchDashboardsIDCellsIDRequest($dashboard_id, $cell_id, $cell_update, $zap_trace_span = null)
{
// verify the required parameter 'dashboard_id' is set
if ($dashboard_id === null || (is_array($dashboard_id) && count($dashboard_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dashboard_id when calling patchDashboardsIDCellsID'
);
}
// verify the required parameter 'cell_id' is set
if ($cell_id === null || (is_array($cell_id) && count($cell_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $cell_id when calling patchDashboardsIDCellsID'
);
}
// verify the required parameter 'cell_update' is set
if ($cell_update === null || (is_array($cell_update) && count($cell_update) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $cell_update when calling patchDashboardsIDCellsID'
);
}
$resourcePath = '/api/v2/dashboards/{dashboardID}/cells/{cellID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($dashboard_id !== null) {
$resourcePath = str_replace(
'{' . 'dashboardID' . '}',
ObjectSerializer::toPathValue($dashboard_id),
$resourcePath
);
}
// path params
if ($cell_id !== null) {
$resourcePath = str_replace(
'{' . 'cellID' . '}',
ObjectSerializer::toPathValue($cell_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($cell_update)) {
$_tempBody = $cell_update;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('PATCH', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'patchDashboardsIDCellsID'
@param string $dashboard_id The ID of the dashboard to update. (required)
@param string $cell_id The ID of the cell to update. (required)
@param \InfluxDB2\Model\CellUpdate $cell_update (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | patchDashboardsIDCellsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/CellsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/CellsService.php | MIT |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.