code
stringlengths 17
247k
| docstring
stringlengths 30
30.3k
| func_name
stringlengths 1
89
| language
stringclasses 1
value | repo
stringlengths 7
63
| path
stringlengths 7
153
| url
stringlengths 51
209
| license
stringclasses 4
values |
|---|---|---|---|---|---|---|---|
public function deleteDashboardsIDLabelsID($dashboard_id, $label_id, $zap_trace_span = null)
{
$this->deleteDashboardsIDLabelsIDWithHttpInfo($dashboard_id, $label_id, $zap_trace_span);
} | Operation deleteDashboardsIDLabelsID
Delete a label from a dashboard
@param string $dashboard_id The dashboard ID. (required)
@param string $label_id The ID of the label to delete. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return void | deleteDashboardsIDLabelsID | 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 deleteDashboardsIDLabelsIDWithHttpInfo($dashboard_id, $label_id, $zap_trace_span = null)
{
$request = $this->deleteDashboardsIDLabelsIDRequest($dashboard_id, $label_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteDashboardsIDLabelsIDWithHttpInfo
Delete a label from a dashboard
@param string $dashboard_id The dashboard ID. (required)
@param string $label_id The ID of the label to delete. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of null, HTTP status code, HTTP response headers (array of strings) | deleteDashboardsIDLabelsIDWithHttpInfo | 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 deleteDashboardsIDLabelsIDRequest($dashboard_id, $label_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 deleteDashboardsIDLabelsID'
);
}
// verify the required parameter 'label_id' is set
if ($label_id === null || (is_array($label_id) && count($label_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $label_id when calling deleteDashboardsIDLabelsID'
);
}
$resourcePath = '/api/v2/dashboards/{dashboardID}/labels/{labelID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($dashboard_id !== null) {
$resourcePath = str_replace(
'{' . 'dashboardID' . '}',
ObjectSerializer::toPathValue($dashboard_id),
$resourcePath
);
}
// path params
if ($label_id !== null) {
$resourcePath = str_replace(
'{' . 'labelID' . '}',
ObjectSerializer::toPathValue($label_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// for model (json/xml)
if (isset($_tempBody)) {
// $_tempBody is the method argument, if present
if ($headers['Content-Type'] === 'application/json') {
$httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($_tempBody));
} else {
$httpBody = $_tempBody;
}
}
$headers = array_merge(
$headerParams,
$headers
);
return $this->defaultApi->createRequest('DELETE', $resourcePath, $httpBody, $headers, $queryParams);
} | Create request for operation 'deleteDashboardsIDLabelsID'
@param string $dashboard_id The dashboard ID. (required)
@param string $label_id The ID of the label to delete. (required)
@param string $zap_trace_span OpenTracing span context (optional)
@throws \InvalidArgumentException
@return \Psr\Http\Message\RequestInterface | deleteDashboardsIDLabelsIDRequest | 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 deleteDashboardsIDMembersID($user_id, $dashboard_id, $zap_trace_span = null)
{
$this->deleteDashboardsIDMembersIDWithHttpInfo($user_id, $dashboard_id, $zap_trace_span);
} | Operation deleteDashboardsIDMembersID
Remove a member from a dashboard
@param string $user_id The ID of the member to remove. (required)
@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 void | deleteDashboardsIDMembersID | 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 deleteDashboardsIDMembersIDWithHttpInfo($user_id, $dashboard_id, $zap_trace_span = null)
{
$request = $this->deleteDashboardsIDMembersIDRequest($user_id, $dashboard_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteDashboardsIDMembersIDWithHttpInfo
Remove a member from a dashboard
@param string $user_id The ID of the member to remove. (required)
@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 null, HTTP status code, HTTP response headers (array of strings) | deleteDashboardsIDMembersIDWithHttpInfo | 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 deleteDashboardsIDMembersIDRequest($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 deleteDashboardsIDMembersID'
);
}
// 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 deleteDashboardsIDMembersID'
);
}
$resourcePath = '/api/v2/dashboards/{dashboardID}/members/{userID}';
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// header params
if ($zap_trace_span !== null) {
$headerParams['Zap-Trace-Span'] = ObjectSerializer::toHeaderValue($zap_trace_span);
}
// path params
if ($user_id !== null) {
$resourcePath = str_replace(
'{' . 'userID' . '}',
ObjectSerializer::toPathValue($user_id),
$resourcePath
);
}
// path params
if ($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 'deleteDashboardsIDMembersID'
@param string $user_id The ID of the member 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 | deleteDashboardsIDMembersIDRequest | 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 deleteDashboardsIDOwnersID($user_id, $dashboard_id, $zap_trace_span = null)
{
$this->deleteDashboardsIDOwnersIDWithHttpInfo($user_id, $dashboard_id, $zap_trace_span);
} | Operation deleteDashboardsIDOwnersID
Remove an owner from a dashboard
@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 \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return void | deleteDashboardsIDOwnersID | 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 deleteDashboardsIDOwnersIDWithHttpInfo($user_id, $dashboard_id, $zap_trace_span = null)
{
$request = $this->deleteDashboardsIDOwnersIDRequest($user_id, $dashboard_id, $zap_trace_span);
$response = $this->defaultApi->sendRequest($request);
return [null, $response->getStatusCode(), $response->getHeaders()];
} | Operation deleteDashboardsIDOwnersIDWithHttpInfo
Remove an owner from a dashboard
@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 \InfluxDB2\ApiException on non-2xx response
@throws \InvalidArgumentException
@return array of null, HTTP status code, HTTP response headers (array of strings) | deleteDashboardsIDOwnersIDWithHttpInfo | 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 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 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 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 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 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 function getLegendOrientationThreshold()
{
return $this->container['legend_orientation_threshold'];
} | Gets legend_orientation_threshold
@return int|null | getLegendOrientationThreshold | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/CheckViewProperties.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/CheckViewProperties.php | MIT |
public function setLegendOrientationThreshold($legend_orientation_threshold)
{
$this->container['legend_orientation_threshold'] = $legend_orientation_threshold;
return $this;
} | Sets legend_orientation_threshold
@param int|null $legend_orientation_threshold legend_orientation_threshold
@return $this | setLegendOrientationThreshold | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/CheckViewProperties.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/CheckViewProperties.php | MIT |
public function getShardGroupDurationSeconds()
{
return $this->container['shard_group_duration_seconds'];
} | Gets shard_group_duration_seconds
@return int|null | getShardGroupDurationSeconds | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/PatchRetentionRule.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/PatchRetentionRule.php | MIT |
public function setShardGroupDurationSeconds($shard_group_duration_seconds)
{
$this->container['shard_group_duration_seconds'] = $shard_group_duration_seconds;
return $this;
} | Sets shard_group_duration_seconds
@param int|null $shard_group_duration_seconds The [shard group duration](https://docs.influxdata.com/influxdb/v2.3/reference/glossary/#shard). The number of seconds that each shard group covers. #### InfluxDB Cloud - Doesn't use `shardGroupDurationsSeconds`. #### InfluxDB OSS - Default value depends on the [bucket retention period](https://docs.influxdata.com/influxdb/v2.3/reference/internals/shards/#shard-group-duration). #### Related guides - InfluxDB [shards and shard groups](https://docs.influxdata.com/influxdb/v2.3/reference/internals/shards/)
@return $this | setShardGroupDurationSeconds | php | influxdata/influxdb-client-php | src/InfluxDB2/Model/PatchRetentionRule.php | https://github.com/influxdata/influxdb-client-php/blob/master/src/InfluxDB2/Model/PatchRetentionRule.php | MIT |
public function identifier($identifier)
{
return $this->setProperty('identifier', $identifier);
} | The identifier property represents any kind of identifier for any kind of
[[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides
dedicated properties for representing many of these, either as textual
strings or as URL (URI) links. See [background
notes](/docs/datamodel.html#identifierBg) for more details.
@param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
@return static
@see https://schema.org/identifier | identifier | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function image($image)
{
return $this->setProperty('image', $image);
} | An image of the item. This can be a [[URL]] or a fully described
[[ImageObject]].
@param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
@return static
@see https://schema.org/image | image | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function interactionStatistic($interactionStatistic)
{
return $this->setProperty('interactionStatistic', $interactionStatistic);
} | The number of interactions for the CreativeWork using the WebSite or
SoftwareApplication. The most specific child type of InteractionCounter
should be used.
@param \Spatie\SchemaOrg\Contracts\InteractionCounterContract|\Spatie\SchemaOrg\Contracts\InteractionCounterContract[] $interactionStatistic
@return static
@see https://schema.org/interactionStatistic
@link https://github.com/schemaorg/schemaorg/issues/2421 | interactionStatistic | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function isAccessibleForFree($isAccessibleForFree)
{
return $this->setProperty('isAccessibleForFree', $isAccessibleForFree);
} | A flag to signal that the item, event, or place is accessible for free.
@param bool|bool[] $isAccessibleForFree
@return static
@see https://schema.org/isAccessibleForFree | isAccessibleForFree | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function isicV4($isicV4)
{
return $this->setProperty('isicV4', $isicV4);
} | The International Standard of Industrial Classification of All Economic
Activities (ISIC), Revision 4 code for a particular organization,
business person, or place.
@param string|string[] $isicV4
@return static
@see https://schema.org/isicV4 | isicV4 | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function iso6523Code($iso6523Code)
{
return $this->setProperty('iso6523Code', $iso6523Code);
} | An organization identifier as defined in [ISO
6523(-1)](https://en.wikipedia.org/wiki/ISO/IEC_6523). The identifier
should be in the `XXXX:YYYYYY:ZZZ` or `XXXX:YYYYYY`format. Where `XXXX`
is a 4 digit _ICD_ (International Code Designator), `YYYYYY` is an _OID_
(Organization Identifier) with all formatting characters (dots, dashes,
spaces) removed with a maximal length of 35 characters, and `ZZZ` is an
optional OPI (Organization Part Identifier) with a maximum length of 35
characters. The various components (ICD, OID, OPI) are joined with a
colon character (ASCII `0x3a`). Note that many existing organization
identifiers defined as attributes like
[leiCode](https://schema.org/leiCode) (`0199`),
[duns](https://schema.org/duns) (`0060`) or
[GLN](https://schema.org/globalLocationNumber) (`0088`) can be expressed
using ISO-6523. If possible, ISO-6523 codes should be preferred to
populating [vatID](https://schema.org/vatID) or
[taxID](https://schema.org/taxID), as ISO identifiers are less ambiguous.
@param string|string[] $iso6523Code
@return static
@see https://schema.org/iso6523Code
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2915 | iso6523Code | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function keywords($keywords)
{
return $this->setProperty('keywords', $keywords);
} | Keywords or tags used to describe some item. Multiple textual entries in
a keywords list are typically delimited by commas, or by repeating the
property.
@param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|string|string[] $keywords
@return static
@see https://schema.org/keywords | keywords | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function knowsAbout($knowsAbout)
{
return $this->setProperty('knowsAbout', $knowsAbout);
} | Of a [[Person]], and less typically of an [[Organization]], to indicate a
topic that is known about - suggesting possible expertise but not
implying it. We do not distinguish skill levels here, or relate this to
educational content, events, objectives or [[JobPosting]] descriptions.
@param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[]|string|string[] $knowsAbout
@return static
@see https://schema.org/knowsAbout
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/1688 | knowsAbout | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function knowsLanguage($knowsLanguage)
{
return $this->setProperty('knowsLanguage', $knowsLanguage);
} | Of a [[Person]], and less typically of an [[Organization]], to indicate a
known language. We do not distinguish skill levels or
reading/writing/speaking/signing here. Use language codes from the [IETF
BCP 47 standard](http://tools.ietf.org/html/bcp47).
@param \Spatie\SchemaOrg\Contracts\LanguageContract|\Spatie\SchemaOrg\Contracts\LanguageContract[]|string|string[] $knowsLanguage
@return static
@see https://schema.org/knowsLanguage
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/1688 | knowsLanguage | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function latitude($latitude)
{
return $this->setProperty('latitude', $latitude);
} | The latitude of a location. For example ```37.42242``` ([WGS
84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
@param float|float[]|int|int[]|string|string[] $latitude
@return static
@see https://schema.org/latitude | latitude | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function legalName($legalName)
{
return $this->setProperty('legalName', $legalName);
} | The official name of the organization, e.g. the registered company name.
@param string|string[] $legalName
@return static
@see https://schema.org/legalName | legalName | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function leiCode($leiCode)
{
return $this->setProperty('leiCode', $leiCode);
} | An organization identifier that uniquely identifies a legal entity as
defined in ISO 17442.
@param string|string[] $leiCode
@return static
@see https://schema.org/leiCode | leiCode | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function location($location)
{
return $this->setProperty('location', $location);
} | The location of, for example, where an event is happening, where an
organization is located, or where an action takes place.
@param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|\Spatie\SchemaOrg\Contracts\VirtualLocationContract|\Spatie\SchemaOrg\Contracts\VirtualLocationContract[]|string|string[] $location
@return static
@see https://schema.org/location | location | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function longitude($longitude)
{
return $this->setProperty('longitude', $longitude);
} | The longitude of a location. For example ```-122.08585``` ([WGS
84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
@param float|float[]|int|int[]|string|string[] $longitude
@return static
@see https://schema.org/longitude | longitude | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function mainEntityOfPage($mainEntityOfPage)
{
return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
} | Indicates a page (or other CreativeWork) for which this thing is the main
entity being described. See [background
notes](/docs/datamodel.html#mainEntityBackground) for details.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
@return static
@see https://schema.org/mainEntityOfPage | mainEntityOfPage | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function makesOffer($makesOffer)
{
return $this->setProperty('makesOffer', $makesOffer);
} | A pointer to products or services offered by the organization or person.
@param \Spatie\SchemaOrg\Contracts\OfferContract|\Spatie\SchemaOrg\Contracts\OfferContract[] $makesOffer
@return static
@see https://schema.org/makesOffer | makesOffer | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function maximumAttendeeCapacity($maximumAttendeeCapacity)
{
return $this->setProperty('maximumAttendeeCapacity', $maximumAttendeeCapacity);
} | The total number of individuals that may attend an event or venue.
@param int|int[] $maximumAttendeeCapacity
@return static
@see https://schema.org/maximumAttendeeCapacity | maximumAttendeeCapacity | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function member($member)
{
return $this->setProperty('member', $member);
} | A member of an Organization or a ProgramMembership. Organizations can be
members of organizations; ProgramMembership is typically for individuals.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $member
@return static
@see https://schema.org/member | member | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function memberOf($memberOf)
{
return $this->setProperty('memberOf', $memberOf);
} | An Organization (or ProgramMembership) to which this Person or
Organization belongs.
@param \Spatie\SchemaOrg\Contracts\MemberProgramTierContract|\Spatie\SchemaOrg\Contracts\MemberProgramTierContract[]|\Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\ProgramMembershipContract|\Spatie\SchemaOrg\Contracts\ProgramMembershipContract[] $memberOf
@return static
@see https://schema.org/memberOf | memberOf | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function members($members)
{
return $this->setProperty('members', $members);
} | A member of this organization.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $members
@return static
@see https://schema.org/members | members | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function naics($naics)
{
return $this->setProperty('naics', $naics);
} | The North American Industry Classification System (NAICS) code for a
particular organization or business person.
@param string|string[] $naics
@return static
@see https://schema.org/naics | naics | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function nonprofitStatus($nonprofitStatus)
{
return $this->setProperty('nonprofitStatus', $nonprofitStatus);
} | nonprofitStatus indicates the legal status of a non-profit organization
in its primary place of business.
@param \Spatie\SchemaOrg\Contracts\NonprofitTypeContract|\Spatie\SchemaOrg\Contracts\NonprofitTypeContract[] $nonprofitStatus
@return static
@see https://schema.org/nonprofitStatus
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2543 | nonprofitStatus | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function numberOfEmployees($numberOfEmployees)
{
return $this->setProperty('numberOfEmployees', $numberOfEmployees);
} | The number of employees in an organization, e.g. business.
@param \Spatie\SchemaOrg\Contracts\QuantitativeValueContract|\Spatie\SchemaOrg\Contracts\QuantitativeValueContract[] $numberOfEmployees
@return static
@see https://schema.org/numberOfEmployees | numberOfEmployees | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function openingHours($openingHours)
{
return $this->setProperty('openingHours', $openingHours);
} | The general opening hours for a business. Opening hours can be specified
as a weekly time range, starting with days, then times per day. Multiple
days can be listed with commas ',' separating each day. Day or time
ranges are specified using a hyphen '-'.
* Days are specified using the following two-letter combinations:
```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.
* Times are specified using 24:00 format. For example, 3pm is specified
as ```15:00```, 10am as ```10:00```.
* Here is an example: ```<time itemprop="openingHours" datetime="Tu,Th
16:00-20:00">Tuesdays and Thursdays 4-8pm</time>```.
* If a business is open 7 days a week, then it can be specified as
```<time itemprop="openingHours" datetime="Mo-Su">Monday through Sunday,
all day</time>```.
@param string|string[] $openingHours
@return static
@see https://schema.org/openingHours | openingHours | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function openingHoursSpecification($openingHoursSpecification)
{
return $this->setProperty('openingHoursSpecification', $openingHoursSpecification);
} | The opening hours of a certain place.
@param \Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract|\Spatie\SchemaOrg\Contracts\OpeningHoursSpecificationContract[] $openingHoursSpecification
@return static
@see https://schema.org/openingHoursSpecification | openingHoursSpecification | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function ownershipFundingInfo($ownershipFundingInfo)
{
return $this->setProperty('ownershipFundingInfo', $ownershipFundingInfo);
} | For an [[Organization]] (often but not necessarily a
[[NewsMediaOrganization]]), a description of organizational ownership
structure; funding and grants. In a news/media setting, this is with
particular reference to editorial independence. Note that the
[[funder]] is also available and can be used to make basic funder
information machine-readable.
@param \Spatie\SchemaOrg\Contracts\AboutPageContract|\Spatie\SchemaOrg\Contracts\AboutPageContract[]|\Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $ownershipFundingInfo
@return static
@see https://schema.org/ownershipFundingInfo
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/1525 | ownershipFundingInfo | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function owns($owns)
{
return $this->setProperty('owns', $owns);
} | Products owned by the organization or person.
@param \Spatie\SchemaOrg\Contracts\OwnershipInfoContract|\Spatie\SchemaOrg\Contracts\OwnershipInfoContract[]|\Spatie\SchemaOrg\Contracts\ProductContract|\Spatie\SchemaOrg\Contracts\ProductContract[] $owns
@return static
@see https://schema.org/owns | owns | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function parentOrganization($parentOrganization)
{
return $this->setProperty('parentOrganization', $parentOrganization);
} | The larger organization that this organization is a [[subOrganization]]
of, if any.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[] $parentOrganization
@return static
@see https://schema.org/parentOrganization | parentOrganization | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function paymentAccepted($paymentAccepted)
{
return $this->setProperty('paymentAccepted', $paymentAccepted);
} | Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc.
@param string|string[] $paymentAccepted
@return static
@see https://schema.org/paymentAccepted | paymentAccepted | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function potentialAction($potentialAction)
{
return $this->setProperty('potentialAction', $potentialAction);
} | Indicates a potential Action, which describes an idealized action in
which this thing would play an 'object' role.
@param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
@return static
@see https://schema.org/potentialAction | potentialAction | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function priceRange($priceRange)
{
return $this->setProperty('priceRange', $priceRange);
} | The price range of the business, for example ```$$$```.
@param string|string[] $priceRange
@return static
@see https://schema.org/priceRange | priceRange | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function publicAccess($publicAccess)
{
return $this->setProperty('publicAccess', $publicAccess);
} | A flag to signal that the [[Place]] is open to public visitors. If this
property is omitted there is no assumed default boolean value.
@param bool|bool[] $publicAccess
@return static
@see https://schema.org/publicAccess | publicAccess | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function publishingPrinciples($publishingPrinciples)
{
return $this->setProperty('publishingPrinciples', $publishingPrinciples);
} | The publishingPrinciples property indicates (typically via [[URL]]) a
document describing the editorial principles of an [[Organization]] (or
individual, e.g. a [[Person]] writing a blog) that relate to their
activities as a publisher, e.g. ethics or diversity policies. When
applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are
those of the party primarily responsible for the creation of the
[[CreativeWork]].
While such policies are most typically expressed in natural language,
sometimes related information (e.g. indicating a [[funder]]) can be
expressed using schema.org terminology.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $publishingPrinciples
@return static
@see https://schema.org/publishingPrinciples | publishingPrinciples | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function sameAs($sameAs)
{
return $this->setProperty('sameAs', $sameAs);
} | URL of a reference Web page that unambiguously indicates the item's
identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
official website.
@param string|string[] $sameAs
@return static
@see https://schema.org/sameAs | sameAs | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function seeks($seeks)
{
return $this->setProperty('seeks', $seeks);
} | A pointer to products or services sought by the organization or person
(demand).
@param \Spatie\SchemaOrg\Contracts\DemandContract|\Spatie\SchemaOrg\Contracts\DemandContract[] $seeks
@return static
@see https://schema.org/seeks | seeks | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function serviceArea($serviceArea)
{
return $this->setProperty('serviceArea', $serviceArea);
} | The geographic area where the service is provided.
@param \Spatie\SchemaOrg\Contracts\AdministrativeAreaContract|\Spatie\SchemaOrg\Contracts\AdministrativeAreaContract[]|\Spatie\SchemaOrg\Contracts\GeoShapeContract|\Spatie\SchemaOrg\Contracts\GeoShapeContract[]|\Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[] $serviceArea
@return static
@see https://schema.org/serviceArea | serviceArea | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function skills($skills)
{
return $this->setProperty('skills', $skills);
} | A statement of knowledge, skill, ability, task or any other assertion
expressing a competency that is either claimed by a person, an
organization or desired or required to fulfill a role or to work in an
occupation.
@param \Spatie\SchemaOrg\Contracts\DefinedTermContract|\Spatie\SchemaOrg\Contracts\DefinedTermContract[]|string|string[] $skills
@return static
@see https://schema.org/skills | skills | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function slogan($slogan)
{
return $this->setProperty('slogan', $slogan);
} | A slogan or motto associated with the item.
@param string|string[] $slogan
@return static
@see https://schema.org/slogan | slogan | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function smokingAllowed($smokingAllowed)
{
return $this->setProperty('smokingAllowed', $smokingAllowed);
} | Indicates whether it is allowed to smoke in the place, e.g. in the
restaurant, hotel or hotel room.
@param bool|bool[] $smokingAllowed
@return static
@see https://schema.org/smokingAllowed | smokingAllowed | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function sponsor($sponsor)
{
return $this->setProperty('sponsor', $sponsor);
} | A person or organization that supports a thing through a pledge, promise,
or financial contribution. E.g. a sponsor of a Medical Study or a
corporate sponsor of an event.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $sponsor
@return static
@see https://schema.org/sponsor | sponsor | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function subOrganization($subOrganization)
{
return $this->setProperty('subOrganization', $subOrganization);
} | A relationship between two organizations where the first includes the
second, e.g., as a subsidiary. See also: the more specific 'department'
property.
@param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[] $subOrganization
@return static
@see https://schema.org/subOrganization | subOrganization | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function subjectOf($subjectOf)
{
return $this->setProperty('subjectOf', $subjectOf);
} | A CreativeWork or Event about this Thing.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
@return static
@see https://schema.org/subjectOf
@link https://github.com/schemaorg/schemaorg/issues/1670 | subjectOf | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function taxID($taxID)
{
return $this->setProperty('taxID', $taxID);
} | The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US
or the CIF/NIF in Spain.
@param string|string[] $taxID
@return static
@see https://schema.org/taxID | taxID | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function tourBookingPage($tourBookingPage)
{
return $this->setProperty('tourBookingPage', $tourBookingPage);
} | A page providing information on how to book a tour of some [[Place]],
such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate
setting, as well as other kinds of tours as appropriate.
@param string|string[] $tourBookingPage
@return static
@see https://schema.org/tourBookingPage
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/2373 | tourBookingPage | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function unnamedSourcesPolicy($unnamedSourcesPolicy)
{
return $this->setProperty('unnamedSourcesPolicy', $unnamedSourcesPolicy);
} | For an [[Organization]] (typically a [[NewsMediaOrganization]]), a
statement about policy on use of unnamed sources and the decision process
required.
@param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $unnamedSourcesPolicy
@return static
@see https://schema.org/unnamedSourcesPolicy
@see https://pending.schema.org
@link https://github.com/schemaorg/schemaorg/issues/1525 | unnamedSourcesPolicy | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
public function vatID($vatID)
{
return $this->setProperty('vatID', $vatID);
} | The Value-added Tax ID of the organization or person.
@param string|string[] $vatID
@return static
@see https://schema.org/vatID | vatID | php | spatie/schema-org | src/Optician.php | https://github.com/spatie/schema-org/blob/master/src/Optician.php | MIT |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.