code
stringlengths 17
247k
| 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 deleteScrapersIDMembersIDWithHttpInfo($user_id, $scraper_target_id, $zap_trace_span = null)
{
$request = $this->deleteScrapersIDMembersIDRequest($user_id, $scraper_target_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteScrapersIDMembersIDWithHttpInfo
Remove a member from a scraper target
@param string $user_id The ID of member to remove. (required)
@param string $scraper_target_id The scraper target 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) | deleteScrapersIDMembersIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
protected function deleteScrapersIDMembersIDRequest($user_id, $scraper_target_id, $zap_trace_span = null)
{
// verify the required parameter 'user_id' is set
if ($user_id === null || (is_array($user_id) && count($user_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $user_id when calling deleteScrapersIDMembersID'
);
}
// verify the required parameter 'scraper_target_id' is set
if ($scraper_target_id === null || (is_array($scraper_target_id) && count($scraper_target_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $scraper_target_id when calling deleteScrapersIDMembersID'
);
}
$resourcePath = '/api/v2/scrapers/{scraperTargetID}/members/{userID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($user_id !== null) {
$resourcePath = str_replace(
'{' . 'userID' . '}',
ObjectSerializer::toPathValue($user_id),
$resourcePath
);
}
// path params
if ($scraper_target_id !== null) {
$resourcePath = str_replace(
'{' . 'scraperTargetID' . '}',
ObjectSerializer::toPathValue($scraper_target_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 'deleteScrapersIDMembersID'
@param string $user_id The ID of member to remove. (required)
@param string $scraper_target_id The scraper target ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | deleteScrapersIDMembersIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function deleteScrapersIDOwnersID($user_id, $scraper_target_id, $zap_trace_span = null)
{
$this->deleteScrapersIDOwnersIDWithHttpInfo($user_id, $scraper_target_id, $zap_trace_span);
} | Operation deleteScrapersIDOwnersID
Remove an owner from a scraper target
@param string $user_id The ID of owner to remove. (required)
@param string $scraper_target_id The scraper target ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return void | deleteScrapersIDOwnersID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function deleteScrapersIDOwnersIDWithHttpInfo($user_id, $scraper_target_id, $zap_trace_span = null)
{
$request = $this->deleteScrapersIDOwnersIDRequest($user_id, $scraper_target_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteScrapersIDOwnersIDWithHttpInfo
Remove an owner from a scraper target
@param string $user_id The ID of owner to remove. (required)
@param string $scraper_target_id The scraper target 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) | deleteScrapersIDOwnersIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
protected function deleteScrapersIDOwnersIDRequest($user_id, $scraper_target_id, $zap_trace_span = null)
{
// verify the required parameter 'user_id' is set
if ($user_id === null || (is_array($user_id) && count($user_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $user_id when calling deleteScrapersIDOwnersID'
);
}
// verify the required parameter 'scraper_target_id' is set
if ($scraper_target_id === null || (is_array($scraper_target_id) && count($scraper_target_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $scraper_target_id when calling deleteScrapersIDOwnersID'
);
}
$resourcePath = '/api/v2/scrapers/{scraperTargetID}/owners/{userID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($user_id !== null) {
$resourcePath = str_replace(
'{' . 'userID' . '}',
ObjectSerializer::toPathValue($user_id),
$resourcePath
);
}
// path params
if ($scraper_target_id !== null) {
$resourcePath = str_replace(
'{' . 'scraperTargetID' . '}',
ObjectSerializer::toPathValue($scraper_target_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 'deleteScrapersIDOwnersID'
@param string $user_id The ID of owner to remove. (required)
@param string $scraper_target_id The scraper target ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | deleteScrapersIDOwnersIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function getScrapers($zap_trace_span = null, $name = null, $id = null, $org_id = null, $org = null)
{
list($response) = $this->getScrapersWithHttpInfo($zap_trace_span, $name, $id, $org_id, $org);
return $response;
} | Operation getScrapers
List all scraper targets
@param string $zap_trace_span OpenTracing span context (optional)
@param string $name Specifies the name of the scraper target. (optional)
@param string[] $id List of scraper target IDs to return. If both `id` and `owner` are specified, only `id` is used. (optional)
@param string $org_id Specifies the organization ID of the scraper target. (optional)
@param string $org Specifies the organization name of the scraper target. (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\ScraperTargetResponses | getScrapers | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function getScrapersWithHttpInfo($zap_trace_span = null, $name = null, $id = null, $org_id = null, $org = null)
{
$request = $this->getScrapersRequest($zap_trace_span, $name, $id, $org_id, $org);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\ScraperTargetResponses';
$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 getScrapersWithHttpInfo
List all scraper targets
@param string $zap_trace_span OpenTracing span context (optional)
@param string $name Specifies the name of the scraper target. (optional)
@param string[] $id List of scraper target IDs to return. If both `id` and `owner` are specified, only `id` is used. (optional)
@param string $org_id Specifies the organization ID of the scraper target. (optional)
@param string $org Specifies the organization name of the scraper target. (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\ScraperTargetResponses, HTTP status code, HTTP response headers (array of strings) | getScrapersWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
protected function getScrapersRequest($zap_trace_span = null, $name = null, $id = null, $org_id = null, $org = null)
{
$resourcePath = '/api/v2/scrapers';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// query params
if ($name !== null) {
$queryParams['name'] = ObjectSerializer::toQueryValue($name);
}
// query params
if (is_array($id)) {
$id = ObjectSerializer::serializeCollection($id, 'multi', true);
}
if ($id !== null) {
$queryParams['id'] = ObjectSerializer::toQueryValue($id);
}
// 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 'getScrapers'
@param string $zap_trace_span OpenTracing span context (optional)
@param string $name Specifies the name of the scraper target. (optional)
@param string[] $id List of scraper target IDs to return. If both `id` and `owner` are specified, only `id` is used. (optional)
@param string $org_id Specifies the organization ID of the scraper target. (optional)
@param string $org Specifies the organization name of the scraper target. (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getScrapersRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function getScrapersID($scraper_target_id, $zap_trace_span = null)
{
list($response) = $this->getScrapersIDWithHttpInfo($scraper_target_id, $zap_trace_span);
return $response;
} | Operation getScrapersID
Retrieve a scraper target
@param string $scraper_target_id The identifier of the scraper target. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\ScraperTargetResponse|\InfluxDB2\Model\Error | getScrapersID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function getScrapersIDWithHttpInfo($scraper_target_id, $zap_trace_span = null)
{
$request = $this->getScrapersIDRequest($scraper_target_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\ScraperTargetResponse';
$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 getScrapersIDWithHttpInfo
Retrieve a scraper target
@param string $scraper_target_id The identifier of the scraper target. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\ScraperTargetResponse|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getScrapersIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
protected function getScrapersIDRequest($scraper_target_id, $zap_trace_span = null)
{
// verify the required parameter 'scraper_target_id' is set
if ($scraper_target_id === null || (is_array($scraper_target_id) && count($scraper_target_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $scraper_target_id when calling getScrapersID'
);
}
$resourcePath = '/api/v2/scrapers/{scraperTargetID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($scraper_target_id !== null) {
$resourcePath = str_replace(
'{' . 'scraperTargetID' . '}',
ObjectSerializer::toPathValue($scraper_target_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 'getScrapersID'
@param string $scraper_target_id The identifier of the scraper target. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getScrapersIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function getScrapersIDLabels($scraper_target_id, $zap_trace_span = null)
{
list($response) = $this->getScrapersIDLabelsWithHttpInfo($scraper_target_id, $zap_trace_span);
return $response;
} | Operation getScrapersIDLabels
List all labels for a scraper target
@param string $scraper_target_id The scraper target 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 | getScrapersIDLabels | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function getScrapersIDLabelsWithHttpInfo($scraper_target_id, $zap_trace_span = null)
{
$request = $this->getScrapersIDLabelsRequest($scraper_target_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 getScrapersIDLabelsWithHttpInfo
List all labels for a scraper target
@param string $scraper_target_id The scraper target 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) | getScrapersIDLabelsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
protected function getScrapersIDLabelsRequest($scraper_target_id, $zap_trace_span = null)
{
// verify the required parameter 'scraper_target_id' is set
if ($scraper_target_id === null || (is_array($scraper_target_id) && count($scraper_target_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $scraper_target_id when calling getScrapersIDLabels'
);
}
$resourcePath = '/api/v2/scrapers/{scraperTargetID}/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 ($scraper_target_id !== null) {
$resourcePath = str_replace(
'{' . 'scraperTargetID' . '}',
ObjectSerializer::toPathValue($scraper_target_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 'getScrapersIDLabels'
@param string $scraper_target_id The scraper target ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getScrapersIDLabelsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function getScrapersIDMembers($scraper_target_id, $zap_trace_span = null)
{
list($response) = $this->getScrapersIDMembersWithHttpInfo($scraper_target_id, $zap_trace_span);
return $response;
} | Operation getScrapersIDMembers
List all users with member privileges for a scraper target
@param string $scraper_target_id The scraper target ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\ResourceMembers|\InfluxDB2\Model\Error | getScrapersIDMembers | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function getScrapersIDMembersWithHttpInfo($scraper_target_id, $zap_trace_span = null)
{
$request = $this->getScrapersIDMembersRequest($scraper_target_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\ResourceMembers';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation getScrapersIDMembersWithHttpInfo
List all users with member privileges for a scraper target
@param string $scraper_target_id The scraper target ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\ResourceMembers|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getScrapersIDMembersWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
protected function getScrapersIDMembersRequest($scraper_target_id, $zap_trace_span = null)
{
// verify the required parameter 'scraper_target_id' is set
if ($scraper_target_id === null || (is_array($scraper_target_id) && count($scraper_target_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $scraper_target_id when calling getScrapersIDMembers'
);
}
$resourcePath = '/api/v2/scrapers/{scraperTargetID}/members';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($scraper_target_id !== null) {
$resourcePath = str_replace(
'{' . 'scraperTargetID' . '}',
ObjectSerializer::toPathValue($scraper_target_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 'getScrapersIDMembers'
@param string $scraper_target_id The scraper target ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getScrapersIDMembersRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function getScrapersIDOwners($scraper_target_id, $zap_trace_span = null)
{
list($response) = $this->getScrapersIDOwnersWithHttpInfo($scraper_target_id, $zap_trace_span);
return $response;
} | Operation getScrapersIDOwners
List all owners of a scraper target
@param string $scraper_target_id The scraper target ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\ResourceOwners|\InfluxDB2\Model\Error | getScrapersIDOwners | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function getScrapersIDOwnersWithHttpInfo($scraper_target_id, $zap_trace_span = null)
{
$request = $this->getScrapersIDOwnersRequest($scraper_target_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\ResourceOwners';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation getScrapersIDOwnersWithHttpInfo
List all owners of a scraper target
@param string $scraper_target_id The scraper target 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\ResourceOwners|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getScrapersIDOwnersWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
protected function getScrapersIDOwnersRequest($scraper_target_id, $zap_trace_span = null)
{
// verify the required parameter 'scraper_target_id' is set
if ($scraper_target_id === null || (is_array($scraper_target_id) && count($scraper_target_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $scraper_target_id when calling getScrapersIDOwners'
);
}
$resourcePath = '/api/v2/scrapers/{scraperTargetID}/owners';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($scraper_target_id !== null) {
$resourcePath = str_replace(
'{' . 'scraperTargetID' . '}',
ObjectSerializer::toPathValue($scraper_target_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 'getScrapersIDOwners'
@param string $scraper_target_id The scraper target ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getScrapersIDOwnersRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function patchScrapersID($scraper_target_id, $scraper_target_request, $zap_trace_span = null)
{
list($response) = $this->patchScrapersIDWithHttpInfo($scraper_target_id, $scraper_target_request, $zap_trace_span);
return $response;
} | Operation patchScrapersID
Update a scraper target
@param string $scraper_target_id The identifier of the scraper target. (required)
@param \InfluxDB2\Model\ScraperTargetRequest $scraper_target_request Scraper target 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\ScraperTargetResponse|\InfluxDB2\Model\Error | patchScrapersID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function patchScrapersIDWithHttpInfo($scraper_target_id, $scraper_target_request, $zap_trace_span = null)
{
$request = $this->patchScrapersIDRequest($scraper_target_id, $scraper_target_request, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\ScraperTargetResponse';
$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 patchScrapersIDWithHttpInfo
Update a scraper target
@param string $scraper_target_id The identifier of the scraper target. (required)
@param \InfluxDB2\Model\ScraperTargetRequest $scraper_target_request Scraper target 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\ScraperTargetResponse|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | patchScrapersIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
protected function patchScrapersIDRequest($scraper_target_id, $scraper_target_request, $zap_trace_span = null)
{
// verify the required parameter 'scraper_target_id' is set
if ($scraper_target_id === null || (is_array($scraper_target_id) && count($scraper_target_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $scraper_target_id when calling patchScrapersID'
);
}
// verify the required parameter 'scraper_target_request' is set
if ($scraper_target_request === null || (is_array($scraper_target_request) && count($scraper_target_request) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $scraper_target_request when calling patchScrapersID'
);
}
$resourcePath = '/api/v2/scrapers/{scraperTargetID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($scraper_target_id !== null) {
$resourcePath = str_replace(
'{' . 'scraperTargetID' . '}',
ObjectSerializer::toPathValue($scraper_target_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($scraper_target_request)) {
$_tempBody = $scraper_target_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 'patchScrapersID'
@param string $scraper_target_id The identifier of the scraper target. (required)
@param \InfluxDB2\Model\ScraperTargetRequest $scraper_target_request Scraper target update to apply (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | patchScrapersIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function postScrapers($scraper_target_request, $zap_trace_span = null)
{
list($response) = $this->postScrapersWithHttpInfo($scraper_target_request, $zap_trace_span);
return $response;
} | Operation postScrapers
Create a scraper target
@param \InfluxDB2\Model\ScraperTargetRequest $scraper_target_request Scraper target to create (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\ScraperTargetResponse|\InfluxDB2\Model\Error | postScrapers | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function postScrapersWithHttpInfo($scraper_target_request, $zap_trace_span = null)
{
$request = $this->postScrapersRequest($scraper_target_request, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\ScraperTargetResponse';
$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 postScrapersWithHttpInfo
Create a scraper target
@param \InfluxDB2\Model\ScraperTargetRequest $scraper_target_request Scraper target 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\ScraperTargetResponse|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | postScrapersWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
protected function postScrapersRequest($scraper_target_request, $zap_trace_span = null)
{
// verify the required parameter 'scraper_target_request' is set
if ($scraper_target_request === null || (is_array($scraper_target_request) && count($scraper_target_request) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $scraper_target_request when calling postScrapers'
);
}
$resourcePath = '/api/v2/scrapers';
$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($scraper_target_request)) {
$_tempBody = $scraper_target_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 'postScrapers'
@param \InfluxDB2\Model\ScraperTargetRequest $scraper_target_request Scraper target to create (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | postScrapersRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function postScrapersIDLabels($scraper_target_id, $label_mapping, $zap_trace_span = null)
{
list($response) = $this->postScrapersIDLabelsWithHttpInfo($scraper_target_id, $label_mapping, $zap_trace_span);
return $response;
} | Operation postScrapersIDLabels
Add a label to a scraper target
@param string $scraper_target_id The scraper target 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 | postScrapersIDLabels | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function postScrapersIDLabelsWithHttpInfo($scraper_target_id, $label_mapping, $zap_trace_span = null)
{
$request = $this->postScrapersIDLabelsRequest($scraper_target_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 postScrapersIDLabelsWithHttpInfo
Add a label to a scraper target
@param string $scraper_target_id The scraper target 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) | postScrapersIDLabelsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
protected function postScrapersIDLabelsRequest($scraper_target_id, $label_mapping, $zap_trace_span = null)
{
// verify the required parameter 'scraper_target_id' is set
if ($scraper_target_id === null || (is_array($scraper_target_id) && count($scraper_target_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $scraper_target_id when calling postScrapersIDLabels'
);
}
// 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 postScrapersIDLabels'
);
}
$resourcePath = '/api/v2/scrapers/{scraperTargetID}/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 ($scraper_target_id !== null) {
$resourcePath = str_replace(
'{' . 'scraperTargetID' . '}',
ObjectSerializer::toPathValue($scraper_target_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 'postScrapersIDLabels'
@param string $scraper_target_id The scraper target 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 | postScrapersIDLabelsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function postScrapersIDMembers($scraper_target_id, $add_resource_member_request_body, $zap_trace_span = null)
{
list($response) = $this->postScrapersIDMembersWithHttpInfo($scraper_target_id, $add_resource_member_request_body, $zap_trace_span);
return $response;
} | Operation postScrapersIDMembers
Add a member to a scraper target
@param string $scraper_target_id The scraper target ID. (required)
@param \InfluxDB2\Model\AddResourceMemberRequestBody $add_resource_member_request_body User to add as member (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\ResourceMember|\InfluxDB2\Model\Error | postScrapersIDMembers | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function postScrapersIDMembersWithHttpInfo($scraper_target_id, $add_resource_member_request_body, $zap_trace_span = null)
{
$request = $this->postScrapersIDMembersRequest($scraper_target_id, $add_resource_member_request_body, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\ResourceMember';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation postScrapersIDMembersWithHttpInfo
Add a member to a scraper target
@param string $scraper_target_id The scraper target ID. (required)
@param \InfluxDB2\Model\AddResourceMemberRequestBody $add_resource_member_request_body User to add as member (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\ResourceMember|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | postScrapersIDMembersWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
protected function postScrapersIDMembersRequest($scraper_target_id, $add_resource_member_request_body, $zap_trace_span = null)
{
// verify the required parameter 'scraper_target_id' is set
if ($scraper_target_id === null || (is_array($scraper_target_id) && count($scraper_target_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $scraper_target_id when calling postScrapersIDMembers'
);
}
// verify the required parameter 'add_resource_member_request_body' is set
if ($add_resource_member_request_body === null || (is_array($add_resource_member_request_body) && count($add_resource_member_request_body) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $add_resource_member_request_body when calling postScrapersIDMembers'
);
}
$resourcePath = '/api/v2/scrapers/{scraperTargetID}/members';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($scraper_target_id !== null) {
$resourcePath = str_replace(
'{' . 'scraperTargetID' . '}',
ObjectSerializer::toPathValue($scraper_target_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($add_resource_member_request_body)) {
$_tempBody = $add_resource_member_request_body;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('POST', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'postScrapersIDMembers'
@param string $scraper_target_id The scraper target ID. (required)
@param \InfluxDB2\Model\AddResourceMemberRequestBody $add_resource_member_request_body User to add as member (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | postScrapersIDMembersRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function postScrapersIDOwners($scraper_target_id, $add_resource_member_request_body, $zap_trace_span = null)
{
list($response) = $this->postScrapersIDOwnersWithHttpInfo($scraper_target_id, $add_resource_member_request_body, $zap_trace_span);
return $response;
} | Operation postScrapersIDOwners
Add an owner to a scraper target
@param string $scraper_target_id The scraper target ID. (required)
@param \InfluxDB2\Model\AddResourceMemberRequestBody $add_resource_member_request_body User to add as owner (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\ResourceOwner|\InfluxDB2\Model\Error | postScrapersIDOwners | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function postScrapersIDOwnersWithHttpInfo($scraper_target_id, $add_resource_member_request_body, $zap_trace_span = null)
{
$request = $this->postScrapersIDOwnersRequest($scraper_target_id, $add_resource_member_request_body, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\ResourceOwner';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation postScrapersIDOwnersWithHttpInfo
Add an owner to a scraper target
@param string $scraper_target_id The scraper target ID. (required)
@param \InfluxDB2\Model\AddResourceMemberRequestBody $add_resource_member_request_body User to add as owner (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\ResourceOwner|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | postScrapersIDOwnersWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
protected function postScrapersIDOwnersRequest($scraper_target_id, $add_resource_member_request_body, $zap_trace_span = null)
{
// verify the required parameter 'scraper_target_id' is set
if ($scraper_target_id === null || (is_array($scraper_target_id) && count($scraper_target_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $scraper_target_id when calling postScrapersIDOwners'
);
}
// verify the required parameter 'add_resource_member_request_body' is set
if ($add_resource_member_request_body === null || (is_array($add_resource_member_request_body) && count($add_resource_member_request_body) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $add_resource_member_request_body when calling postScrapersIDOwners'
);
}
$resourcePath = '/api/v2/scrapers/{scraperTargetID}/owners';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($scraper_target_id !== null) {
$resourcePath = str_replace(
'{' . 'scraperTargetID' . '}',
ObjectSerializer::toPathValue($scraper_target_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($add_resource_member_request_body)) {
$_tempBody = $add_resource_member_request_body;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('POST', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'postScrapersIDOwners'
@param string $scraper_target_id The scraper target ID. (required)
@param \InfluxDB2\Model\AddResourceMemberRequestBody $add_resource_member_request_body User to add as owner (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | postScrapersIDOwnersRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ScraperTargetsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ScraperTargetsService.php | MIT |
public function deleteScriptsID($script_id)
{
$this->deleteScriptsIDWithHttpInfo($script_id);
} | Operation deleteScriptsID
Delete a script
@param string $script_id The ID of the script to delete. (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return void | deleteScriptsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
public function deleteScriptsIDWithHttpInfo($script_id)
{
$request = $this->deleteScriptsIDRequest($script_id);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteScriptsIDWithHttpInfo
Delete a script
@param string $script_id The ID of the script to delete. (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of null, HTTP status code, HTTP response headers (array of strings) | deleteScriptsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
protected function deleteScriptsIDRequest($script_id)
{
// verify the required parameter 'script_id' is set
if ($script_id === null || (is_array($script_id) && count($script_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $script_id when calling deleteScriptsID'
);
}
$resourcePath = '/api/v2/scripts/{scriptID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// path params
if ($script_id !== null) {
$resourcePath = str_replace(
'{' . 'scriptID' . '}',
ObjectSerializer::toPathValue($script_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
[]
);
} else {
$headers = $this->headerSelector->selectHeaders(
[],
[]
);
}
// 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 'deleteScriptsID'
@param string $script_id The ID of the script to delete. (required)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | deleteScriptsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
public function getScripts($limit = 100, $offset = 0, $name = null, $label_names = null, $label_contains = null)
{
list($response) = $this->getScriptsWithHttpInfo($limit, $offset, $name, $label_names, $label_contains);
return $response;
} | Operation getScripts
List scripts
@param int $limit Limits the number of scripts returned. Default is `100`. (optional, default to 100)
@param int $offset The offset for pagination. The number of records to skip. (optional, default to 0)
@param string $name The name of the script. (optional)
@param string[] $label_names A list of label names. Only returns scripts that have all these labels. To retrieve a script, each name you pass in `labelNames` must exactly match the label for a script. (optional)
@param string $label_contains A part of the label name. Returns scripts that have a label that contains this phrase. (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Scripts|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | getScripts | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
public function getScriptsWithHttpInfo($limit = 100, $offset = 0, $name = null, $label_names = null, $label_contains = null)
{
$request = $this->getScriptsRequest($limit, $offset, $name, $label_names, $label_contains);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Scripts';
$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 getScriptsWithHttpInfo
List scripts
@param int $limit Limits the number of scripts returned. Default is `100`. (optional, default to 100)
@param int $offset The offset for pagination. The number of records to skip. (optional, default to 0)
@param string $name The name of the script. (optional)
@param string[] $label_names A list of label names. Only returns scripts that have all these labels. To retrieve a script, each name you pass in `labelNames` must exactly match the label for a script. (optional)
@param string $label_contains A part of the label name. Returns scripts that have a label that contains this phrase. (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Scripts|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getScriptsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
protected function getScriptsRequest($limit = 100, $offset = 0, $name = null, $label_names = null, $label_contains = null)
{
if ($limit !== null && $limit > 500) {
throw new \InvalidArgumentException('invalid value for "$limit" when calling InvokableScriptsService.getScripts, must be smaller than or equal to 500.');
}
if ($limit !== null && $limit < 0) {
throw new \InvalidArgumentException('invalid value for "$limit" when calling InvokableScriptsService.getScripts, must be bigger than or equal to 0.');
}
if ($offset !== null && $offset < 0) {
throw new \InvalidArgumentException('invalid value for "$offset" when calling InvokableScriptsService.getScripts, must be bigger than or equal to 0.');
}
$resourcePath = '/api/v2/scripts';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// query params
if ($limit !== null) {
$queryParams['limit'] = ObjectSerializer::toQueryValue($limit);
}
// query params
if ($offset !== null) {
$queryParams['offset'] = ObjectSerializer::toQueryValue($offset);
}
// query params
if ($name !== null) {
$queryParams['name'] = ObjectSerializer::toQueryValue($name);
}
// query params
if (is_array($label_names)) {
$label_names = ObjectSerializer::serializeCollection($label_names, 'multi', true);
}
if ($label_names !== null) {
$queryParams['labelNames'] = ObjectSerializer::toQueryValue($label_names);
}
// query params
if ($label_contains !== null) {
$queryParams['labelContains'] = ObjectSerializer::toQueryValue($label_contains);
}
// 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 'getScripts'
@param int $limit Limits the number of scripts returned. Default is `100`. (optional, default to 100)
@param int $offset The offset for pagination. The number of records to skip. (optional, default to 0)
@param string $name The name of the script. (optional)
@param string[] $label_names A list of label names. Only returns scripts that have all these labels. To retrieve a script, each name you pass in `labelNames` must exactly match the label for a script. (optional)
@param string $label_contains A part of the label name. Returns scripts that have a label that contains this phrase. (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getScriptsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
public function getScriptsID($script_id)
{
list($response) = $this->getScriptsIDWithHttpInfo($script_id);
return $response;
} | Operation getScriptsID
Retrieve a script
@param string $script_id The script ID. (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Script | getScriptsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
public function getScriptsIDWithHttpInfo($script_id)
{
$request = $this->getScriptsIDRequest($script_id);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Script';
$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 getScriptsIDWithHttpInfo
Retrieve a script
@param string $script_id The script ID. (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Script, HTTP status code, HTTP response headers (array of strings) | getScriptsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
protected function getScriptsIDRequest($script_id)
{
// verify the required parameter 'script_id' is set
if ($script_id === null || (is_array($script_id) && count($script_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $script_id when calling getScriptsID'
);
}
$resourcePath = '/api/v2/scripts/{scriptID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// path params
if ($script_id !== null) {
$resourcePath = str_replace(
'{' . 'scriptID' . '}',
ObjectSerializer::toPathValue($script_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 'getScriptsID'
@param string $script_id The script ID. (required)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getScriptsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
public function patchScriptsID($script_id, $script_update_request)
{
list($response) = $this->patchScriptsIDWithHttpInfo($script_id, $script_update_request);
return $response;
} | Operation patchScriptsID
Update a script
@param string $script_id The script ID. (required)
@param \InfluxDB2\Model\ScriptUpdateRequest $script_update_request Script update to apply (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Script | patchScriptsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
public function patchScriptsIDWithHttpInfo($script_id, $script_update_request)
{
$request = $this->patchScriptsIDRequest($script_id, $script_update_request);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Script';
$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 patchScriptsIDWithHttpInfo
Update a script
@param string $script_id The script ID. (required)
@param \InfluxDB2\Model\ScriptUpdateRequest $script_update_request Script update to apply (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Script, HTTP status code, HTTP response headers (array of strings) | patchScriptsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
protected function patchScriptsIDRequest($script_id, $script_update_request)
{
// verify the required parameter 'script_id' is set
if ($script_id === null || (is_array($script_id) && count($script_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $script_id when calling patchScriptsID'
);
}
// verify the required parameter 'script_update_request' is set
if ($script_update_request === null || (is_array($script_update_request) && count($script_update_request) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $script_update_request when calling patchScriptsID'
);
}
$resourcePath = '/api/v2/scripts/{scriptID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// path params
if ($script_id !== null) {
$resourcePath = str_replace(
'{' . 'scriptID' . '}',
ObjectSerializer::toPathValue($script_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($script_update_request)) {
$_tempBody = $script_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 'patchScriptsID'
@param string $script_id The script ID. (required)
@param \InfluxDB2\Model\ScriptUpdateRequest $script_update_request Script update to apply (required)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | patchScriptsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
public function patchScriptsIDAddLabels($script_id, $label_mapping)
{
list($response) = $this->patchScriptsIDAddLabelsWithHttpInfo($script_id, $label_mapping);
return $response;
} | Operation patchScriptsIDAddLabels
Adds labels to a script
@param string $script_id The script ID. (required)
@param \InfluxDB2\Model\LabelMapping $label_mapping The names of labels to add to the script. (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Script|object|\InfluxDB2\Model\Error | patchScriptsIDAddLabels | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
public function patchScriptsIDAddLabelsWithHttpInfo($script_id, $label_mapping)
{
$request = $this->patchScriptsIDAddLabelsRequest($script_id, $label_mapping);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Script';
$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 patchScriptsIDAddLabelsWithHttpInfo
Adds labels to a script
@param string $script_id The script ID. (required)
@param \InfluxDB2\Model\LabelMapping $label_mapping The names of labels to add to the script. (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Script|object|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | patchScriptsIDAddLabelsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
protected function patchScriptsIDAddLabelsRequest($script_id, $label_mapping)
{
// verify the required parameter 'script_id' is set
if ($script_id === null || (is_array($script_id) && count($script_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $script_id when calling patchScriptsIDAddLabels'
);
}
// 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 patchScriptsIDAddLabels'
);
}
$resourcePath = '/api/v2/scripts/{scriptID}/labels/add';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// path params
if ($script_id !== null) {
$resourcePath = str_replace(
'{' . 'scriptID' . '}',
ObjectSerializer::toPathValue($script_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('PATCH', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'patchScriptsIDAddLabels'
@param string $script_id The script ID. (required)
@param \InfluxDB2\Model\LabelMapping $label_mapping The names of labels to add to the script. (required)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | patchScriptsIDAddLabelsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
public function patchScriptsIDRemoveLabels($script_id, $label_mapping)
{
list($response) = $this->patchScriptsIDRemoveLabelsWithHttpInfo($script_id, $label_mapping);
return $response;
} | Operation patchScriptsIDRemoveLabels
Removes labels from a script
@param string $script_id The script ID. (required)
@param \InfluxDB2\Model\LabelMapping $label_mapping The names of labels to remove from the script. (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Script|object|\InfluxDB2\Model\Error | patchScriptsIDRemoveLabels | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
public function patchScriptsIDRemoveLabelsWithHttpInfo($script_id, $label_mapping)
{
$request = $this->patchScriptsIDRemoveLabelsRequest($script_id, $label_mapping);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Script';
$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 patchScriptsIDRemoveLabelsWithHttpInfo
Removes labels from a script
@param string $script_id The script ID. (required)
@param \InfluxDB2\Model\LabelMapping $label_mapping The names of labels to remove from the script. (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Script|object|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | patchScriptsIDRemoveLabelsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
protected function patchScriptsIDRemoveLabelsRequest($script_id, $label_mapping)
{
// verify the required parameter 'script_id' is set
if ($script_id === null || (is_array($script_id) && count($script_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $script_id when calling patchScriptsIDRemoveLabels'
);
}
// 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 patchScriptsIDRemoveLabels'
);
}
$resourcePath = '/api/v2/scripts/{scriptID}/labels/remove';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// path params
if ($script_id !== null) {
$resourcePath = str_replace(
'{' . 'scriptID' . '}',
ObjectSerializer::toPathValue($script_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('PATCH', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'patchScriptsIDRemoveLabels'
@param string $script_id The script ID. (required)
@param \InfluxDB2\Model\LabelMapping $label_mapping The names of labels to remove from the script. (required)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | patchScriptsIDRemoveLabelsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
public function postScripts($script_create_request)
{
list($response) = $this->postScriptsWithHttpInfo($script_create_request);
return $response;
} | Operation postScripts
Create a script
@param \InfluxDB2\Model\ScriptCreateRequest $script_create_request The script to create. (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Script|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | postScripts | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
public function postScriptsWithHttpInfo($script_create_request)
{
$request = $this->postScriptsRequest($script_create_request);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Script';
$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 postScriptsWithHttpInfo
Create a script
@param \InfluxDB2\Model\ScriptCreateRequest $script_create_request The script to create. (required)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Script|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | postScriptsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
protected function postScriptsRequest($script_create_request)
{
// verify the required parameter 'script_create_request' is set
if ($script_create_request === null || (is_array($script_create_request) && count($script_create_request) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $script_create_request when calling postScripts'
);
}
$resourcePath = '/api/v2/scripts';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// body params
$_tempBody = null;
if (isset($script_create_request)) {
$_tempBody = $script_create_request;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('POST', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'postScripts'
@param \InfluxDB2\Model\ScriptCreateRequest $script_create_request The script to create. (required)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | postScriptsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
public function postScriptsIDInvoke($script_id, $script_invocation_params = null)
{
list($response) = $this->postScriptsIDInvokeWithHttpInfo($script_id, $script_invocation_params);
return $response;
} | Operation postScriptsIDInvoke
Invoke a script
@param string $script_id Script ID. Only returns scripts with this ID. (required)
@param \InfluxDB2\Model\ScriptInvocationParams $script_invocation_params script_invocation_params (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \SplFileObject|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | postScriptsIDInvoke | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
public function postScriptsIDInvokeWithHttpInfo($script_id, $script_invocation_params = null)
{
$request = $this->postScriptsIDInvokeRequest($script_id, $script_invocation_params);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\SplFileObject';
$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 postScriptsIDInvokeWithHttpInfo
Invoke a script
@param string $script_id Script ID. Only returns scripts with this ID. (required)
@param \InfluxDB2\Model\ScriptInvocationParams $script_invocation_params (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \SplFileObject|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | postScriptsIDInvokeWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
protected function postScriptsIDInvokeRequest($script_id, $script_invocation_params = null)
{
// verify the required parameter 'script_id' is set
if ($script_id === null || (is_array($script_id) && count($script_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $script_id when calling postScriptsIDInvoke'
);
}
$resourcePath = '/api/v2/scripts/{scriptID}/invoke';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// path params
if ($script_id !== null) {
$resourcePath = str_replace(
'{' . 'scriptID' . '}',
ObjectSerializer::toPathValue($script_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($script_invocation_params)) {
$_tempBody = $script_invocation_params;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['text/csv', 'application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['text/csv', '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 'postScriptsIDInvoke'
@param string $script_id Script ID. Only returns scripts with this ID. (required)
@param \InfluxDB2\Model\ScriptInvocationParams $script_invocation_params (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | postScriptsIDInvokeRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/InvokableScriptsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/InvokableScriptsService.php | MIT |
public function deleteBucketsID($bucket_id, $zap_trace_span = null)
{
$this->deleteBucketsIDWithHttpInfo($bucket_id, $zap_trace_span);
} | Operation deleteBucketsID
Delete a bucket
@param string $bucket_id Bucket ID. The ID of the bucket to delete. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return void | deleteBucketsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function deleteBucketsIDWithHttpInfo($bucket_id, $zap_trace_span = null)
{
$request = $this->deleteBucketsIDRequest($bucket_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteBucketsIDWithHttpInfo
Delete a bucket
@param string $bucket_id Bucket ID. The ID of the bucket 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) | deleteBucketsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
protected function deleteBucketsIDRequest($bucket_id, $zap_trace_span = null)
{
// verify the required parameter 'bucket_id' is set
if ($bucket_id === null || (is_array($bucket_id) && count($bucket_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $bucket_id when calling deleteBucketsID'
);
}
$resourcePath = '/api/v2/buckets/{bucketID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($bucket_id !== null) {
$resourcePath = str_replace(
'{' . 'bucketID' . '}',
ObjectSerializer::toPathValue($bucket_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 'deleteBucketsID'
@param string $bucket_id Bucket ID. The ID of the bucket to delete. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | deleteBucketsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function deleteBucketsIDLabelsID($bucket_id, $label_id, $zap_trace_span = null)
{
$this->deleteBucketsIDLabelsIDWithHttpInfo($bucket_id, $label_id, $zap_trace_span);
} | Operation deleteBucketsIDLabelsID
Delete a label from a bucket
@param string $bucket_id The bucket 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 | deleteBucketsIDLabelsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function deleteBucketsIDLabelsIDWithHttpInfo($bucket_id, $label_id, $zap_trace_span = null)
{
$request = $this->deleteBucketsIDLabelsIDRequest($bucket_id, $label_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteBucketsIDLabelsIDWithHttpInfo
Delete a label from a bucket
@param string $bucket_id The bucket 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) | deleteBucketsIDLabelsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
protected function deleteBucketsIDLabelsIDRequest($bucket_id, $label_id, $zap_trace_span = null)
{
// verify the required parameter 'bucket_id' is set
if ($bucket_id === null || (is_array($bucket_id) && count($bucket_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $bucket_id when calling deleteBucketsIDLabelsID'
);
}
// 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 deleteBucketsIDLabelsID'
);
}
$resourcePath = '/api/v2/buckets/{bucketID}/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 ($bucket_id !== null) {
$resourcePath = str_replace(
'{' . 'bucketID' . '}',
ObjectSerializer::toPathValue($bucket_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 'deleteBucketsIDLabelsID'
@param string $bucket_id The bucket 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 | deleteBucketsIDLabelsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function deleteBucketsIDMembersID($user_id, $bucket_id, $zap_trace_span = null)
{
$this->deleteBucketsIDMembersIDWithHttpInfo($user_id, $bucket_id, $zap_trace_span);
} | Operation deleteBucketsIDMembersID
Remove a member from a bucket
@param string $user_id The ID of the user to remove. (required)
@param string $bucket_id The ID of the bucket to remove a user from. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return void | deleteBucketsIDMembersID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function deleteBucketsIDMembersIDWithHttpInfo($user_id, $bucket_id, $zap_trace_span = null)
{
$request = $this->deleteBucketsIDMembersIDRequest($user_id, $bucket_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteBucketsIDMembersIDWithHttpInfo
Remove a member from a bucket
@param string $user_id The ID of the user to remove. (required)
@param string $bucket_id The ID of the bucket to remove a user from. (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) | deleteBucketsIDMembersIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
protected function deleteBucketsIDMembersIDRequest($user_id, $bucket_id, $zap_trace_span = null)
{
// verify the required parameter 'user_id' is set
if ($user_id === null || (is_array($user_id) && count($user_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $user_id when calling deleteBucketsIDMembersID'
);
}
// verify the required parameter 'bucket_id' is set
if ($bucket_id === null || (is_array($bucket_id) && count($bucket_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $bucket_id when calling deleteBucketsIDMembersID'
);
}
$resourcePath = '/api/v2/buckets/{bucketID}/members/{userID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($user_id !== null) {
$resourcePath = str_replace(
'{' . 'userID' . '}',
ObjectSerializer::toPathValue($user_id),
$resourcePath
);
}
// path params
if ($bucket_id !== null) {
$resourcePath = str_replace(
'{' . 'bucketID' . '}',
ObjectSerializer::toPathValue($bucket_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 'deleteBucketsIDMembersID'
@param string $user_id The ID of the user to remove. (required)
@param string $bucket_id The ID of the bucket to remove a user from. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | deleteBucketsIDMembersIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function deleteBucketsIDOwnersID($user_id, $bucket_id, $zap_trace_span = null)
{
$this->deleteBucketsIDOwnersIDWithHttpInfo($user_id, $bucket_id, $zap_trace_span);
} | Operation deleteBucketsIDOwnersID
Remove an owner from a bucket
@param string $user_id The ID of the owner to remove. (required)
@param string $bucket_id The bucket ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return void | deleteBucketsIDOwnersID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function deleteBucketsIDOwnersIDWithHttpInfo($user_id, $bucket_id, $zap_trace_span = null)
{
$request = $this->deleteBucketsIDOwnersIDRequest($user_id, $bucket_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteBucketsIDOwnersIDWithHttpInfo
Remove an owner from a bucket
@param string $user_id The ID of the owner to remove. (required)
@param string $bucket_id The bucket 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) | deleteBucketsIDOwnersIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
protected function deleteBucketsIDOwnersIDRequest($user_id, $bucket_id, $zap_trace_span = null)
{
// verify the required parameter 'user_id' is set
if ($user_id === null || (is_array($user_id) && count($user_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $user_id when calling deleteBucketsIDOwnersID'
);
}
// verify the required parameter 'bucket_id' is set
if ($bucket_id === null || (is_array($bucket_id) && count($bucket_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $bucket_id when calling deleteBucketsIDOwnersID'
);
}
$resourcePath = '/api/v2/buckets/{bucketID}/owners/{userID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($user_id !== null) {
$resourcePath = str_replace(
'{' . 'userID' . '}',
ObjectSerializer::toPathValue($user_id),
$resourcePath
);
}
// path params
if ($bucket_id !== null) {
$resourcePath = str_replace(
'{' . 'bucketID' . '}',
ObjectSerializer::toPathValue($bucket_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 'deleteBucketsIDOwnersID'
@param string $user_id The ID of the owner to remove. (required)
@param string $bucket_id The bucket ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | deleteBucketsIDOwnersIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function getBuckets($zap_trace_span = null, $offset = null, $limit = 20, $after = null, $org = null, $org_id = null, $name = null, $id = null)
{
list($response) = $this->getBucketsWithHttpInfo($zap_trace_span, $offset, $limit, $after, $org, $org_id, $name, $id);
return $response;
} | Operation getBuckets
List buckets
@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)
@param string $after Resource ID to seek from. Results are not inclusive of this ID. Use `after` instead of `offset`. (optional)
@param string $org Organization name. The name of the organization. #### InfluxDB Cloud - Doesn't use `org` or `orgID`. - Creates a bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Accepts either `org` or `orgID`. - InfluxDB creates the bucket within this organization. (optional)
@param string $org_id Organization ID. The organization ID. #### InfluxDB Cloud - Doesn't use `org` or `orgID`. - Creates a bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Accepts either `org` or `orgID`. - InfluxDB creates the bucket within this organization. (optional)
@param string $name Bucket name. Only returns buckets with this specific name. (optional)
@param string $id Bucket ID. Only returns the bucket with this ID. (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Buckets|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | getBuckets | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function getBucketsWithHttpInfo($zap_trace_span = null, $offset = null, $limit = 20, $after = null, $org = null, $org_id = null, $name = null, $id = null)
{
$request = $this->getBucketsRequest($zap_trace_span, $offset, $limit, $after, $org, $org_id, $name, $id);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Buckets';
$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 getBucketsWithHttpInfo
List buckets
@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)
@param string $after Resource ID to seek from. Results are not inclusive of this ID. Use `after` instead of `offset`. (optional)
@param string $org Organization name. The name of the organization. #### InfluxDB Cloud - Doesn't use `org` or `orgID`. - Creates a bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Accepts either `org` or `orgID`. - InfluxDB creates the bucket within this organization. (optional)
@param string $org_id Organization ID. The organization ID. #### InfluxDB Cloud - Doesn't use `org` or `orgID`. - Creates a bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Accepts either `org` or `orgID`. - InfluxDB creates the bucket within this organization. (optional)
@param string $name Bucket name. Only returns buckets with this specific name. (optional)
@param string $id Bucket ID. Only returns the bucket with this ID. (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Buckets|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getBucketsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
protected function getBucketsRequest($zap_trace_span = null, $offset = null, $limit = 20, $after = null, $org = null, $org_id = null, $name = null, $id = null)
{
if ($offset !== null && $offset < 0) {
throw new \InvalidArgumentException('invalid value for "$offset" when calling BucketsService.getBuckets, must be bigger than or equal to 0.');
}
if ($limit !== null && $limit > 100) {
throw new \InvalidArgumentException('invalid value for "$limit" when calling BucketsService.getBuckets, must be smaller than or equal to 100.');
}
if ($limit !== null && $limit < 1) {
throw new \InvalidArgumentException('invalid value for "$limit" when calling BucketsService.getBuckets, must be bigger than or equal to 1.');
}
$resourcePath = '/api/v2/buckets';
$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 ($after !== null) {
$queryParams['after'] = ObjectSerializer::toQueryValue($after);
}
// query params
if ($org !== null) {
$queryParams['org'] = ObjectSerializer::toQueryValue($org);
}
// query params
if ($org_id !== null) {
$queryParams['orgID'] = ObjectSerializer::toQueryValue($org_id);
}
// query params
if ($name !== null) {
$queryParams['name'] = ObjectSerializer::toQueryValue($name);
}
// query params
if ($id !== null) {
$queryParams['id'] = ObjectSerializer::toQueryValue($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 'getBuckets'
@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)
@param string $after Resource ID to seek from. Results are not inclusive of this ID. Use `after` instead of `offset`. (optional)
@param string $org Organization name. The name of the organization. #### InfluxDB Cloud - Doesn't use `org` or `orgID`. - Creates a bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Accepts either `org` or `orgID`. - InfluxDB creates the bucket within this organization. (optional)
@param string $org_id Organization ID. The organization ID. #### InfluxDB Cloud - Doesn't use `org` or `orgID`. - Creates a bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Accepts either `org` or `orgID`. - InfluxDB creates the bucket within this organization. (optional)
@param string $name Bucket name. Only returns buckets with this specific name. (optional)
@param string $id Bucket ID. Only returns the bucket with this ID. (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getBucketsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function getBucketsID($bucket_id, $zap_trace_span = null)
{
list($response) = $this->getBucketsIDWithHttpInfo($bucket_id, $zap_trace_span);
return $response;
} | Operation getBucketsID
Retrieve a bucket
@param string $bucket_id The ID of the bucket to retrieve. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Bucket|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | getBucketsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function getBucketsIDWithHttpInfo($bucket_id, $zap_trace_span = null)
{
$request = $this->getBucketsIDRequest($bucket_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Bucket';
$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 getBucketsIDWithHttpInfo
Retrieve a bucket
@param string $bucket_id The ID of the bucket to retrieve. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Bucket|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getBucketsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
protected function getBucketsIDRequest($bucket_id, $zap_trace_span = null)
{
// verify the required parameter 'bucket_id' is set
if ($bucket_id === null || (is_array($bucket_id) && count($bucket_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $bucket_id when calling getBucketsID'
);
}
$resourcePath = '/api/v2/buckets/{bucketID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($bucket_id !== null) {
$resourcePath = str_replace(
'{' . 'bucketID' . '}',
ObjectSerializer::toPathValue($bucket_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 'getBucketsID'
@param string $bucket_id The ID of the bucket to retrieve. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getBucketsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function getBucketsIDLabels($bucket_id, $zap_trace_span = null)
{
list($response) = $this->getBucketsIDLabelsWithHttpInfo($bucket_id, $zap_trace_span);
return $response;
} | Operation getBucketsIDLabels
List all labels for a bucket
@param string $bucket_id The ID of the bucket to retrieve labels for. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\LabelsResponse|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | getBucketsIDLabels | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function getBucketsIDLabelsWithHttpInfo($bucket_id, $zap_trace_span = null)
{
$request = $this->getBucketsIDLabelsRequest($bucket_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 getBucketsIDLabelsWithHttpInfo
List all labels for a bucket
@param string $bucket_id The ID of the bucket to retrieve labels for. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\LabelsResponse|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getBucketsIDLabelsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
protected function getBucketsIDLabelsRequest($bucket_id, $zap_trace_span = null)
{
// verify the required parameter 'bucket_id' is set
if ($bucket_id === null || (is_array($bucket_id) && count($bucket_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $bucket_id when calling getBucketsIDLabels'
);
}
$resourcePath = '/api/v2/buckets/{bucketID}/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 ($bucket_id !== null) {
$resourcePath = str_replace(
'{' . 'bucketID' . '}',
ObjectSerializer::toPathValue($bucket_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 'getBucketsIDLabels'
@param string $bucket_id The ID of the bucket to retrieve labels for. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getBucketsIDLabelsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function getBucketsIDMembers($bucket_id, $zap_trace_span = null)
{
list($response) = $this->getBucketsIDMembersWithHttpInfo($bucket_id, $zap_trace_span);
return $response;
} | Operation getBucketsIDMembers
List all users with member privileges for a bucket
@param string $bucket_id The ID of the bucket to retrieve users for. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\ResourceMembers|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | getBucketsIDMembers | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function getBucketsIDMembersWithHttpInfo($bucket_id, $zap_trace_span = null)
{
$request = $this->getBucketsIDMembersRequest($bucket_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\ResourceMembers';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation getBucketsIDMembersWithHttpInfo
List all users with member privileges for a bucket
@param string $bucket_id The ID of the bucket to retrieve users for. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\ResourceMembers|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getBucketsIDMembersWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
protected function getBucketsIDMembersRequest($bucket_id, $zap_trace_span = null)
{
// verify the required parameter 'bucket_id' is set
if ($bucket_id === null || (is_array($bucket_id) && count($bucket_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $bucket_id when calling getBucketsIDMembers'
);
}
$resourcePath = '/api/v2/buckets/{bucketID}/members';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($bucket_id !== null) {
$resourcePath = str_replace(
'{' . 'bucketID' . '}',
ObjectSerializer::toPathValue($bucket_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 'getBucketsIDMembers'
@param string $bucket_id The ID of the bucket to retrieve users for. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getBucketsIDMembersRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function getBucketsIDOwners($bucket_id, $zap_trace_span = null)
{
list($response) = $this->getBucketsIDOwnersWithHttpInfo($bucket_id, $zap_trace_span);
return $response;
} | Operation getBucketsIDOwners
List all owners of a bucket
@param string $bucket_id The bucket ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\ResourceOwners|\InfluxDB2\Model\Error | getBucketsIDOwners | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function getBucketsIDOwnersWithHttpInfo($bucket_id, $zap_trace_span = null)
{
$request = $this->getBucketsIDOwnersRequest($bucket_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\ResourceOwners';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation getBucketsIDOwnersWithHttpInfo
List all owners of a bucket
@param string $bucket_id The bucket 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\ResourceOwners|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getBucketsIDOwnersWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
protected function getBucketsIDOwnersRequest($bucket_id, $zap_trace_span = null)
{
// verify the required parameter 'bucket_id' is set
if ($bucket_id === null || (is_array($bucket_id) && count($bucket_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $bucket_id when calling getBucketsIDOwners'
);
}
$resourcePath = '/api/v2/buckets/{bucketID}/owners';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($bucket_id !== null) {
$resourcePath = str_replace(
'{' . 'bucketID' . '}',
ObjectSerializer::toPathValue($bucket_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 'getBucketsIDOwners'
@param string $bucket_id The bucket ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getBucketsIDOwnersRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function getSourcesIDBuckets($source_id, $zap_trace_span = null, $org = null)
{
list($response) = $this->getSourcesIDBucketsWithHttpInfo($source_id, $zap_trace_span, $org);
return $response;
} | Operation getSourcesIDBuckets
Get buckets in a source
@param string $source_id The source ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $org The name of the organization. (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Buckets|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | getSourcesIDBuckets | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function getSourcesIDBucketsWithHttpInfo($source_id, $zap_trace_span = null, $org = null)
{
$request = $this->getSourcesIDBucketsRequest($source_id, $zap_trace_span, $org);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Buckets';
$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 getSourcesIDBucketsWithHttpInfo
Get buckets in a source
@param string $source_id The source ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $org The name of the organization. (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Buckets|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getSourcesIDBucketsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
protected function getSourcesIDBucketsRequest($source_id, $zap_trace_span = null, $org = null)
{
// verify the required parameter 'source_id' is set
if ($source_id === null || (is_array($source_id) && count($source_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $source_id when calling getSourcesIDBuckets'
);
}
$resourcePath = '/api/v2/sources/{sourceID}/buckets';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// query params
if ($org !== null) {
$queryParams['org'] = ObjectSerializer::toQueryValue($org);
}
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($source_id !== null) {
$resourcePath = str_replace(
'{' . 'sourceID' . '}',
ObjectSerializer::toPathValue($source_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 'getSourcesIDBuckets'
@param string $source_id The source ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $org The name of the organization. (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getSourcesIDBucketsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function patchBucketsID($bucket_id, $patch_bucket_request, $zap_trace_span = null)
{
list($response) = $this->patchBucketsIDWithHttpInfo($bucket_id, $patch_bucket_request, $zap_trace_span);
return $response;
} | Operation patchBucketsID
Update a bucket
@param string $bucket_id The bucket ID. (required)
@param \InfluxDB2\Model\PatchBucketRequest $patch_bucket_request The bucket 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\Bucket|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | patchBucketsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function patchBucketsIDWithHttpInfo($bucket_id, $patch_bucket_request, $zap_trace_span = null)
{
$request = $this->patchBucketsIDRequest($bucket_id, $patch_bucket_request, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Bucket';
$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 patchBucketsIDWithHttpInfo
Update a bucket
@param string $bucket_id The bucket ID. (required)
@param \InfluxDB2\Model\PatchBucketRequest $patch_bucket_request The bucket 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\Bucket|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | patchBucketsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
protected function patchBucketsIDRequest($bucket_id, $patch_bucket_request, $zap_trace_span = null)
{
// verify the required parameter 'bucket_id' is set
if ($bucket_id === null || (is_array($bucket_id) && count($bucket_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $bucket_id when calling patchBucketsID'
);
}
// verify the required parameter 'patch_bucket_request' is set
if ($patch_bucket_request === null || (is_array($patch_bucket_request) && count($patch_bucket_request) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $patch_bucket_request when calling patchBucketsID'
);
}
$resourcePath = '/api/v2/buckets/{bucketID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($bucket_id !== null) {
$resourcePath = str_replace(
'{' . 'bucketID' . '}',
ObjectSerializer::toPathValue($bucket_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($patch_bucket_request)) {
$_tempBody = $patch_bucket_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 'patchBucketsID'
@param string $bucket_id The bucket ID. (required)
@param \InfluxDB2\Model\PatchBucketRequest $patch_bucket_request The bucket update to apply. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | patchBucketsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function postBuckets($post_bucket_request, $zap_trace_span = null)
{
list($response) = $this->postBucketsWithHttpInfo($post_bucket_request, $zap_trace_span);
return $response;
} | Operation postBuckets
Create a bucket
@param \InfluxDB2\Model\PostBucketRequest $post_bucket_request Bucket to create (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Bucket|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | postBuckets | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function postBucketsWithHttpInfo($post_bucket_request, $zap_trace_span = null)
{
$request = $this->postBucketsRequest($post_bucket_request, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Bucket';
$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 postBucketsWithHttpInfo
Create a bucket
@param \InfluxDB2\Model\PostBucketRequest $post_bucket_request Bucket 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\Bucket|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | postBucketsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
protected function postBucketsRequest($post_bucket_request, $zap_trace_span = null)
{
// verify the required parameter 'post_bucket_request' is set
if ($post_bucket_request === null || (is_array($post_bucket_request) && count($post_bucket_request) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $post_bucket_request when calling postBuckets'
);
}
$resourcePath = '/api/v2/buckets';
$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($post_bucket_request)) {
$_tempBody = $post_bucket_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 'postBuckets'
@param \InfluxDB2\Model\PostBucketRequest $post_bucket_request Bucket to create (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | postBucketsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function postBucketsIDLabels($bucket_id, $label_mapping, $zap_trace_span = null)
{
list($response) = $this->postBucketsIDLabelsWithHttpInfo($bucket_id, $label_mapping, $zap_trace_span);
return $response;
} | Operation postBucketsIDLabels
Add a label to a bucket
@param string $bucket_id Bucket ID. The ID of the bucket to label. (required)
@param \InfluxDB2\Model\LabelMapping $label_mapping An object that contains a _`labelID`_ to add to the bucket. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\LabelResponse|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | postBucketsIDLabels | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function postBucketsIDLabelsWithHttpInfo($bucket_id, $label_mapping, $zap_trace_span = null)
{
$request = $this->postBucketsIDLabelsRequest($bucket_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 postBucketsIDLabelsWithHttpInfo
Add a label to a bucket
@param string $bucket_id Bucket ID. The ID of the bucket to label. (required)
@param \InfluxDB2\Model\LabelMapping $label_mapping An object that contains a _`labelID`_ to add to the bucket. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\LabelResponse|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | postBucketsIDLabelsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
protected function postBucketsIDLabelsRequest($bucket_id, $label_mapping, $zap_trace_span = null)
{
// verify the required parameter 'bucket_id' is set
if ($bucket_id === null || (is_array($bucket_id) && count($bucket_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $bucket_id when calling postBucketsIDLabels'
);
}
// 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 postBucketsIDLabels'
);
}
$resourcePath = '/api/v2/buckets/{bucketID}/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 ($bucket_id !== null) {
$resourcePath = str_replace(
'{' . 'bucketID' . '}',
ObjectSerializer::toPathValue($bucket_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 'postBucketsIDLabels'
@param string $bucket_id Bucket ID. The ID of the bucket to label. (required)
@param \InfluxDB2\Model\LabelMapping $label_mapping An object that contains a _`labelID`_ to add to the bucket. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | postBucketsIDLabelsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function postBucketsIDMembers($bucket_id, $add_resource_member_request_body, $zap_trace_span = null)
{
list($response) = $this->postBucketsIDMembersWithHttpInfo($bucket_id, $add_resource_member_request_body, $zap_trace_span);
return $response;
} | Operation postBucketsIDMembers
Add a member to a bucket
@param string $bucket_id The ID of the bucket to retrieve users for. (required)
@param \InfluxDB2\Model\AddResourceMemberRequestBody $add_resource_member_request_body A user to add as a member to the bucket. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\ResourceMember|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | postBucketsIDMembers | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.php | MIT |
public function postBucketsIDMembersWithHttpInfo($bucket_id, $add_resource_member_request_body, $zap_trace_span = null)
{
$request = $this->postBucketsIDMembersRequest($bucket_id, $add_resource_member_request_body, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\ResourceMember';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation postBucketsIDMembersWithHttpInfo
Add a member to a bucket
@param string $bucket_id The ID of the bucket to retrieve users for. (required)
@param \InfluxDB2\Model\AddResourceMemberRequestBody $add_resource_member_request_body A user to add as a member to the bucket. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\ResourceMember|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | postBucketsIDMembersWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/BucketsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/BucketsService.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.