code
stringlengths 17
296k
| docstring
stringlengths 30
30.3k
| func_name
stringlengths 1
89
| language
stringclasses 1
value | repo
stringlengths 7
63
| path
stringlengths 7
153
| url
stringlengths 51
209
| license
stringclasses 4
values |
|---|---|---|---|---|---|---|---|
protected function deleteDashboardsIDOwnersIDRequest($user_id, $dashboard_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 deleteDashboardsIDOwnersID'
);
}
// verify the required parameter 'dashboard_id' is set
if ($dashboard_id === null || (is_array($dashboard_id) && count($dashboard_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dashboard_id when calling deleteDashboardsIDOwnersID'
);
}
$resourcePath = '/api/v2/dashboards/{dashboardID}/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 ($dashboard_id !== null) {
$resourcePath = str_replace(
'{' . 'dashboardID' . '}',
ObjectSerializer::toPathValue($dashboard_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 'deleteDashboardsIDOwnersID'
@param string $user_id The ID of the owner to remove. (required)
@param string $dashboard_id The dashboard ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | deleteDashboardsIDOwnersIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function getDashboards($zap_trace_span = null, $offset = null, $limit = 20, $descending = false, $owner = null, $sort_by = null, $id = null, $org_id = null, $org = null)
{
list($response) = $this->getDashboardsWithHttpInfo($zap_trace_span, $offset, $limit, $descending, $owner, $sort_by, $id, $org_id, $org);
return $response;
} | Operation getDashboards
List all dashboards
@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 bool $descending descending (optional, default to false)
@param string $owner A user identifier. Returns only dashboards where this user has the `owner` role. (optional)
@param string $sort_by The column to sort by. (optional)
@param string[] $id A list of dashboard identifiers. Returns only the listed dashboards. If both `id` and `owner` are specified, only `id` is used. (optional)
@param string $org_id The identifier of the organization. (optional)
@param string $org The name of the organization. (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Dashboards|\InfluxDB2\Model\Error | getDashboards | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function getDashboardsWithHttpInfo($zap_trace_span = null, $offset = null, $limit = 20, $descending = false, $owner = null, $sort_by = null, $id = null, $org_id = null, $org = null)
{
$request = $this->getDashboardsRequest($zap_trace_span, $offset, $limit, $descending, $owner, $sort_by, $id, $org_id, $org);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Dashboards';
$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 getDashboardsWithHttpInfo
List all dashboards
@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 bool $descending (optional, default to false)
@param string $owner A user identifier. Returns only dashboards where this user has the `owner` role. (optional)
@param string $sort_by The column to sort by. (optional)
@param string[] $id A list of dashboard identifiers. Returns only the listed dashboards. If both `id` and `owner` are specified, only `id` is used. (optional)
@param string $org_id The identifier of the organization. (optional)
@param string $org The name of the organization. (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Dashboards|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getDashboardsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
protected function getDashboardsRequest($zap_trace_span = null, $offset = null, $limit = 20, $descending = false, $owner = null, $sort_by = null, $id = null, $org_id = null, $org = null)
{
if ($offset !== null && $offset < 0) {
throw new \InvalidArgumentException('invalid value for "$offset" when calling DashboardsService.getDashboards, must be bigger than or equal to 0.');
}
if ($limit !== null && $limit > 100) {
throw new \InvalidArgumentException('invalid value for "$limit" when calling DashboardsService.getDashboards, must be smaller than or equal to 100.');
}
if ($limit !== null && $limit < 1) {
throw new \InvalidArgumentException('invalid value for "$limit" when calling DashboardsService.getDashboards, must be bigger than or equal to 1.');
}
$resourcePath = '/api/v2/dashboards';
$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 ($descending !== null) {
$queryParams['descending'] = ObjectSerializer::toQueryValue($descending);
}
// query params
if ($owner !== null) {
$queryParams['owner'] = ObjectSerializer::toQueryValue($owner);
}
// query params
if ($sort_by !== null) {
$queryParams['sortBy'] = ObjectSerializer::toQueryValue($sort_by);
}
// 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 'getDashboards'
@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 bool $descending (optional, default to false)
@param string $owner A user identifier. Returns only dashboards where this user has the `owner` role. (optional)
@param string $sort_by The column to sort by. (optional)
@param string[] $id A list of dashboard identifiers. Returns only the listed dashboards. If both `id` and `owner` are specified, only `id` is used. (optional)
@param string $org_id The identifier of the organization. (optional)
@param string $org The name of the organization. (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getDashboardsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function getDashboardsID($dashboard_id, $zap_trace_span = null, $include = null)
{
list($response) = $this->getDashboardsIDWithHttpInfo($dashboard_id, $zap_trace_span, $include);
return $response;
} | Operation getDashboardsID
Retrieve a dashboard
@param string $dashboard_id The ID of the dashboard to update. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $include If `properties`, includes the cell view properties in the response. (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Dashboard|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | getDashboardsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function getDashboardsIDWithHttpInfo($dashboard_id, $zap_trace_span = null, $include = null)
{
$request = $this->getDashboardsIDRequest($dashboard_id, $zap_trace_span, $include);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Dashboard';
$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 getDashboardsIDWithHttpInfo
Retrieve a dashboard
@param string $dashboard_id The ID of the dashboard to update. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $include If `properties`, includes the cell view properties in the response. (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Dashboard|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getDashboardsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
protected function getDashboardsIDRequest($dashboard_id, $zap_trace_span = null, $include = null)
{
// verify the required parameter 'dashboard_id' is set
if ($dashboard_id === null || (is_array($dashboard_id) && count($dashboard_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dashboard_id when calling getDashboardsID'
);
}
$resourcePath = '/api/v2/dashboards/{dashboardID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// query params
if ($include !== null) {
$queryParams['include'] = ObjectSerializer::toQueryValue($include);
}
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($dashboard_id !== null) {
$resourcePath = str_replace(
'{' . 'dashboardID' . '}',
ObjectSerializer::toPathValue($dashboard_id),
$resourcePath
);
}
// 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 'getDashboardsID'
@param string $dashboard_id The ID of the dashboard to update. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param string $include If `properties`, includes the cell view properties in the response. (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getDashboardsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function getDashboardsIDCellsIDView($dashboard_id, $cell_id, $zap_trace_span = null)
{
list($response) = $this->getDashboardsIDCellsIDViewWithHttpInfo($dashboard_id, $cell_id, $zap_trace_span);
return $response;
} | Operation getDashboardsIDCellsIDView
Retrieve the view for a cell
@param string $dashboard_id The dashboard ID. (required)
@param string $cell_id The cell ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\View|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | getDashboardsIDCellsIDView | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function getDashboardsIDCellsIDViewWithHttpInfo($dashboard_id, $cell_id, $zap_trace_span = null)
{
$request = $this->getDashboardsIDCellsIDViewRequest($dashboard_id, $cell_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\View';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation getDashboardsIDCellsIDViewWithHttpInfo
Retrieve the view for a cell
@param string $dashboard_id The dashboard ID. (required)
@param string $cell_id The cell ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\View|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getDashboardsIDCellsIDViewWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
protected function getDashboardsIDCellsIDViewRequest($dashboard_id, $cell_id, $zap_trace_span = null)
{
// verify the required parameter 'dashboard_id' is set
if ($dashboard_id === null || (is_array($dashboard_id) && count($dashboard_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dashboard_id when calling getDashboardsIDCellsIDView'
);
}
// verify the required parameter 'cell_id' is set
if ($cell_id === null || (is_array($cell_id) && count($cell_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $cell_id when calling getDashboardsIDCellsIDView'
);
}
$resourcePath = '/api/v2/dashboards/{dashboardID}/cells/{cellID}/view';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($dashboard_id !== null) {
$resourcePath = str_replace(
'{' . 'dashboardID' . '}',
ObjectSerializer::toPathValue($dashboard_id),
$resourcePath
);
}
// path params
if ($cell_id !== null) {
$resourcePath = str_replace(
'{' . 'cellID' . '}',
ObjectSerializer::toPathValue($cell_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('GET', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'getDashboardsIDCellsIDView'
@param string $dashboard_id The dashboard ID. (required)
@param string $cell_id The cell ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getDashboardsIDCellsIDViewRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function getDashboardsIDLabels($dashboard_id, $zap_trace_span = null)
{
list($response) = $this->getDashboardsIDLabelsWithHttpInfo($dashboard_id, $zap_trace_span);
return $response;
} | Operation getDashboardsIDLabels
List all labels for a dashboard
@param string $dashboard_id The dashboard 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 | getDashboardsIDLabels | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function getDashboardsIDLabelsWithHttpInfo($dashboard_id, $zap_trace_span = null)
{
$request = $this->getDashboardsIDLabelsRequest($dashboard_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 getDashboardsIDLabelsWithHttpInfo
List all labels for a dashboard
@param string $dashboard_id The dashboard 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) | getDashboardsIDLabelsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
protected function getDashboardsIDLabelsRequest($dashboard_id, $zap_trace_span = null)
{
// verify the required parameter 'dashboard_id' is set
if ($dashboard_id === null || (is_array($dashboard_id) && count($dashboard_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dashboard_id when calling getDashboardsIDLabels'
);
}
$resourcePath = '/api/v2/dashboards/{dashboardID}/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 ($dashboard_id !== null) {
$resourcePath = str_replace(
'{' . 'dashboardID' . '}',
ObjectSerializer::toPathValue($dashboard_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 'getDashboardsIDLabels'
@param string $dashboard_id The dashboard ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getDashboardsIDLabelsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function getDashboardsIDMembers($dashboard_id, $zap_trace_span = null)
{
list($response) = $this->getDashboardsIDMembersWithHttpInfo($dashboard_id, $zap_trace_span);
return $response;
} | Operation getDashboardsIDMembers
List all dashboard members
@param string $dashboard_id The dashboard 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 | getDashboardsIDMembers | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function getDashboardsIDMembersWithHttpInfo($dashboard_id, $zap_trace_span = null)
{
$request = $this->getDashboardsIDMembersRequest($dashboard_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 getDashboardsIDMembersWithHttpInfo
List all dashboard members
@param string $dashboard_id The dashboard 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) | getDashboardsIDMembersWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
protected function getDashboardsIDMembersRequest($dashboard_id, $zap_trace_span = null)
{
// verify the required parameter 'dashboard_id' is set
if ($dashboard_id === null || (is_array($dashboard_id) && count($dashboard_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dashboard_id when calling getDashboardsIDMembers'
);
}
$resourcePath = '/api/v2/dashboards/{dashboardID}/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 ($dashboard_id !== null) {
$resourcePath = str_replace(
'{' . 'dashboardID' . '}',
ObjectSerializer::toPathValue($dashboard_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 'getDashboardsIDMembers'
@param string $dashboard_id The dashboard ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getDashboardsIDMembersRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function getDashboardsIDOwners($dashboard_id, $zap_trace_span = null)
{
list($response) = $this->getDashboardsIDOwnersWithHttpInfo($dashboard_id, $zap_trace_span);
return $response;
} | Operation getDashboardsIDOwners
List all dashboard owners
@param string $dashboard_id The dashboard 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 | getDashboardsIDOwners | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function getDashboardsIDOwnersWithHttpInfo($dashboard_id, $zap_trace_span = null)
{
$request = $this->getDashboardsIDOwnersRequest($dashboard_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 getDashboardsIDOwnersWithHttpInfo
List all dashboard owners
@param string $dashboard_id The dashboard 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) | getDashboardsIDOwnersWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
protected function getDashboardsIDOwnersRequest($dashboard_id, $zap_trace_span = null)
{
// verify the required parameter 'dashboard_id' is set
if ($dashboard_id === null || (is_array($dashboard_id) && count($dashboard_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dashboard_id when calling getDashboardsIDOwners'
);
}
$resourcePath = '/api/v2/dashboards/{dashboardID}/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 ($dashboard_id !== null) {
$resourcePath = str_replace(
'{' . 'dashboardID' . '}',
ObjectSerializer::toPathValue($dashboard_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 'getDashboardsIDOwners'
@param string $dashboard_id The dashboard ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getDashboardsIDOwnersRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function patchDashboardsID($dashboard_id, $zap_trace_span = null, $patch_dashboard_request = null)
{
list($response) = $this->patchDashboardsIDWithHttpInfo($dashboard_id, $zap_trace_span, $patch_dashboard_request);
return $response;
} | Operation patchDashboardsID
Update a dashboard
@param string $dashboard_id The ID of the dashboard to update. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param \InfluxDB2\Model\PatchDashboardRequest $patch_dashboard_request patch_dashboard_request (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Dashboard|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | patchDashboardsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function patchDashboardsIDWithHttpInfo($dashboard_id, $zap_trace_span = null, $patch_dashboard_request = null)
{
$request = $this->patchDashboardsIDRequest($dashboard_id, $zap_trace_span, $patch_dashboard_request);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Dashboard';
$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 patchDashboardsIDWithHttpInfo
Update a dashboard
@param string $dashboard_id The ID of the dashboard to update. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param \InfluxDB2\Model\PatchDashboardRequest $patch_dashboard_request (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Dashboard|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | patchDashboardsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
protected function patchDashboardsIDRequest($dashboard_id, $zap_trace_span = null, $patch_dashboard_request = null)
{
// verify the required parameter 'dashboard_id' is set
if ($dashboard_id === null || (is_array($dashboard_id) && count($dashboard_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dashboard_id when calling patchDashboardsID'
);
}
$resourcePath = '/api/v2/dashboards/{dashboardID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($dashboard_id !== null) {
$resourcePath = str_replace(
'{' . 'dashboardID' . '}',
ObjectSerializer::toPathValue($dashboard_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($patch_dashboard_request)) {
$_tempBody = $patch_dashboard_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 'patchDashboardsID'
@param string $dashboard_id The ID of the dashboard to update. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@param \InfluxDB2\Model\PatchDashboardRequest $patch_dashboard_request (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | patchDashboardsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function patchDashboardsIDCellsID($dashboard_id, $cell_id, $cell_update, $zap_trace_span = null)
{
list($response) = $this->patchDashboardsIDCellsIDWithHttpInfo($dashboard_id, $cell_id, $cell_update, $zap_trace_span);
return $response;
} | Operation patchDashboardsIDCellsID
Update the non-positional information related to a cell
@param string $dashboard_id The ID of the dashboard to update. (required)
@param string $cell_id The ID of the cell to update. (required)
@param \InfluxDB2\Model\CellUpdate $cell_update cell_update (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Cell|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | patchDashboardsIDCellsID | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function patchDashboardsIDCellsIDWithHttpInfo($dashboard_id, $cell_id, $cell_update, $zap_trace_span = null)
{
$request = $this->patchDashboardsIDCellsIDRequest($dashboard_id, $cell_id, $cell_update, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Cell';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation patchDashboardsIDCellsIDWithHttpInfo
Update the non-positional information related to a cell
@param string $dashboard_id The ID of the dashboard to update. (required)
@param string $cell_id The ID of the cell to update. (required)
@param \InfluxDB2\Model\CellUpdate $cell_update (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Cell|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | patchDashboardsIDCellsIDWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
protected function patchDashboardsIDCellsIDRequest($dashboard_id, $cell_id, $cell_update, $zap_trace_span = null)
{
// verify the required parameter 'dashboard_id' is set
if ($dashboard_id === null || (is_array($dashboard_id) && count($dashboard_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dashboard_id when calling patchDashboardsIDCellsID'
);
}
// verify the required parameter 'cell_id' is set
if ($cell_id === null || (is_array($cell_id) && count($cell_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $cell_id when calling patchDashboardsIDCellsID'
);
}
// verify the required parameter 'cell_update' is set
if ($cell_update === null || (is_array($cell_update) && count($cell_update) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $cell_update when calling patchDashboardsIDCellsID'
);
}
$resourcePath = '/api/v2/dashboards/{dashboardID}/cells/{cellID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($dashboard_id !== null) {
$resourcePath = str_replace(
'{' . 'dashboardID' . '}',
ObjectSerializer::toPathValue($dashboard_id),
$resourcePath
);
}
// path params
if ($cell_id !== null) {
$resourcePath = str_replace(
'{' . 'cellID' . '}',
ObjectSerializer::toPathValue($cell_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($cell_update)) {
$_tempBody = $cell_update;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('PATCH', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'patchDashboardsIDCellsID'
@param string $dashboard_id The ID of the dashboard to update. (required)
@param string $cell_id The ID of the cell to update. (required)
@param \InfluxDB2\Model\CellUpdate $cell_update (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | patchDashboardsIDCellsIDRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function patchDashboardsIDCellsIDView($dashboard_id, $cell_id, $view, $zap_trace_span = null)
{
list($response) = $this->patchDashboardsIDCellsIDViewWithHttpInfo($dashboard_id, $cell_id, $view, $zap_trace_span);
return $response;
} | Operation patchDashboardsIDCellsIDView
Update the view for a cell
@param string $dashboard_id The ID of the dashboard to update. (required)
@param string $cell_id The ID of the cell to update. (required)
@param \InfluxDB2\Model\View $view view (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\View|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | patchDashboardsIDCellsIDView | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function patchDashboardsIDCellsIDViewWithHttpInfo($dashboard_id, $cell_id, $view, $zap_trace_span = null)
{
$request = $this->patchDashboardsIDCellsIDViewRequest($dashboard_id, $cell_id, $view, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\View';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation patchDashboardsIDCellsIDViewWithHttpInfo
Update the view for a cell
@param string $dashboard_id The ID of the dashboard to update. (required)
@param string $cell_id The ID of the cell to update. (required)
@param \InfluxDB2\Model\View $view (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\View|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | patchDashboardsIDCellsIDViewWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
protected function patchDashboardsIDCellsIDViewRequest($dashboard_id, $cell_id, $view, $zap_trace_span = null)
{
// verify the required parameter 'dashboard_id' is set
if ($dashboard_id === null || (is_array($dashboard_id) && count($dashboard_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dashboard_id when calling patchDashboardsIDCellsIDView'
);
}
// verify the required parameter 'cell_id' is set
if ($cell_id === null || (is_array($cell_id) && count($cell_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $cell_id when calling patchDashboardsIDCellsIDView'
);
}
// verify the required parameter 'view' is set
if ($view === null || (is_array($view) && count($view) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $view when calling patchDashboardsIDCellsIDView'
);
}
$resourcePath = '/api/v2/dashboards/{dashboardID}/cells/{cellID}/view';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($dashboard_id !== null) {
$resourcePath = str_replace(
'{' . 'dashboardID' . '}',
ObjectSerializer::toPathValue($dashboard_id),
$resourcePath
);
}
// path params
if ($cell_id !== null) {
$resourcePath = str_replace(
'{' . 'cellID' . '}',
ObjectSerializer::toPathValue($cell_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($view)) {
$_tempBody = $view;
}
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 'patchDashboardsIDCellsIDView'
@param string $dashboard_id The ID of the dashboard to update. (required)
@param string $cell_id The ID of the cell to update. (required)
@param \InfluxDB2\Model\View $view (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | patchDashboardsIDCellsIDViewRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function postDashboards($create_dashboard_request, $zap_trace_span = null)
{
list($response) = $this->postDashboardsWithHttpInfo($create_dashboard_request, $zap_trace_span);
return $response;
} | Operation postDashboards
Create a dashboard
@param \InfluxDB2\Model\CreateDashboardRequest $create_dashboard_request Dashboard to create (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Dashboard|\InfluxDB2\Model\Error | postDashboards | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function postDashboardsWithHttpInfo($create_dashboard_request, $zap_trace_span = null)
{
$request = $this->postDashboardsRequest($create_dashboard_request, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Dashboard';
$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 postDashboardsWithHttpInfo
Create a dashboard
@param \InfluxDB2\Model\CreateDashboardRequest $create_dashboard_request Dashboard 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\Dashboard|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | postDashboardsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
protected function postDashboardsRequest($create_dashboard_request, $zap_trace_span = null)
{
// verify the required parameter 'create_dashboard_request' is set
if ($create_dashboard_request === null || (is_array($create_dashboard_request) && count($create_dashboard_request) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $create_dashboard_request when calling postDashboards'
);
}
$resourcePath = '/api/v2/dashboards';
$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($create_dashboard_request)) {
$_tempBody = $create_dashboard_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 'postDashboards'
@param \InfluxDB2\Model\CreateDashboardRequest $create_dashboard_request Dashboard to create (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | postDashboardsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function postDashboardsIDCells($dashboard_id, $create_cell, $zap_trace_span = null)
{
list($response) = $this->postDashboardsIDCellsWithHttpInfo($dashboard_id, $create_cell, $zap_trace_span);
return $response;
} | Operation postDashboardsIDCells
Create a dashboard cell
@param string $dashboard_id The ID of the dashboard to update. (required)
@param \InfluxDB2\Model\CreateCell $create_cell Cell that will be added (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Cell|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | postDashboardsIDCells | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function postDashboardsIDCellsWithHttpInfo($dashboard_id, $create_cell, $zap_trace_span = null)
{
$request = $this->postDashboardsIDCellsRequest($dashboard_id, $create_cell, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Cell';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation postDashboardsIDCellsWithHttpInfo
Create a dashboard cell
@param string $dashboard_id The ID of the dashboard to update. (required)
@param \InfluxDB2\Model\CreateCell $create_cell Cell that will be added (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Cell|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | postDashboardsIDCellsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
protected function postDashboardsIDCellsRequest($dashboard_id, $create_cell, $zap_trace_span = null)
{
// verify the required parameter 'dashboard_id' is set
if ($dashboard_id === null || (is_array($dashboard_id) && count($dashboard_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dashboard_id when calling postDashboardsIDCells'
);
}
// verify the required parameter 'create_cell' is set
if ($create_cell === null || (is_array($create_cell) && count($create_cell) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $create_cell when calling postDashboardsIDCells'
);
}
$resourcePath = '/api/v2/dashboards/{dashboardID}/cells';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($dashboard_id !== null) {
$resourcePath = str_replace(
'{' . 'dashboardID' . '}',
ObjectSerializer::toPathValue($dashboard_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($create_cell)) {
$_tempBody = $create_cell;
}
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 'postDashboardsIDCells'
@param string $dashboard_id The ID of the dashboard to update. (required)
@param \InfluxDB2\Model\CreateCell $create_cell Cell that will be added (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | postDashboardsIDCellsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function postDashboardsIDLabels($dashboard_id, $label_mapping, $zap_trace_span = null)
{
list($response) = $this->postDashboardsIDLabelsWithHttpInfo($dashboard_id, $label_mapping, $zap_trace_span);
return $response;
} | Operation postDashboardsIDLabels
Add a label to a dashboard
@param string $dashboard_id The dashboard 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 | postDashboardsIDLabels | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function postDashboardsIDLabelsWithHttpInfo($dashboard_id, $label_mapping, $zap_trace_span = null)
{
$request = $this->postDashboardsIDLabelsRequest($dashboard_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 postDashboardsIDLabelsWithHttpInfo
Add a label to a dashboard
@param string $dashboard_id The dashboard 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) | postDashboardsIDLabelsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
protected function postDashboardsIDLabelsRequest($dashboard_id, $label_mapping, $zap_trace_span = null)
{
// verify the required parameter 'dashboard_id' is set
if ($dashboard_id === null || (is_array($dashboard_id) && count($dashboard_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dashboard_id when calling postDashboardsIDLabels'
);
}
// 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 postDashboardsIDLabels'
);
}
$resourcePath = '/api/v2/dashboards/{dashboardID}/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 ($dashboard_id !== null) {
$resourcePath = str_replace(
'{' . 'dashboardID' . '}',
ObjectSerializer::toPathValue($dashboard_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 'postDashboardsIDLabels'
@param string $dashboard_id The dashboard 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 | postDashboardsIDLabelsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function postDashboardsIDMembers($dashboard_id, $add_resource_member_request_body, $zap_trace_span = null)
{
list($response) = $this->postDashboardsIDMembersWithHttpInfo($dashboard_id, $add_resource_member_request_body, $zap_trace_span);
return $response;
} | Operation postDashboardsIDMembers
Add a member to a dashboard
@param string $dashboard_id The dashboard 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 | postDashboardsIDMembers | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function postDashboardsIDMembersWithHttpInfo($dashboard_id, $add_resource_member_request_body, $zap_trace_span = null)
{
$request = $this->postDashboardsIDMembersRequest($dashboard_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 postDashboardsIDMembersWithHttpInfo
Add a member to a dashboard
@param string $dashboard_id The dashboard 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) | postDashboardsIDMembersWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
protected function postDashboardsIDMembersRequest($dashboard_id, $add_resource_member_request_body, $zap_trace_span = null)
{
// verify the required parameter 'dashboard_id' is set
if ($dashboard_id === null || (is_array($dashboard_id) && count($dashboard_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dashboard_id when calling postDashboardsIDMembers'
);
}
// 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 postDashboardsIDMembers'
);
}
$resourcePath = '/api/v2/dashboards/{dashboardID}/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 ($dashboard_id !== null) {
$resourcePath = str_replace(
'{' . 'dashboardID' . '}',
ObjectSerializer::toPathValue($dashboard_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 'postDashboardsIDMembers'
@param string $dashboard_id The dashboard 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 | postDashboardsIDMembersRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function postDashboardsIDOwners($dashboard_id, $add_resource_member_request_body, $zap_trace_span = null)
{
list($response) = $this->postDashboardsIDOwnersWithHttpInfo($dashboard_id, $add_resource_member_request_body, $zap_trace_span);
return $response;
} | Operation postDashboardsIDOwners
Add an owner to a dashboard
@param string $dashboard_id The dashboard 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 | postDashboardsIDOwners | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function postDashboardsIDOwnersWithHttpInfo($dashboard_id, $add_resource_member_request_body, $zap_trace_span = null)
{
$request = $this->postDashboardsIDOwnersRequest($dashboard_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 postDashboardsIDOwnersWithHttpInfo
Add an owner to a dashboard
@param string $dashboard_id The dashboard 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) | postDashboardsIDOwnersWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
protected function postDashboardsIDOwnersRequest($dashboard_id, $add_resource_member_request_body, $zap_trace_span = null)
{
// verify the required parameter 'dashboard_id' is set
if ($dashboard_id === null || (is_array($dashboard_id) && count($dashboard_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dashboard_id when calling postDashboardsIDOwners'
);
}
// 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 postDashboardsIDOwners'
);
}
$resourcePath = '/api/v2/dashboards/{dashboardID}/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 ($dashboard_id !== null) {
$resourcePath = str_replace(
'{' . 'dashboardID' . '}',
ObjectSerializer::toPathValue($dashboard_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 'postDashboardsIDOwners'
@param string $dashboard_id The dashboard 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 | postDashboardsIDOwnersRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function putDashboardsIDCells($dashboard_id, $cell, $zap_trace_span = null)
{
list($response) = $this->putDashboardsIDCellsWithHttpInfo($dashboard_id, $cell, $zap_trace_span);
return $response;
} | Operation putDashboardsIDCells
Replace cells in a dashboard
@param string $dashboard_id The ID of the dashboard to update. (required)
@param \InfluxDB2\Model\Cell[] $cell cell (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\Dashboard|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | putDashboardsIDCells | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function putDashboardsIDCellsWithHttpInfo($dashboard_id, $cell, $zap_trace_span = null)
{
$request = $this->putDashboardsIDCellsRequest($dashboard_id, $cell, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\Dashboard';
$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 putDashboardsIDCellsWithHttpInfo
Replace cells in a dashboard
@param string $dashboard_id The ID of the dashboard to update. (required)
@param \InfluxDB2\Model\Cell[] $cell (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\Dashboard|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | putDashboardsIDCellsWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
protected function putDashboardsIDCellsRequest($dashboard_id, $cell, $zap_trace_span = null)
{
// verify the required parameter 'dashboard_id' is set
if ($dashboard_id === null || (is_array($dashboard_id) && count($dashboard_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dashboard_id when calling putDashboardsIDCells'
);
}
// verify the required parameter 'cell' is set
if ($cell === null || (is_array($cell) && count($cell) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $cell when calling putDashboardsIDCells'
);
}
$resourcePath = '/api/v2/dashboards/{dashboardID}/cells';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($dashboard_id !== null) {
$resourcePath = str_replace(
'{' . 'dashboardID' . '}',
ObjectSerializer::toPathValue($dashboard_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($cell)) {
$_tempBody = $cell;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('PUT', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'putDashboardsIDCells'
@param string $dashboard_id The ID of the dashboard to update. (required)
@param \InfluxDB2\Model\Cell[] $cell (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | putDashboardsIDCellsRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/DashboardsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/DashboardsService.php | MIT |
public function getDashboardsIDCellsIDView($dashboard_id, $cell_id, $zap_trace_span = null)
{
list($response) = $this->getDashboardsIDCellsIDViewWithHttpInfo($dashboard_id, $cell_id, $zap_trace_span);
return $response;
} | Operation getDashboardsIDCellsIDView
Retrieve the view for a cell
@param string $dashboard_id The dashboard ID. (required)
@param string $cell_id The cell ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\View|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | getDashboardsIDCellsIDView | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ViewsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ViewsService.php | MIT |
public function getDashboardsIDCellsIDViewWithHttpInfo($dashboard_id, $cell_id, $zap_trace_span = null)
{
$request = $this->getDashboardsIDCellsIDViewRequest($dashboard_id, $cell_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\View';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation getDashboardsIDCellsIDViewWithHttpInfo
Retrieve the view for a cell
@param string $dashboard_id The dashboard ID. (required)
@param string $cell_id The cell ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\View|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | getDashboardsIDCellsIDViewWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ViewsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ViewsService.php | MIT |
protected function getDashboardsIDCellsIDViewRequest($dashboard_id, $cell_id, $zap_trace_span = null)
{
// verify the required parameter 'dashboard_id' is set
if ($dashboard_id === null || (is_array($dashboard_id) && count($dashboard_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dashboard_id when calling getDashboardsIDCellsIDView'
);
}
// verify the required parameter 'cell_id' is set
if ($cell_id === null || (is_array($cell_id) && count($cell_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $cell_id when calling getDashboardsIDCellsIDView'
);
}
$resourcePath = '/api/v2/dashboards/{dashboardID}/cells/{cellID}/view';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($dashboard_id !== null) {
$resourcePath = str_replace(
'{' . 'dashboardID' . '}',
ObjectSerializer::toPathValue($dashboard_id),
$resourcePath
);
}
// path params
if ($cell_id !== null) {
$resourcePath = str_replace(
'{' . 'cellID' . '}',
ObjectSerializer::toPathValue($cell_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('GET', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'getDashboardsIDCellsIDView'
@param string $dashboard_id The dashboard ID. (required)
@param string $cell_id The cell ID. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | getDashboardsIDCellsIDViewRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ViewsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ViewsService.php | MIT |
public function patchDashboardsIDCellsIDView($dashboard_id, $cell_id, $view, $zap_trace_span = null)
{
list($response) = $this->patchDashboardsIDCellsIDViewWithHttpInfo($dashboard_id, $cell_id, $view, $zap_trace_span);
return $response;
} | Operation patchDashboardsIDCellsIDView
Update the view for a cell
@param string $dashboard_id The ID of the dashboard to update. (required)
@param string $cell_id The ID of the cell to update. (required)
@param \InfluxDB2\Model\View $view view (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return \InfluxDB2\Model\View|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error | patchDashboardsIDCellsIDView | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ViewsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ViewsService.php | MIT |
public function patchDashboardsIDCellsIDViewWithHttpInfo($dashboard_id, $cell_id, $view, $zap_trace_span = null)
{
$request = $this->patchDashboardsIDCellsIDViewRequest($dashboard_id, $cell_id, $view, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
$returnType = '\InfluxDB2\Model\View';
$responseBody = $response->getBody();
if ($returnType === '\SplFileObject') {
$content = $responseBody; //stream goes to serializer
} else {
$content = $responseBody->getContents();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
} | Operation patchDashboardsIDCellsIDViewWithHttpInfo
Update the view for a cell
@param string $dashboard_id The ID of the dashboard to update. (required)
@param string $cell_id The ID of the cell to update. (required)
@param \InfluxDB2\Model\View $view (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of \InfluxDB2\Model\View|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings) | patchDashboardsIDCellsIDViewWithHttpInfo | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ViewsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ViewsService.php | MIT |
protected function patchDashboardsIDCellsIDViewRequest($dashboard_id, $cell_id, $view, $zap_trace_span = null)
{
// verify the required parameter 'dashboard_id' is set
if ($dashboard_id === null || (is_array($dashboard_id) && count($dashboard_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $dashboard_id when calling patchDashboardsIDCellsIDView'
);
}
// verify the required parameter 'cell_id' is set
if ($cell_id === null || (is_array($cell_id) && count($cell_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $cell_id when calling patchDashboardsIDCellsIDView'
);
}
// verify the required parameter 'view' is set
if ($view === null || (is_array($view) && count($view) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $view when calling patchDashboardsIDCellsIDView'
);
}
$resourcePath = '/api/v2/dashboards/{dashboardID}/cells/{cellID}/view';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($dashboard_id !== null) {
$resourcePath = str_replace(
'{' . 'dashboardID' . '}',
ObjectSerializer::toPathValue($dashboard_id),
$resourcePath
);
}
// path params
if ($cell_id !== null) {
$resourcePath = str_replace(
'{' . 'cellID' . '}',
ObjectSerializer::toPathValue($cell_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($view)) {
$_tempBody = $view;
}
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 'patchDashboardsIDCellsIDView'
@param string $dashboard_id The ID of the dashboard to update. (required)
@param string $cell_id The ID of the cell to update. (required)
@param \InfluxDB2\Model\View $view (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | patchDashboardsIDCellsIDViewRequest | php | influxdata/influxdb-client-php | src/InfluxDB2/Service/ViewsService.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Service/ViewsService.php | MIT |
public static function openAPITypes()
{
return self::$openAPITypes;
} | Array of property to type mappings. Used for (de)serialization
@return array | openAPITypes | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/Query.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/Query.php | MIT |
public static function openAPIFormats()
{
return self::$openAPIFormats;
} | Array of property to format mappings. Used for (de)serialization
@return array | openAPIFormats | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/Query.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/Query.php | MIT |
public static function attributeMap()
{
return self::$attributeMap;
} | Array of attributes where the key is the local name,
and the value is the original name
@return array | attributeMap | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/Query.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/Query.php | MIT |
public static function setters()
{
return self::$setters;
} | Array of attributes to setter functions (for deserialization of responses)
@return array | setters | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/Query.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/Query.php | MIT |
public static function getters()
{
return self::$getters;
} | Array of attributes to getter functions (for serialization of requests)
@return array | getters | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/Query.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/Query.php | MIT |
public function getModelName()
{
return self::$openAPIModelName;
} | The original name of the model.
@return string | getModelName | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/Query.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/Query.php | MIT |
public function getTypeAllowableValues()
{
return [
self::TYPE_FLUX,
];
} | Gets allowable values of the enum
@return string[] | getTypeAllowableValues | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/Query.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/Query.php | MIT |
public function __construct(array $data = null)
{
$this->container['extern'] = isset($data['extern']) ? $data['extern'] : null;
$this->container['query'] = isset($data['query']) ? $data['query'] : null;
$this->container['type'] = isset($data['type']) ? $data['type'] : null;
$this->container['params'] = isset($data['params']) ? $data['params'] : null;
$this->container['dialect'] = isset($data['dialect']) ? $data['dialect'] : null;
$this->container['now'] = isset($data['now']) ? $data['now'] : null;
} | Constructor
@param mixed[] $data Associated array of property values
initializing the model | __construct | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/Query.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/Query.php | MIT |
public function listInvalidProperties()
{
$invalidProperties = [];
if ($this->container['query'] === null) {
$invalidProperties[] = "'query' can't be null";
}
$allowedValues = $this->getTypeAllowableValues();
if (!is_null($this->container['type']) && !in_array($this->container['type'], $allowedValues, true)) {
$invalidProperties[] = sprintf(
"invalid value for 'type', must be one of '%s'",
implode("', '", $allowedValues)
);
}
return $invalidProperties;
} | Show all the invalid properties with reasons.
@return array invalid properties with reasons | listInvalidProperties | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/Query.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/Query.php | MIT |
public function valid()
{
return count($this->listInvalidProperties()) === 0;
} | Validate all the properties in the model
return true if all passed
@return bool True if all properties are valid | valid | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/Query.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/Query.php | MIT |
public function __toString()
{
return json_encode(
ObjectSerializer::sanitizeForSerialization($this),
JSON_PRETTY_PRINT
);
} | Gets the string presentation of the object
@return string | __toString | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/Query.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/Query.php | MIT |
public static function openAPITypes()
{
return self::$openAPITypes;
} | Array of property to type mappings. Used for (de)serialization
@return array | openAPITypes | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/TemplateSummarySummary.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/TemplateSummarySummary.php | MIT |
public static function openAPIFormats()
{
return self::$openAPIFormats;
} | Array of property to format mappings. Used for (de)serialization
@return array | openAPIFormats | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/TemplateSummarySummary.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/TemplateSummarySummary.php | MIT |
public static function attributeMap()
{
return self::$attributeMap;
} | Array of attributes where the key is the local name,
and the value is the original name
@return array | attributeMap | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/TemplateSummarySummary.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/TemplateSummarySummary.php | MIT |
public static function setters()
{
return self::$setters;
} | Array of attributes to setter functions (for deserialization of responses)
@return array | setters | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/TemplateSummarySummary.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/TemplateSummarySummary.php | MIT |
public static function getters()
{
return self::$getters;
} | Array of attributes to getter functions (for serialization of requests)
@return array | getters | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/TemplateSummarySummary.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/TemplateSummarySummary.php | MIT |
public function getModelName()
{
return self::$openAPIModelName;
} | The original name of the model.
@return string | getModelName | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/TemplateSummarySummary.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/TemplateSummarySummary.php | MIT |
public function __construct(array $data = null)
{
$this->container['buckets'] = isset($data['buckets']) ? $data['buckets'] : null;
$this->container['checks'] = isset($data['checks']) ? $data['checks'] : null;
$this->container['dashboards'] = isset($data['dashboards']) ? $data['dashboards'] : null;
$this->container['labels'] = isset($data['labels']) ? $data['labels'] : null;
$this->container['label_mappings'] = isset($data['label_mappings']) ? $data['label_mappings'] : null;
$this->container['missing_env_refs'] = isset($data['missing_env_refs']) ? $data['missing_env_refs'] : null;
$this->container['missing_secrets'] = isset($data['missing_secrets']) ? $data['missing_secrets'] : null;
$this->container['notification_endpoints'] = isset($data['notification_endpoints']) ? $data['notification_endpoints'] : null;
$this->container['notification_rules'] = isset($data['notification_rules']) ? $data['notification_rules'] : null;
$this->container['tasks'] = isset($data['tasks']) ? $data['tasks'] : null;
$this->container['telegraf_configs'] = isset($data['telegraf_configs']) ? $data['telegraf_configs'] : null;
$this->container['variables'] = isset($data['variables']) ? $data['variables'] : null;
} | Constructor
@param mixed[] $data Associated array of property values
initializing the model | __construct | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/TemplateSummarySummary.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/TemplateSummarySummary.php | MIT |
public function listInvalidProperties()
{
$invalidProperties = [];
return $invalidProperties;
} | Show all the invalid properties with reasons.
@return array invalid properties with reasons | listInvalidProperties | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/TemplateSummarySummary.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/TemplateSummarySummary.php | MIT |
public function valid()
{
return count($this->listInvalidProperties()) === 0;
} | Validate all the properties in the model
return true if all passed
@return bool True if all properties are valid | valid | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/TemplateSummarySummary.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/TemplateSummarySummary.php | MIT |
public function __toString()
{
return json_encode(
ObjectSerializer::sanitizeForSerialization($this),
JSON_PRETTY_PRINT
);
} | Gets the string presentation of the object
@return string | __toString | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/TemplateSummarySummary.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/TemplateSummarySummary.php | MIT |
public static function openAPITypes()
{
return self::$openAPITypes + parent::openAPITypes();
} | Array of property to type mappings. Used for (de)serialization
@return array | openAPITypes | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/Identifier.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/Identifier.php | MIT |
public static function openAPIFormats()
{
return self::$openAPIFormats + parent::openAPIFormats();
} | Array of property to format mappings. Used for (de)serialization
@return array | openAPIFormats | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/Identifier.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/Identifier.php | MIT |
public static function attributeMap()
{
return parent::attributeMap() + self::$attributeMap;
} | Array of attributes where the key is the local name,
and the value is the original name
@return array | attributeMap | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/Identifier.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/Identifier.php | MIT |
public static function setters()
{
return parent::setters() + self::$setters;
} | Array of attributes to setter functions (for deserialization of responses)
@return array | setters | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/Identifier.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/Identifier.php | MIT |
public static function getters()
{
return parent::getters() + self::$getters;
} | Array of attributes to getter functions (for serialization of requests)
@return array | getters | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/Identifier.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/Identifier.php | MIT |
public function getModelName()
{
return self::$openAPIModelName;
} | The original name of the model.
@return string | getModelName | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/Identifier.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/Identifier.php | MIT |
public function __construct(array $data = null)
{
parent::__construct($data);
$this->container['type'] = isset($data['type']) ? $data['type'] : null;
$this->container['name'] = isset($data['name']) ? $data['name'] : null;
} | Constructor
@param mixed[] $data Associated array of property values
initializing the model | __construct | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/Identifier.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/Identifier.php | MIT |
public function listInvalidProperties()
{
$invalidProperties = parent::listInvalidProperties();
return $invalidProperties;
} | Show all the invalid properties with reasons.
@return array invalid properties with reasons | listInvalidProperties | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/Identifier.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/Identifier.php | MIT |
public function valid()
{
return count($this->listInvalidProperties()) === 0;
} | Validate all the properties in the model
return true if all passed
@return bool True if all properties are valid | valid | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/Identifier.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/Identifier.php | MIT |
public function __toString()
{
return json_encode(
ObjectSerializer::sanitizeForSerialization($this),
JSON_PRETTY_PRINT
);
} | Gets the string presentation of the object
@return string | __toString | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/Identifier.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/Identifier.php | MIT |
public static function openAPITypes()
{
return self::$openAPITypes;
} | Array of property to type mappings. Used for (de)serialization
@return array | openAPITypes | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/ThresholdBase.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/ThresholdBase.php | MIT |
public static function openAPIFormats()
{
return self::$openAPIFormats;
} | Array of property to format mappings. Used for (de)serialization
@return array | openAPIFormats | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/ThresholdBase.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/ThresholdBase.php | MIT |
public static function attributeMap()
{
return self::$attributeMap;
} | Array of attributes where the key is the local name,
and the value is the original name
@return array | attributeMap | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/ThresholdBase.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/ThresholdBase.php | MIT |
public static function setters()
{
return self::$setters;
} | Array of attributes to setter functions (for deserialization of responses)
@return array | setters | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/ThresholdBase.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/ThresholdBase.php | MIT |
public static function getters()
{
return self::$getters;
} | Array of attributes to getter functions (for serialization of requests)
@return array | getters | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/ThresholdBase.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/ThresholdBase.php | MIT |
public function getModelName()
{
return self::$openAPIModelName;
} | The original name of the model.
@return string | getModelName | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/ThresholdBase.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/ThresholdBase.php | MIT |
public function __construct(array $data = null)
{
$this->container['level'] = isset($data['level']) ? $data['level'] : null;
$this->container['all_values'] = isset($data['all_values']) ? $data['all_values'] : null;
} | Constructor
@param mixed[] $data Associated array of property values
initializing the model | __construct | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/ThresholdBase.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/ThresholdBase.php | MIT |
public function listInvalidProperties()
{
$invalidProperties = [];
return $invalidProperties;
} | Show all the invalid properties with reasons.
@return array invalid properties with reasons | listInvalidProperties | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/ThresholdBase.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/ThresholdBase.php | MIT |
public function valid()
{
return count($this->listInvalidProperties()) === 0;
} | Validate all the properties in the model
return true if all passed
@return bool True if all properties are valid | valid | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/ThresholdBase.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/ThresholdBase.php | MIT |
public function __toString()
{
return json_encode(
ObjectSerializer::sanitizeForSerialization($this),
JSON_PRETTY_PRINT
);
} | Gets the string presentation of the object
@return string | __toString | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/ThresholdBase.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/ThresholdBase.php | MIT |
public static function openAPITypes()
{
return self::$openAPITypes;
} | Array of property to type mappings. Used for (de)serialization
@return array | openAPITypes | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/UsersLinks.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/UsersLinks.php | MIT |
public static function openAPIFormats()
{
return self::$openAPIFormats;
} | Array of property to format mappings. Used for (de)serialization
@return array | openAPIFormats | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/UsersLinks.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/UsersLinks.php | MIT |
public static function attributeMap()
{
return self::$attributeMap;
} | Array of attributes where the key is the local name,
and the value is the original name
@return array | attributeMap | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/UsersLinks.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/UsersLinks.php | MIT |
public static function setters()
{
return self::$setters;
} | Array of attributes to setter functions (for deserialization of responses)
@return array | setters | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/UsersLinks.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/UsersLinks.php | MIT |
public static function getters()
{
return self::$getters;
} | Array of attributes to getter functions (for serialization of requests)
@return array | getters | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/UsersLinks.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/UsersLinks.php | MIT |
public function getModelName()
{
return self::$openAPIModelName;
} | The original name of the model.
@return string | getModelName | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/UsersLinks.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/UsersLinks.php | MIT |
public function __construct(array $data = null)
{
$this->container['self'] = isset($data['self']) ? $data['self'] : null;
} | Constructor
@param mixed[] $data Associated array of property values
initializing the model | __construct | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/UsersLinks.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/UsersLinks.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.