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 deleteChecksIDWithHttpInfo($check_id, $zap_trace_span = null)
{
$request = $this->deleteChecksIDRequest($check_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteChecksIDWithHttpInfo
Delete a check
@param string $check_id The check 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) | deleteChecksIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
protected function deleteChecksIDRequest($check_id, $zap_trace_span = null)
{
// verify the required parameter 'check_id' is set
if ($check_id === null || (is_array($check_id) && count($check_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $check_id when calling deleteChecksID'
);
}
$resourcePath = '/api/v2/checks/{checkID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($check_id !== null) {
$resourcePath = str_replace(
'{' . 'checkID' . '}',
ObjectSerializer::toPathValue($check_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 'deleteChecksID'
@param string $check_id The check ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | deleteChecksIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
public function deleteChecksIDLabelsID($check_id, $label_id, $zap_trace_span = null)
{
$this->deleteChecksIDLabelsIDWithHttpInfo($check_id, $label_id, $zap_trace_span);
} | Operation deleteChecksIDLabelsID
Delete label from a check
@param string $check_id The check ID. (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 | deleteChecksIDLabelsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
public function deleteChecksIDLabelsIDWithHttpInfo($check_id, $label_id, $zap_trace_span = null)
{
$request = $this->deleteChecksIDLabelsIDRequest($check_id, $label_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteChecksIDLabelsIDWithHttpInfo
Delete label from a check
@param string $check_id The check ID. (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) | deleteChecksIDLabelsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
protected function deleteChecksIDLabelsIDRequest($check_id, $label_id, $zap_trace_span = null)
{
// verify the required parameter 'check_id' is set
if ($check_id === null || (is_array($check_id) && count($check_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $check_id when calling deleteChecksIDLabelsID'
);
}
// 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 deleteChecksIDLabelsID'
);
}
$resourcePath = '/api/v2/checks/{checkID}/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 ($check_id !== null) {
$resourcePath = str_replace(
'{' . 'checkID' . '}',
ObjectSerializer::toPathValue($check_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 'deleteChecksIDLabelsID'
@param string $check_id The check ID. (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 | deleteChecksIDLabelsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
public function getChecks($org_id, $zap_trace_span = null, $offset = null, $limit = 20)
{
list($response) = $this->getChecksWithHttpInfo($org_id, $zap_trace_span, $offset, $limit);
return $response;
} | Operation getChecks
List all checks
@param string $org_id Only show checks that belong to a specific organization ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param int $offset The offset for pagination. The number of records to skip. (optional)
@param int $limit Limits the number of records returned. Default is `20`. (optional, default to 20)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Checks|\InfluxDB2\Model\Error | getChecks | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
public function getChecksWithHttpInfo($org_id, $zap_trace_span = null, $offset = null, $limit = 20)
{
$request = $this->getChecksRequest($org_id, $zap_trace_span, $offset, $limit);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Checks';
$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 getChecksWithHttpInfo
List all checks
@param string $org_id Only show checks that belong to a specific organization ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param int $offset The offset for pagination. The number of records to skip. (optional)
@param int $limit Limits the number of records returned. Default is `20`. (optional, default to 20)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Checks|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getChecksWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
protected function getChecksRequest($org_id, $zap_trace_span = null, $offset = null, $limit = 20)
{
// 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 getChecks'
);
}
if ($offset !== null && $offset < 0) {
throw new \InvalidArgumentException('invalid value for "$offset" when calling ChecksService.getChecks, must be bigger than or equal to 0.');
}
if ($limit !== null && $limit > 100) {
throw new \InvalidArgumentException('invalid value for "$limit" when calling ChecksService.getChecks, must be smaller than or equal to 100.');
}
if ($limit !== null && $limit < 1) {
throw new \InvalidArgumentException('invalid value for "$limit" when calling ChecksService.getChecks, must be bigger than or equal to 1.');
}
$resourcePath = '/api/v2/checks';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// query params
if ($offset !== null) {
$queryParams['offset'] = ObjectSerializer::toQueryValue($offset);
}
// query params
if ($limit !== null) {
$queryParams['limit'] = ObjectSerializer::toQueryValue($limit);
}
// query params
if ($org_id !== null) {
$queryParams['orgID'] = ObjectSerializer::toQueryValue($org_id);
}
// 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 'getChecks'
@param string $org_id Only show checks that belong to a specific organization ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param int $offset The offset for pagination. The number of records to skip. (optional)
@param int $limit Limits the number of records returned. Default is `20`. (optional, default to 20)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getChecksRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
public function getChecksID($check_id, $zap_trace_span = null)
{
list($response) = $this->getChecksIDWithHttpInfo($check_id, $zap_trace_span);
return $response;
} | Operation getChecksID
Retrieve a check
@param string $check_id The check ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Check|\InfluxDB2\Model\Error | getChecksID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
public function getChecksIDWithHttpInfo($check_id, $zap_trace_span = null)
{
$request = $this->getChecksIDRequest($check_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Check';
$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 getChecksIDWithHttpInfo
Retrieve a check
@param string $check_id The check 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\Check|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getChecksIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
protected function getChecksIDRequest($check_id, $zap_trace_span = null)
{
// verify the required parameter 'check_id' is set
if ($check_id === null || (is_array($check_id) && count($check_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $check_id when calling getChecksID'
);
}
$resourcePath = '/api/v2/checks/{checkID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($check_id !== null) {
$resourcePath = str_replace(
'{' . 'checkID' . '}',
ObjectSerializer::toPathValue($check_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 'getChecksID'
@param string $check_id The check ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getChecksIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
public function getChecksIDLabels($check_id, $zap_trace_span = null)
{
list($response) = $this->getChecksIDLabelsWithHttpInfo($check_id, $zap_trace_span);
return $response;
} | Operation getChecksIDLabels
List all labels for a check
@param string $check_id The check ID. (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 | getChecksIDLabels | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
public function getChecksIDLabelsWithHttpInfo($check_id, $zap_trace_span = null)
{
$request = $this->getChecksIDLabelsRequest($check_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 getChecksIDLabelsWithHttpInfo
List all labels for a check
@param string $check_id The check 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\LabelsResponse|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getChecksIDLabelsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
protected function getChecksIDLabelsRequest($check_id, $zap_trace_span = null)
{
// verify the required parameter 'check_id' is set
if ($check_id === null || (is_array($check_id) && count($check_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $check_id when calling getChecksIDLabels'
);
}
$resourcePath = '/api/v2/checks/{checkID}/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 ($check_id !== null) {
$resourcePath = str_replace(
'{' . 'checkID' . '}',
ObjectSerializer::toPathValue($check_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 'getChecksIDLabels'
@param string $check_id The check ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getChecksIDLabelsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
public function getChecksIDQuery($check_id, $zap_trace_span = null)
{
list($response) = $this->getChecksIDQueryWithHttpInfo($check_id, $zap_trace_span);
return $response;
} | Operation getChecksIDQuery
Retrieve a check query
@param string $check_id The check ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\FluxResponse|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | getChecksIDQuery | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
public function getChecksIDQueryWithHttpInfo($check_id, $zap_trace_span = null)
{
$request = $this->getChecksIDQueryRequest($check_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\FluxResponse';
$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 getChecksIDQueryWithHttpInfo
Retrieve a check query
@param string $check_id The check 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\FluxResponse|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getChecksIDQueryWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
protected function getChecksIDQueryRequest($check_id, $zap_trace_span = null)
{
// verify the required parameter 'check_id' is set
if ($check_id === null || (is_array($check_id) && count($check_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $check_id when calling getChecksIDQuery'
);
}
$resourcePath = '/api/v2/checks/{checkID}/query';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($check_id !== null) {
$resourcePath = str_replace(
'{' . 'checkID' . '}',
ObjectSerializer::toPathValue($check_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 'getChecksIDQuery'
@param string $check_id The check ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getChecksIDQueryRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
public function patchChecksID($check_id, $check_patch, $zap_trace_span = null)
{
list($response) = $this->patchChecksIDWithHttpInfo($check_id, $check_patch, $zap_trace_span);
return $response;
} | Operation patchChecksID
Update a check
@param string $check_id The check ID. (required)
@param \InfluxDB2\Model\CheckPatch $check_patch Check update to apply (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Check|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | patchChecksID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
public function patchChecksIDWithHttpInfo($check_id, $check_patch, $zap_trace_span = null)
{
$request = $this->patchChecksIDRequest($check_id, $check_patch, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Check';
$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 patchChecksIDWithHttpInfo
Update a check
@param string $check_id The check ID. (required)
@param \InfluxDB2\Model\CheckPatch $check_patch Check 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\Check|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | patchChecksIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
protected function patchChecksIDRequest($check_id, $check_patch, $zap_trace_span = null)
{
// verify the required parameter 'check_id' is set
if ($check_id === null || (is_array($check_id) && count($check_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $check_id when calling patchChecksID'
);
}
// verify the required parameter 'check_patch' is set
if ($check_patch === null || (is_array($check_patch) && count($check_patch) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $check_patch when calling patchChecksID'
);
}
$resourcePath = '/api/v2/checks/{checkID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($check_id !== null) {
$resourcePath = str_replace(
'{' . 'checkID' . '}',
ObjectSerializer::toPathValue($check_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($check_patch)) {
$_tempBody = $check_patch;
}
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 'patchChecksID'
@param string $check_id The check ID. (required)
@param \InfluxDB2\Model\CheckPatch $check_patch Check update to apply (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | patchChecksIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
public function postChecksIDLabels($check_id, $label_mapping, $zap_trace_span = null)
{
list($response) = $this->postChecksIDLabelsWithHttpInfo($check_id, $label_mapping, $zap_trace_span);
return $response;
} | Operation postChecksIDLabels
Add a label to a check
@param string $check_id The check ID. (required)
@param \InfluxDB2\Model\LabelMapping $label_mapping Label to add (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 | postChecksIDLabels | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
public function postChecksIDLabelsWithHttpInfo($check_id, $label_mapping, $zap_trace_span = null)
{
$request = $this->postChecksIDLabelsRequest($check_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 postChecksIDLabelsWithHttpInfo
Add a label to a check
@param string $check_id The check ID. (required)
@param \InfluxDB2\Model\LabelMapping $label_mapping Label 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\LabelResponse|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | postChecksIDLabelsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
protected function postChecksIDLabelsRequest($check_id, $label_mapping, $zap_trace_span = null)
{
// verify the required parameter 'check_id' is set
if ($check_id === null || (is_array($check_id) && count($check_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $check_id when calling postChecksIDLabels'
);
}
// 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 postChecksIDLabels'
);
}
$resourcePath = '/api/v2/checks/{checkID}/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 ($check_id !== null) {
$resourcePath = str_replace(
'{' . 'checkID' . '}',
ObjectSerializer::toPathValue($check_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 'postChecksIDLabels'
@param string $check_id The check ID. (required)
@param \InfluxDB2\Model\LabelMapping $label_mapping Label to add (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | postChecksIDLabelsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
public function putChecksID($check_id, $check, $zap_trace_span = null)
{
list($response) = $this->putChecksIDWithHttpInfo($check_id, $check, $zap_trace_span);
return $response;
} | Operation putChecksID
Update a check
@param string $check_id The check ID. (required)
@param \InfluxDB2\Model\Check $check Check update to apply (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Check|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | putChecksID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
public function putChecksIDWithHttpInfo($check_id, $check, $zap_trace_span = null)
{
$request = $this->putChecksIDRequest($check_id, $check, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Check';
$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 putChecksIDWithHttpInfo
Update a check
@param string $check_id The check ID. (required)
@param \InfluxDB2\Model\Check $check Check 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\Check|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | putChecksIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
protected function putChecksIDRequest($check_id, $check, $zap_trace_span = null)
{
// verify the required parameter 'check_id' is set
if ($check_id === null || (is_array($check_id) && count($check_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $check_id when calling putChecksID'
);
}
// verify the required parameter 'check' is set
if ($check === null || (is_array($check) && count($check) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $check when calling putChecksID'
);
}
$resourcePath = '/api/v2/checks/{checkID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($check_id !== null) {
$resourcePath = str_replace(
'{' . 'checkID' . '}',
ObjectSerializer::toPathValue($check_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($check)) {
$_tempBody = $check;
}
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 'putChecksID'
@param string $check_id The check ID. (required)
@param \InfluxDB2\Model\Check $check Check update to apply (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | putChecksIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ChecksService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ChecksService.php | MIT |
public function applyTemplate($template_apply)
{
list($response) = $this->applyTemplateWithHttpInfo($template_apply);
return $response;
} | Operation applyTemplate
Apply or dry-run a template
@param \InfluxDB2\Model\TemplateApply $template_apply Parameters for applying templates. (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\TemplateSummary|\InfluxDB2\Model\TemplateSummary|TemplateSummary|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | applyTemplate | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
public function applyTemplateWithHttpInfo($template_apply)
{
$request = $this->applyTemplateRequest($template_apply);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\TemplateSummary';
$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 applyTemplateWithHttpInfo
Apply or dry-run a template
@param \InfluxDB2\Model\TemplateApply $template_apply Parameters for applying templates. (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\TemplateSummary|\InfluxDB2\Model\TemplateSummary|TemplateSummary|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | applyTemplateWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
protected function applyTemplateRequest($template_apply)
{
// verify the required parameter 'template_apply' is set
if ($template_apply === null || (is_array($template_apply) && count($template_apply) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $template_apply when calling applyTemplate'
);
}
$resourcePath = '/api/v2/templates/apply';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// body params
$_tempBody = null;
if (isset($template_apply)) {
$_tempBody = $template_apply;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json', 'application/x-jsonnet', 'text/yml']
);
}
// 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 'applyTemplate'
@param \InfluxDB2\Model\TemplateApply $template_apply Parameters for applying templates. (required)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | applyTemplateRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
public function createStack($post_stack_request1 = null)
{
list($response) = $this->createStackWithHttpInfo($post_stack_request1);
return $response;
} | Operation createStack
Create a stack
@param \InfluxDB2\Model\PostStackRequest1 $post_stack_request1 post_stack_request1 (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Stack|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | createStack | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
public function createStackWithHttpInfo($post_stack_request1 = null)
{
$request = $this->createStackRequest($post_stack_request1);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Stack';
$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 createStackWithHttpInfo
Create a stack
@param \InfluxDB2\Model\PostStackRequest1 $post_stack_request1 (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Stack|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | createStackWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
protected function createStackRequest($post_stack_request1 = null)
{
$resourcePath = '/api/v2/stacks';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// body params
$_tempBody = null;
if (isset($post_stack_request1)) {
$_tempBody = $post_stack_request1;
}
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 'createStack'
@param \InfluxDB2\Model\PostStackRequest1 $post_stack_request1 (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | createStackRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
public function deleteStack($stack_id, $org_id)
{
$this->deleteStackWithHttpInfo($stack_id, $org_id);
} | Operation deleteStack
Delete a stack and associated resources
@param string $stack_id The identifier of the stack. (required)
@param string $org_id The identifier of the organization. (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return void | deleteStack | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
public function deleteStackWithHttpInfo($stack_id, $org_id)
{
$request = $this->deleteStackRequest($stack_id, $org_id);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteStackWithHttpInfo
Delete a stack and associated resources
@param string $stack_id The identifier of the stack. (required)
@param string $org_id The identifier of the organization. (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of null, HTTP status code, HTTP response headers (array of strings) | deleteStackWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
protected function deleteStackRequest($stack_id, $org_id)
{
// verify the required parameter 'stack_id' is set
if ($stack_id === null || (is_array($stack_id) && count($stack_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $stack_id when calling deleteStack'
);
}
// 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 deleteStack'
);
}
$resourcePath = '/api/v2/stacks/{stack_id}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// query params
if ($org_id !== null) {
$queryParams['orgID'] = ObjectSerializer::toQueryValue($org_id);
}
// path params
if ($stack_id !== null) {
$resourcePath = str_replace(
'{' . 'stack_id' . '}',
ObjectSerializer::toPathValue($stack_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 'deleteStack'
@param string $stack_id The identifier of the stack. (required)
@param string $org_id The identifier of the organization. (required)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | deleteStackRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
public function exportTemplate($template_export_by_id = null)
{
list($response) = $this->exportTemplateWithHttpInfo($template_export_by_id);
return $response;
} | Operation exportTemplate
Export a new template
@param \InfluxDB2\Model\TemplateExportByID $template_export_by_id Export resources as an InfluxDB template. (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return object[]|\InfluxDB2\Model\Error | exportTemplate | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
public function exportTemplateWithHttpInfo($template_export_by_id = null)
{
$request = $this->exportTemplateRequest($template_export_by_id);
$response = $this->defaultApi->sendRequest($request);
$returnType = 'object[]';
$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 exportTemplateWithHttpInfo
Export a new template
@param \InfluxDB2\Model\TemplateExportByID $template_export_by_id Export resources as an InfluxDB template. (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of object[]|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | exportTemplateWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
protected function exportTemplateRequest($template_export_by_id = null)
{
$resourcePath = '/api/v2/templates/export';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// body params
$_tempBody = null;
if (isset($template_export_by_id)) {
$_tempBody = $template_export_by_id;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json', 'application/x-yaml']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json', 'application/x-yaml'],
['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 'exportTemplate'
@param \InfluxDB2\Model\TemplateExportByID $template_export_by_id Export resources as an InfluxDB template. (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | exportTemplateRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
public function listStacks($org_id, $name = null, $stack_id = null)
{
list($response) = $this->listStacksWithHttpInfo($org_id, $name, $stack_id);
return $response;
} | Operation listStacks
List installed stacks
@param string $org_id The ID of the organization that owns the stacks. Only returns stacks owned by this organization. #### InfluxDB Cloud - Doesn't require this parameter; InfluxDB only returns resources allowed by the API token. (required)
@param string $name The stack name. Finds stack `events` with this name and returns the stacks. Repeatable. To filter for more than one stack name, repeat this parameter with each name--for example: - `http://localhost:8086/api/v2/stacks?&orgID=INFLUX_ORG_ID&name=project-stack-0&name=project-stack-1` (optional)
@param string $stack_id The stack ID. Only returns stacks with this ID. Repeatable. To filter for more than one stack ID, repeat this parameter with each ID--for example: - `http://localhost:8086/api/v2/stacks?&orgID=INFLUX_ORG_ID&stackID=09bd87cd33be3000&stackID=09bef35081fe3000` (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\ListStacksResponse|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | listStacks | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
public function listStacksWithHttpInfo($org_id, $name = null, $stack_id = null)
{
$request = $this->listStacksRequest($org_id, $name, $stack_id);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\ListStacksResponse';
$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 listStacksWithHttpInfo
List installed stacks
@param string $org_id The ID of the organization that owns the stacks. Only returns stacks owned by this organization. #### InfluxDB Cloud - Doesn't require this parameter; InfluxDB only returns resources allowed by the API token. (required)
@param string $name The stack name. Finds stack `events` with this name and returns the stacks. Repeatable. To filter for more than one stack name, repeat this parameter with each name--for example: - `http://localhost:8086/api/v2/stacks?&orgID=INFLUX_ORG_ID&name=project-stack-0&name=project-stack-1` (optional)
@param string $stack_id The stack ID. Only returns stacks with this ID. Repeatable. To filter for more than one stack ID, repeat this parameter with each ID--for example: - `http://localhost:8086/api/v2/stacks?&orgID=INFLUX_ORG_ID&stackID=09bd87cd33be3000&stackID=09bef35081fe3000` (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\ListStacksResponse|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | listStacksWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
protected function listStacksRequest($org_id, $name = null, $stack_id = 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 listStacks'
);
}
$resourcePath = '/api/v2/stacks';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// query params
if ($org_id !== null) {
$queryParams['orgID'] = ObjectSerializer::toQueryValue($org_id);
}
// query params
if ($name !== null) {
$queryParams['name'] = ObjectSerializer::toQueryValue($name);
}
// query params
if ($stack_id !== null) {
$queryParams['stackID'] = ObjectSerializer::toQueryValue($stack_id);
}
// 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 'listStacks'
@param string $org_id The ID of the organization that owns the stacks. Only returns stacks owned by this organization. #### InfluxDB Cloud - Doesn't require this parameter; InfluxDB only returns resources allowed by the API token. (required)
@param string $name The stack name. Finds stack `events` with this name and returns the stacks. Repeatable. To filter for more than one stack name, repeat this parameter with each name--for example: - `http://localhost:8086/api/v2/stacks?&orgID=INFLUX_ORG_ID&name=project-stack-0&name=project-stack-1` (optional)
@param string $stack_id The stack ID. Only returns stacks with this ID. Repeatable. To filter for more than one stack ID, repeat this parameter with each ID--for example: - `http://localhost:8086/api/v2/stacks?&orgID=INFLUX_ORG_ID&stackID=09bd87cd33be3000&stackID=09bef35081fe3000` (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | listStacksRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
public function readStack($stack_id)
{
list($response) = $this->readStackWithHttpInfo($stack_id);
return $response;
} | Operation readStack
Retrieve a stack
@param string $stack_id The identifier of the stack. (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Stack|\InfluxDB2\Model\Error | readStack | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
public function readStackWithHttpInfo($stack_id)
{
$request = $this->readStackRequest($stack_id);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Stack';
$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 readStackWithHttpInfo
Retrieve a stack
@param string $stack_id The identifier of the stack. (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Stack|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | readStackWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
protected function readStackRequest($stack_id)
{
// verify the required parameter 'stack_id' is set
if ($stack_id === null || (is_array($stack_id) && count($stack_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $stack_id when calling readStack'
);
}
$resourcePath = '/api/v2/stacks/{stack_id}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// path params
if ($stack_id !== null) {
$resourcePath = str_replace(
'{' . 'stack_id' . '}',
ObjectSerializer::toPathValue($stack_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 'readStack'
@param string $stack_id The identifier of the stack. (required)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | readStackRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
public function uninstallStack($stack_id)
{
list($response) = $this->uninstallStackWithHttpInfo($stack_id);
return $response;
} | Operation uninstallStack
Uninstall a stack
@param string $stack_id The identifier of the stack. (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Stack|\InfluxDB2\Model\Error | uninstallStack | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
public function uninstallStackWithHttpInfo($stack_id)
{
$request = $this->uninstallStackRequest($stack_id);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Stack';
$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 uninstallStackWithHttpInfo
Uninstall a stack
@param string $stack_id The identifier of the stack. (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Stack|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | uninstallStackWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
protected function uninstallStackRequest($stack_id)
{
// verify the required parameter 'stack_id' is set
if ($stack_id === null || (is_array($stack_id) && count($stack_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $stack_id when calling uninstallStack'
);
}
$resourcePath = '/api/v2/stacks/{stack_id}/uninstall';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// path params
if ($stack_id !== null) {
$resourcePath = str_replace(
'{' . 'stack_id' . '}',
ObjectSerializer::toPathValue($stack_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('POST', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'uninstallStack'
@param string $stack_id The identifier of the stack. (required)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | uninstallStackRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
public function updateStack($stack_id, $patch_stack_request1 = null)
{
list($response) = $this->updateStackWithHttpInfo($stack_id, $patch_stack_request1);
return $response;
} | Operation updateStack
Update a stack
@param string $stack_id The identifier of the stack. (required)
@param \InfluxDB2\Model\PatchStackRequest1 $patch_stack_request1 patch_stack_request1 (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Stack|\InfluxDB2\Model\Error | updateStack | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
public function updateStackWithHttpInfo($stack_id, $patch_stack_request1 = null)
{
$request = $this->updateStackRequest($stack_id, $patch_stack_request1);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Stack';
$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 updateStackWithHttpInfo
Update a stack
@param string $stack_id The identifier of the stack. (required)
@param \InfluxDB2\Model\PatchStackRequest1 $patch_stack_request1 (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Stack|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | updateStackWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
protected function updateStackRequest($stack_id, $patch_stack_request1 = null)
{
// verify the required parameter 'stack_id' is set
if ($stack_id === null || (is_array($stack_id) && count($stack_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $stack_id when calling updateStack'
);
}
$resourcePath = '/api/v2/stacks/{stack_id}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// path params
if ($stack_id !== null) {
$resourcePath = str_replace(
'{' . 'stack_id' . '}',
ObjectSerializer::toPathValue($stack_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($patch_stack_request1)) {
$_tempBody = $patch_stack_request1;
}
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 'updateStack'
@param string $stack_id The identifier of the stack. (required)
@param \InfluxDB2\Model\PatchStackRequest1 $patch_stack_request1 (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | updateStackRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/TemplatesService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/TemplatesService.php | MIT |
public function deleteAuthorizationsID($auth_id, $zap_trace_span = null)
{
$this->deleteAuthorizationsIDWithHttpInfo($auth_id, $zap_trace_span);
} | Operation deleteAuthorizationsID
Delete an authorization
@param string $auth_id The ID of the authorization to delete. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return void | deleteAuthorizationsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/AuthorizationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/AuthorizationsService.php | MIT |
public function deleteAuthorizationsIDWithHttpInfo($auth_id, $zap_trace_span = null)
{
$request = $this->deleteAuthorizationsIDRequest($auth_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteAuthorizationsIDWithHttpInfo
Delete an authorization
@param string $auth_id The ID of the authorization 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) | deleteAuthorizationsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/AuthorizationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/AuthorizationsService.php | MIT |
protected function deleteAuthorizationsIDRequest($auth_id, $zap_trace_span = null)
{
// verify the required parameter 'auth_id' is set
if ($auth_id === null || (is_array($auth_id) && count($auth_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $auth_id when calling deleteAuthorizationsID'
);
}
$resourcePath = '/api/v2/authorizations/{authID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($auth_id !== null) {
$resourcePath = str_replace(
'{' . 'authID' . '}',
ObjectSerializer::toPathValue($auth_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 'deleteAuthorizationsID'
@param string $auth_id The ID of the authorization to delete. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | deleteAuthorizationsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/AuthorizationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/AuthorizationsService.php | MIT |
public function getAuthorizations($zap_trace_span = null, $user_id = null, $user = null, $org_id = null, $org = null)
{
list($response) = $this->getAuthorizationsWithHttpInfo($zap_trace_span, $user_id, $user, $org_id, $org);
return $response;
} | Operation getAuthorizations
List authorizations
@param string $zap_trace_span OpenTracing span context (optional)
@param string $user_id A user ID. Only returns authorizations scoped to this user. (optional)
@param string $user A user name. Only returns authorizations scoped to this user. (optional)
@param string $org_id An organization ID. Only returns authorizations that belong to this organization. (optional)
@param string $org An organization name. Only returns authorizations that belong to this organization. (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Authorizations|string|object|\InfluxDB2\Model\Error|string | getAuthorizations | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/AuthorizationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/AuthorizationsService.php | MIT |
public function getAuthorizationsWithHttpInfo($zap_trace_span = null, $user_id = null, $user = null, $org_id = null, $org = null)
{
$request = $this->getAuthorizationsRequest($zap_trace_span, $user_id, $user, $org_id, $org);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Authorizations';
$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 getAuthorizationsWithHttpInfo
List authorizations
@param string $zap_trace_span OpenTracing span context (optional)
@param string $user_id A user ID. Only returns authorizations scoped to this user. (optional)
@param string $user A user name. Only returns authorizations scoped to this user. (optional)
@param string $org_id An organization ID. Only returns authorizations that belong to this organization. (optional)
@param string $org An organization name. Only returns authorizations that belong to this organization. (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Authorizations|string|object|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings) | getAuthorizationsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/AuthorizationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/AuthorizationsService.php | MIT |
protected function getAuthorizationsRequest($zap_trace_span = null, $user_id = null, $user = null, $org_id = null, $org = null)
{
$resourcePath = '/api/v2/authorizations';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// query params
if ($user_id !== null) {
$queryParams['userID'] = ObjectSerializer::toQueryValue($user_id);
}
// query params
if ($user !== null) {
$queryParams['user'] = ObjectSerializer::toQueryValue($user);
}
// 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);
}
// 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 'getAuthorizations'
@param string $zap_trace_span OpenTracing span context (optional)
@param string $user_id A user ID. Only returns authorizations scoped to this user. (optional)
@param string $user A user name. Only returns authorizations scoped to this user. (optional)
@param string $org_id An organization ID. Only returns authorizations that belong to this organization. (optional)
@param string $org An organization name. Only returns authorizations that belong to this organization. (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getAuthorizationsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/AuthorizationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/AuthorizationsService.php | MIT |
public function getAuthorizationsID($auth_id, $zap_trace_span = null)
{
list($response) = $this->getAuthorizationsIDWithHttpInfo($auth_id, $zap_trace_span);
return $response;
} | Operation getAuthorizationsID
Retrieve an authorization
@param string $auth_id The ID of the authorization to get. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Authorization|string | getAuthorizationsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/AuthorizationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/AuthorizationsService.php | MIT |
public function getAuthorizationsIDWithHttpInfo($auth_id, $zap_trace_span = null)
{
$request = $this->getAuthorizationsIDRequest($auth_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Authorization';
$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 getAuthorizationsIDWithHttpInfo
Retrieve an authorization
@param string $auth_id The ID of the authorization to get. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Authorization|string, HTTP status code, HTTP response headers (array of strings) | getAuthorizationsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/AuthorizationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/AuthorizationsService.php | MIT |
protected function getAuthorizationsIDRequest($auth_id, $zap_trace_span = null)
{
// verify the required parameter 'auth_id' is set
if ($auth_id === null || (is_array($auth_id) && count($auth_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $auth_id when calling getAuthorizationsID'
);
}
$resourcePath = '/api/v2/authorizations/{authID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($auth_id !== null) {
$resourcePath = str_replace(
'{' . 'authID' . '}',
ObjectSerializer::toPathValue($auth_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 'getAuthorizationsID'
@param string $auth_id The ID of the authorization to get. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getAuthorizationsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/AuthorizationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/AuthorizationsService.php | MIT |
public function patchAuthorizationsID($auth_id, $authorization_update_request, $zap_trace_span = null)
{
list($response) = $this->patchAuthorizationsIDWithHttpInfo($auth_id, $authorization_update_request, $zap_trace_span);
return $response;
} | Operation patchAuthorizationsID
Update an authorization to be active or inactive
@param string $auth_id The ID of the authorization to update. (required)
@param \InfluxDB2\Model\AuthorizationUpdateRequest $authorization_update_request Authorization to update (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Authorization|string | patchAuthorizationsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/AuthorizationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/AuthorizationsService.php | MIT |
public function patchAuthorizationsIDWithHttpInfo($auth_id, $authorization_update_request, $zap_trace_span = null)
{
$request = $this->patchAuthorizationsIDRequest($auth_id, $authorization_update_request, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Authorization';
$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 patchAuthorizationsIDWithHttpInfo
Update an authorization to be active or inactive
@param string $auth_id The ID of the authorization to update. (required)
@param \InfluxDB2\Model\AuthorizationUpdateRequest $authorization_update_request Authorization to 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\Authorization|string, HTTP status code, HTTP response headers (array of strings) | patchAuthorizationsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/AuthorizationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/AuthorizationsService.php | MIT |
protected function patchAuthorizationsIDRequest($auth_id, $authorization_update_request, $zap_trace_span = null)
{
// verify the required parameter 'auth_id' is set
if ($auth_id === null || (is_array($auth_id) && count($auth_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $auth_id when calling patchAuthorizationsID'
);
}
// verify the required parameter 'authorization_update_request' is set
if ($authorization_update_request === null || (is_array($authorization_update_request) && count($authorization_update_request) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $authorization_update_request when calling patchAuthorizationsID'
);
}
$resourcePath = '/api/v2/authorizations/{authID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($auth_id !== null) {
$resourcePath = str_replace(
'{' . 'authID' . '}',
ObjectSerializer::toPathValue($auth_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($authorization_update_request)) {
$_tempBody = $authorization_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 'patchAuthorizationsID'
@param string $auth_id The ID of the authorization to update. (required)
@param \InfluxDB2\Model\AuthorizationUpdateRequest $authorization_update_request Authorization to update (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | patchAuthorizationsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/AuthorizationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/AuthorizationsService.php | MIT |
public function postAuthorizations($authorization_post_request, $zap_trace_span = null)
{
list($response) = $this->postAuthorizationsWithHttpInfo($authorization_post_request, $zap_trace_span);
return $response;
} | Operation postAuthorizations
Create an authorization
@param \InfluxDB2\Model\AuthorizationPostRequest $authorization_post_request The authorization to create. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Authorization|string|object|\InfluxDB2\Model\Error|string | postAuthorizations | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/AuthorizationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/AuthorizationsService.php | MIT |
public function postAuthorizationsWithHttpInfo($authorization_post_request, $zap_trace_span = null)
{
$request = $this->postAuthorizationsRequest($authorization_post_request, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Authorization';
$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 postAuthorizationsWithHttpInfo
Create an authorization
@param \InfluxDB2\Model\AuthorizationPostRequest $authorization_post_request The authorization 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\Authorization|string|object|\InfluxDB2\Model\Error|string, HTTP status code, HTTP response headers (array of strings) | postAuthorizationsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/AuthorizationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/AuthorizationsService.php | MIT |
protected function postAuthorizationsRequest($authorization_post_request, $zap_trace_span = null)
{
// verify the required parameter 'authorization_post_request' is set
if ($authorization_post_request === null || (is_array($authorization_post_request) && count($authorization_post_request) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $authorization_post_request when calling postAuthorizations'
);
}
$resourcePath = '/api/v2/authorizations';
$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($authorization_post_request)) {
$_tempBody = $authorization_post_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 'postAuthorizations'
@param \InfluxDB2\Model\AuthorizationPostRequest $authorization_post_request The authorization to create. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | postAuthorizationsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/AuthorizationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/AuthorizationsService.php | MIT |
public function createNotificationEndpoint($notification_endpoint)
{
list($response) = $this->createNotificationEndpointWithHttpInfo($notification_endpoint);
return $response;
} | Operation createNotificationEndpoint
Add a notification endpoint
@param \InfluxDB2\Model\NotificationEndpoint $notification_endpoint Notification endpoint to create (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\NotificationEndpoint|\InfluxDB2\Model\Error | createNotificationEndpoint | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
public function createNotificationEndpointWithHttpInfo($notification_endpoint)
{
$request = $this->createNotificationEndpointRequest($notification_endpoint);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\NotificationEndpoint';
$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 createNotificationEndpointWithHttpInfo
Add a notification endpoint
@param \InfluxDB2\Model\NotificationEndpoint $notification_endpoint Notification endpoint to create (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\NotificationEndpoint|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | createNotificationEndpointWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
protected function createNotificationEndpointRequest($notification_endpoint)
{
// verify the required parameter 'notification_endpoint' is set
if ($notification_endpoint === null || (is_array($notification_endpoint) && count($notification_endpoint) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $notification_endpoint when calling createNotificationEndpoint'
);
}
$resourcePath = '/api/v2/notificationEndpoints';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// body params
$_tempBody = null;
if (isset($notification_endpoint)) {
$_tempBody = $notification_endpoint;
}
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 'createNotificationEndpoint'
@param \InfluxDB2\Model\NotificationEndpoint $notification_endpoint Notification endpoint to create (required)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | createNotificationEndpointRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
public function deleteNotificationEndpointsID($endpoint_id, $zap_trace_span = null)
{
$this->deleteNotificationEndpointsIDWithHttpInfo($endpoint_id, $zap_trace_span);
} | Operation deleteNotificationEndpointsID
Delete a notification endpoint
@param string $endpoint_id The notification endpoint ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return void | deleteNotificationEndpointsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
public function deleteNotificationEndpointsIDWithHttpInfo($endpoint_id, $zap_trace_span = null)
{
$request = $this->deleteNotificationEndpointsIDRequest($endpoint_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteNotificationEndpointsIDWithHttpInfo
Delete a notification endpoint
@param string $endpoint_id The notification endpoint 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) | deleteNotificationEndpointsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
protected function deleteNotificationEndpointsIDRequest($endpoint_id, $zap_trace_span = null)
{
// verify the required parameter 'endpoint_id' is set
if ($endpoint_id === null || (is_array($endpoint_id) && count($endpoint_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $endpoint_id when calling deleteNotificationEndpointsID'
);
}
$resourcePath = '/api/v2/notificationEndpoints/{endpointID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($endpoint_id !== null) {
$resourcePath = str_replace(
'{' . 'endpointID' . '}',
ObjectSerializer::toPathValue($endpoint_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 'deleteNotificationEndpointsID'
@param string $endpoint_id The notification endpoint ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | deleteNotificationEndpointsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
public function deleteNotificationEndpointsIDLabelsID($endpoint_id, $label_id, $zap_trace_span = null)
{
$this->deleteNotificationEndpointsIDLabelsIDWithHttpInfo($endpoint_id, $label_id, $zap_trace_span);
} | Operation deleteNotificationEndpointsIDLabelsID
Delete a label from a notification endpoint
@param string $endpoint_id The notification endpoint ID. (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 | deleteNotificationEndpointsIDLabelsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
public function deleteNotificationEndpointsIDLabelsIDWithHttpInfo($endpoint_id, $label_id, $zap_trace_span = null)
{
$request = $this->deleteNotificationEndpointsIDLabelsIDRequest($endpoint_id, $label_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteNotificationEndpointsIDLabelsIDWithHttpInfo
Delete a label from a notification endpoint
@param string $endpoint_id The notification endpoint ID. (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) | deleteNotificationEndpointsIDLabelsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
protected function deleteNotificationEndpointsIDLabelsIDRequest($endpoint_id, $label_id, $zap_trace_span = null)
{
// verify the required parameter 'endpoint_id' is set
if ($endpoint_id === null || (is_array($endpoint_id) && count($endpoint_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $endpoint_id when calling deleteNotificationEndpointsIDLabelsID'
);
}
// 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 deleteNotificationEndpointsIDLabelsID'
);
}
$resourcePath = '/api/v2/notificationEndpoints/{endpointID}/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 ($endpoint_id !== null) {
$resourcePath = str_replace(
'{' . 'endpointID' . '}',
ObjectSerializer::toPathValue($endpoint_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 'deleteNotificationEndpointsIDLabelsID'
@param string $endpoint_id The notification endpoint ID. (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 | deleteNotificationEndpointsIDLabelsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
public function getNotificationEndpoints($org_id, $zap_trace_span = null, $offset = null, $limit = 20)
{
list($response) = $this->getNotificationEndpointsWithHttpInfo($org_id, $zap_trace_span, $offset, $limit);
return $response;
} | Operation getNotificationEndpoints
List all notification endpoints
@param string $org_id Only show notification endpoints that belong to specific organization ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param int $offset The offset for pagination. The number of records to skip. (optional)
@param int $limit Limits the number of records returned. Default is `20`. (optional, default to 20)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\NotificationEndpoints|\InfluxDB2\Model\Error | getNotificationEndpoints | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
public function getNotificationEndpointsWithHttpInfo($org_id, $zap_trace_span = null, $offset = null, $limit = 20)
{
$request = $this->getNotificationEndpointsRequest($org_id, $zap_trace_span, $offset, $limit);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\NotificationEndpoints';
$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 getNotificationEndpointsWithHttpInfo
List all notification endpoints
@param string $org_id Only show notification endpoints that belong to specific organization ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param int $offset The offset for pagination. The number of records to skip. (optional)
@param int $limit Limits the number of records returned. Default is `20`. (optional, default to 20)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\NotificationEndpoints|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getNotificationEndpointsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
protected function getNotificationEndpointsRequest($org_id, $zap_trace_span = null, $offset = null, $limit = 20)
{
// 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 getNotificationEndpoints'
);
}
if ($offset !== null && $offset < 0) {
throw new \InvalidArgumentException('invalid value for "$offset" when calling NotificationEndpointsService.getNotificationEndpoints, must be bigger than or equal to 0.');
}
if ($limit !== null && $limit > 100) {
throw new \InvalidArgumentException('invalid value for "$limit" when calling NotificationEndpointsService.getNotificationEndpoints, must be smaller than or equal to 100.');
}
if ($limit !== null && $limit < 1) {
throw new \InvalidArgumentException('invalid value for "$limit" when calling NotificationEndpointsService.getNotificationEndpoints, must be bigger than or equal to 1.');
}
$resourcePath = '/api/v2/notificationEndpoints';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// query params
if ($offset !== null) {
$queryParams['offset'] = ObjectSerializer::toQueryValue($offset);
}
// query params
if ($limit !== null) {
$queryParams['limit'] = ObjectSerializer::toQueryValue($limit);
}
// query params
if ($org_id !== null) {
$queryParams['orgID'] = ObjectSerializer::toQueryValue($org_id);
}
// 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 'getNotificationEndpoints'
@param string $org_id Only show notification endpoints that belong to specific organization ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param int $offset The offset for pagination. The number of records to skip. (optional)
@param int $limit Limits the number of records returned. Default is `20`. (optional, default to 20)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getNotificationEndpointsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
public function getNotificationEndpointsID($endpoint_id, $zap_trace_span = null)
{
list($response) = $this->getNotificationEndpointsIDWithHttpInfo($endpoint_id, $zap_trace_span);
return $response;
} | Operation getNotificationEndpointsID
Retrieve a notification endpoint
@param string $endpoint_id The notification endpoint ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\NotificationEndpoint|\InfluxDB2\Model\Error | getNotificationEndpointsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
public function getNotificationEndpointsIDWithHttpInfo($endpoint_id, $zap_trace_span = null)
{
$request = $this->getNotificationEndpointsIDRequest($endpoint_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\NotificationEndpoint';
$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 getNotificationEndpointsIDWithHttpInfo
Retrieve a notification endpoint
@param string $endpoint_id The notification endpoint 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\NotificationEndpoint|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getNotificationEndpointsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
protected function getNotificationEndpointsIDRequest($endpoint_id, $zap_trace_span = null)
{
// verify the required parameter 'endpoint_id' is set
if ($endpoint_id === null || (is_array($endpoint_id) && count($endpoint_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $endpoint_id when calling getNotificationEndpointsID'
);
}
$resourcePath = '/api/v2/notificationEndpoints/{endpointID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($endpoint_id !== null) {
$resourcePath = str_replace(
'{' . 'endpointID' . '}',
ObjectSerializer::toPathValue($endpoint_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 'getNotificationEndpointsID'
@param string $endpoint_id The notification endpoint ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getNotificationEndpointsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
public function getNotificationEndpointsIDLabels($endpoint_id, $zap_trace_span = null)
{
list($response) = $this->getNotificationEndpointsIDLabelsWithHttpInfo($endpoint_id, $zap_trace_span);
return $response;
} | Operation getNotificationEndpointsIDLabels
List all labels for a notification endpoint
@param string $endpoint_id The notification endpoint ID. (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 | getNotificationEndpointsIDLabels | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
public function getNotificationEndpointsIDLabelsWithHttpInfo($endpoint_id, $zap_trace_span = null)
{
$request = $this->getNotificationEndpointsIDLabelsRequest($endpoint_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 getNotificationEndpointsIDLabelsWithHttpInfo
List all labels for a notification endpoint
@param string $endpoint_id The notification endpoint 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\LabelsResponse|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getNotificationEndpointsIDLabelsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
protected function getNotificationEndpointsIDLabelsRequest($endpoint_id, $zap_trace_span = null)
{
// verify the required parameter 'endpoint_id' is set
if ($endpoint_id === null || (is_array($endpoint_id) && count($endpoint_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $endpoint_id when calling getNotificationEndpointsIDLabels'
);
}
$resourcePath = '/api/v2/notificationEndpoints/{endpointID}/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 ($endpoint_id !== null) {
$resourcePath = str_replace(
'{' . 'endpointID' . '}',
ObjectSerializer::toPathValue($endpoint_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 'getNotificationEndpointsIDLabels'
@param string $endpoint_id The notification endpoint ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getNotificationEndpointsIDLabelsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
public function patchNotificationEndpointsID($endpoint_id, $notification_endpoint_update, $zap_trace_span = null)
{
list($response) = $this->patchNotificationEndpointsIDWithHttpInfo($endpoint_id, $notification_endpoint_update, $zap_trace_span);
return $response;
} | Operation patchNotificationEndpointsID
Update a notification endpoint
@param string $endpoint_id The notification endpoint ID. (required)
@param \InfluxDB2\Model\NotificationEndpointUpdate $notification_endpoint_update Check update to apply (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\NotificationEndpoint|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | patchNotificationEndpointsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
public function patchNotificationEndpointsIDWithHttpInfo($endpoint_id, $notification_endpoint_update, $zap_trace_span = null)
{
$request = $this->patchNotificationEndpointsIDRequest($endpoint_id, $notification_endpoint_update, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\NotificationEndpoint';
$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 patchNotificationEndpointsIDWithHttpInfo
Update a notification endpoint
@param string $endpoint_id The notification endpoint ID. (required)
@param \InfluxDB2\Model\NotificationEndpointUpdate $notification_endpoint_update Check 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\NotificationEndpoint|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | patchNotificationEndpointsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
protected function patchNotificationEndpointsIDRequest($endpoint_id, $notification_endpoint_update, $zap_trace_span = null)
{
// verify the required parameter 'endpoint_id' is set
if ($endpoint_id === null || (is_array($endpoint_id) && count($endpoint_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $endpoint_id when calling patchNotificationEndpointsID'
);
}
// verify the required parameter 'notification_endpoint_update' is set
if ($notification_endpoint_update === null || (is_array($notification_endpoint_update) && count($notification_endpoint_update) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $notification_endpoint_update when calling patchNotificationEndpointsID'
);
}
$resourcePath = '/api/v2/notificationEndpoints/{endpointID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($endpoint_id !== null) {
$resourcePath = str_replace(
'{' . 'endpointID' . '}',
ObjectSerializer::toPathValue($endpoint_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($notification_endpoint_update)) {
$_tempBody = $notification_endpoint_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 'patchNotificationEndpointsID'
@param string $endpoint_id The notification endpoint ID. (required)
@param \InfluxDB2\Model\NotificationEndpointUpdate $notification_endpoint_update Check update to apply (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | patchNotificationEndpointsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
public function postNotificationEndpointIDLabels($endpoint_id, $label_mapping, $zap_trace_span = null)
{
list($response) = $this->postNotificationEndpointIDLabelsWithHttpInfo($endpoint_id, $label_mapping, $zap_trace_span);
return $response;
} | Operation postNotificationEndpointIDLabels
Add a label to a notification endpoint
@param string $endpoint_id The notification endpoint ID. (required)
@param \InfluxDB2\Model\LabelMapping $label_mapping Label to add (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 | postNotificationEndpointIDLabels | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
public function postNotificationEndpointIDLabelsWithHttpInfo($endpoint_id, $label_mapping, $zap_trace_span = null)
{
$request = $this->postNotificationEndpointIDLabelsRequest($endpoint_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 postNotificationEndpointIDLabelsWithHttpInfo
Add a label to a notification endpoint
@param string $endpoint_id The notification endpoint ID. (required)
@param \InfluxDB2\Model\LabelMapping $label_mapping Label 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\LabelResponse|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | postNotificationEndpointIDLabelsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
protected function postNotificationEndpointIDLabelsRequest($endpoint_id, $label_mapping, $zap_trace_span = null)
{
// verify the required parameter 'endpoint_id' is set
if ($endpoint_id === null || (is_array($endpoint_id) && count($endpoint_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $endpoint_id when calling postNotificationEndpointIDLabels'
);
}
// 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 postNotificationEndpointIDLabels'
);
}
$resourcePath = '/api/v2/notificationEndpoints/{endpointID}/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 ($endpoint_id !== null) {
$resourcePath = str_replace(
'{' . 'endpointID' . '}',
ObjectSerializer::toPathValue($endpoint_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 'postNotificationEndpointIDLabels'
@param string $endpoint_id The notification endpoint ID. (required)
@param \InfluxDB2\Model\LabelMapping $label_mapping Label to add (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | postNotificationEndpointIDLabelsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
public function putNotificationEndpointsID($endpoint_id, $notification_endpoint, $zap_trace_span = null)
{
list($response) = $this->putNotificationEndpointsIDWithHttpInfo($endpoint_id, $notification_endpoint, $zap_trace_span);
return $response;
} | Operation putNotificationEndpointsID
Update a notification endpoint
@param string $endpoint_id The notification endpoint ID. (required)
@param \InfluxDB2\Model\NotificationEndpoint $notification_endpoint A new notification endpoint to replace the existing endpoint with (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\NotificationEndpoint|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | putNotificationEndpointsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
public function putNotificationEndpointsIDWithHttpInfo($endpoint_id, $notification_endpoint, $zap_trace_span = null)
{
$request = $this->putNotificationEndpointsIDRequest($endpoint_id, $notification_endpoint, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\NotificationEndpoint';
$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 putNotificationEndpointsIDWithHttpInfo
Update a notification endpoint
@param string $endpoint_id The notification endpoint ID. (required)
@param \InfluxDB2\Model\NotificationEndpoint $notification_endpoint A new notification endpoint to replace the existing endpoint with (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\NotificationEndpoint|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | putNotificationEndpointsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
protected function putNotificationEndpointsIDRequest($endpoint_id, $notification_endpoint, $zap_trace_span = null)
{
// verify the required parameter 'endpoint_id' is set
if ($endpoint_id === null || (is_array($endpoint_id) && count($endpoint_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $endpoint_id when calling putNotificationEndpointsID'
);
}
// verify the required parameter 'notification_endpoint' is set
if ($notification_endpoint === null || (is_array($notification_endpoint) && count($notification_endpoint) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $notification_endpoint when calling putNotificationEndpointsID'
);
}
$resourcePath = '/api/v2/notificationEndpoints/{endpointID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($endpoint_id !== null) {
$resourcePath = str_replace(
'{' . 'endpointID' . '}',
ObjectSerializer::toPathValue($endpoint_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($notification_endpoint)) {
$_tempBody = $notification_endpoint;
}
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 'putNotificationEndpointsID'
@param string $endpoint_id The notification endpoint ID. (required)
@param \InfluxDB2\Model\NotificationEndpoint $notification_endpoint A new notification endpoint to replace the existing endpoint with (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | putNotificationEndpointsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/NotificationEndpointsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/NotificationEndpointsService.php | MIT |
public function deleteReplicationByID($replication_id, $zap_trace_span = null)
{
$this->deleteReplicationByIDWithHttpInfo($replication_id, $zap_trace_span);
} | Operation deleteReplicationByID
Delete a replication
@param string $replication_id replication_id (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return void | deleteReplicationByID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ReplicationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ReplicationsService.php | MIT |
public function deleteReplicationByIDWithHttpInfo($replication_id, $zap_trace_span = null)
{
$request = $this->deleteReplicationByIDRequest($replication_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteReplicationByIDWithHttpInfo
Delete a replication
@param string $replication_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) | deleteReplicationByIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ReplicationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ReplicationsService.php | MIT |
protected function deleteReplicationByIDRequest($replication_id, $zap_trace_span = null)
{
// verify the required parameter 'replication_id' is set
if ($replication_id === null || (is_array($replication_id) && count($replication_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $replication_id when calling deleteReplicationByID'
);
}
$resourcePath = '/api/v2/replications/{replicationID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($replication_id !== null) {
$resourcePath = str_replace(
'{' . 'replicationID' . '}',
ObjectSerializer::toPathValue($replication_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 'deleteReplicationByID'
@param string $replication_id (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | deleteReplicationByIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ReplicationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ReplicationsService.php | MIT |
public function getReplicationByID($replication_id, $zap_trace_span = null)
{
list($response) = $this->getReplicationByIDWithHttpInfo($replication_id, $zap_trace_span);
return $response;
} | Operation getReplicationByID
Retrieve a replication
@param string $replication_id replication_id (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Replication|string|string | getReplicationByID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ReplicationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ReplicationsService.php | MIT |
public function getReplicationByIDWithHttpInfo($replication_id, $zap_trace_span = null)
{
$request = $this->getReplicationByIDRequest($replication_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Replication';
$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 getReplicationByIDWithHttpInfo
Retrieve a replication
@param string $replication_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\Replication|string|string, HTTP status code, HTTP response headers (array of strings) | getReplicationByIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ReplicationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ReplicationsService.php | MIT |
protected function getReplicationByIDRequest($replication_id, $zap_trace_span = null)
{
// verify the required parameter 'replication_id' is set
if ($replication_id === null || (is_array($replication_id) && count($replication_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $replication_id when calling getReplicationByID'
);
}
$resourcePath = '/api/v2/replications/{replicationID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($replication_id !== null) {
$resourcePath = str_replace(
'{' . 'replicationID' . '}',
ObjectSerializer::toPathValue($replication_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 'getReplicationByID'
@param string $replication_id (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getReplicationByIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ReplicationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ReplicationsService.php | MIT |
public function getReplications($org_id, $zap_trace_span = null, $name = null, $remote_id = null, $local_bucket_id = null)
{
list($response) = $this->getReplicationsWithHttpInfo($org_id, $zap_trace_span, $name, $remote_id, $local_bucket_id);
return $response;
} | Operation getReplications
List all replications
@param string $org_id The organization ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $name name (optional)
@param string $remote_id remote_id (optional)
@param string $local_bucket_id local_bucket_id (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Replications|string|string | getReplications | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ReplicationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ReplicationsService.php | MIT |
public function getReplicationsWithHttpInfo($org_id, $zap_trace_span = null, $name = null, $remote_id = null, $local_bucket_id = null)
{
$request = $this->getReplicationsRequest($org_id, $zap_trace_span, $name, $remote_id, $local_bucket_id);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Replications';
$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 getReplicationsWithHttpInfo
List all replications
@param string $org_id The organization ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $name (optional)
@param string $remote_id (optional)
@param string $local_bucket_id (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Replications|string|string, HTTP status code, HTTP response headers (array of strings) | getReplicationsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ReplicationsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ReplicationsService.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.