LatencyHistoryApi
LatencyHistoryApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getNetworkWirelessClientLatencyHistory() : object
- Operation getNetworkWirelessClientLatencyHistory
- getNetworkWirelessClientLatencyHistoryAsync() : PromiseInterface
- Operation getNetworkWirelessClientLatencyHistoryAsync
- getNetworkWirelessClientLatencyHistoryAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkWirelessClientLatencyHistoryAsyncWithHttpInfo
- getNetworkWirelessClientLatencyHistoryWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkWirelessClientLatencyHistoryWithHttpInfo
- getNetworkWirelessLatencyHistory() : object
- Operation getNetworkWirelessLatencyHistory
- getNetworkWirelessLatencyHistoryAsync() : PromiseInterface
- Operation getNetworkWirelessLatencyHistoryAsync
- getNetworkWirelessLatencyHistoryAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkWirelessLatencyHistoryAsyncWithHttpInfo
- getNetworkWirelessLatencyHistoryWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkWirelessLatencyHistoryWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getNetworkWirelessClientLatencyHistoryRequest() : Request
- Create request for operation 'getNetworkWirelessClientLatencyHistory'
- getNetworkWirelessLatencyHistoryRequest() : Request
- Create request for operation 'getNetworkWirelessLatencyHistory'
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ]) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
Return values
mixed —getConfig()
public
getConfig() : Configuration
Return values
Configuration —getNetworkWirelessClientLatencyHistory()
Operation getNetworkWirelessClientLatencyHistory
public
getNetworkWirelessClientLatencyHistory(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : object
Return the latency history for a client
Parameters
- $network_id : string
-
network_id (required)
- $client_id : string
-
client_id (required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 791 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 791 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 791 days. The default is 1 day. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 86400. The default is 86400. (optional)
Tags
Return values
object —getNetworkWirelessClientLatencyHistoryAsync()
Operation getNetworkWirelessClientLatencyHistoryAsync
public
getNetworkWirelessClientLatencyHistoryAsync(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : PromiseInterface
Return the latency history for a client
Parameters
- $network_id : string
-
(required)
- $client_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 791 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 791 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 791 days. The default is 1 day. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 86400. The default is 86400. (optional)
Tags
Return values
PromiseInterface —getNetworkWirelessClientLatencyHistoryAsyncWithHttpInfo()
Operation getNetworkWirelessClientLatencyHistoryAsyncWithHttpInfo
public
getNetworkWirelessClientLatencyHistoryAsyncWithHttpInfo(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : PromiseInterface
Return the latency history for a client
Parameters
- $network_id : string
-
(required)
- $client_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 791 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 791 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 791 days. The default is 1 day. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 86400. The default is 86400. (optional)
Tags
Return values
PromiseInterface —getNetworkWirelessClientLatencyHistoryWithHttpInfo()
Operation getNetworkWirelessClientLatencyHistoryWithHttpInfo
public
getNetworkWirelessClientLatencyHistoryWithHttpInfo(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : array<string|int, mixed>
Return the latency history for a client
Parameters
- $network_id : string
-
(required)
- $client_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 791 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 791 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 791 days. The default is 1 day. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 86400. The default is 86400. (optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getNetworkWirelessLatencyHistory()
Operation getNetworkWirelessLatencyHistory
public
getNetworkWirelessLatencyHistory(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ][, string $access_category = null ]) : object
Return average wireless latency over time for a network, device, or network client
Parameters
- $network_id : string
-
network_id (required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
- $auto_resolution : bool = null
-
Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
- $client_id : string = null
-
Filter results by network client. (optional)
- $device_serial : string = null
-
Filter results by device. (optional)
- $ap_tag : string = null
-
Filter results by AP tag. (optional)
- $band : string = null
-
Filter results by band (either '2.4' or '5'). (optional)
- $ssid : int = null
-
Filter results by SSID number. (optional)
- $access_category : string = null
-
Filter by access category. (optional)
Tags
Return values
object —getNetworkWirelessLatencyHistoryAsync()
Operation getNetworkWirelessLatencyHistoryAsync
public
getNetworkWirelessLatencyHistoryAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ][, string $access_category = null ]) : PromiseInterface
Return average wireless latency over time for a network, device, or network client
Parameters
- $network_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
- $auto_resolution : bool = null
-
Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
- $client_id : string = null
-
Filter results by network client. (optional)
- $device_serial : string = null
-
Filter results by device. (optional)
- $ap_tag : string = null
-
Filter results by AP tag. (optional)
- $band : string = null
-
Filter results by band (either '2.4' or '5'). (optional)
- $ssid : int = null
-
Filter results by SSID number. (optional)
- $access_category : string = null
-
Filter by access category. (optional)
Tags
Return values
PromiseInterface —getNetworkWirelessLatencyHistoryAsyncWithHttpInfo()
Operation getNetworkWirelessLatencyHistoryAsyncWithHttpInfo
public
getNetworkWirelessLatencyHistoryAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ][, string $access_category = null ]) : PromiseInterface
Return average wireless latency over time for a network, device, or network client
Parameters
- $network_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
- $auto_resolution : bool = null
-
Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
- $client_id : string = null
-
Filter results by network client. (optional)
- $device_serial : string = null
-
Filter results by device. (optional)
- $ap_tag : string = null
-
Filter results by AP tag. (optional)
- $band : string = null
-
Filter results by band (either '2.4' or '5'). (optional)
- $ssid : int = null
-
Filter results by SSID number. (optional)
- $access_category : string = null
-
Filter by access category. (optional)
Tags
Return values
PromiseInterface —getNetworkWirelessLatencyHistoryWithHttpInfo()
Operation getNetworkWirelessLatencyHistoryWithHttpInfo
public
getNetworkWirelessLatencyHistoryWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ][, string $access_category = null ]) : array<string|int, mixed>
Return average wireless latency over time for a network, device, or network client
Parameters
- $network_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
- $auto_resolution : bool = null
-
Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
- $client_id : string = null
-
Filter results by network client. (optional)
- $device_serial : string = null
-
Filter results by device. (optional)
- $ap_tag : string = null
-
Filter results by AP tag. (optional)
- $band : string = null
-
Filter results by band (either '2.4' or '5'). (optional)
- $ssid : int = null
-
Filter results by SSID number. (optional)
- $access_category : string = null
-
Filter by access category. (optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options
getNetworkWirelessClientLatencyHistoryRequest()
Create request for operation 'getNetworkWirelessClientLatencyHistory'
protected
getNetworkWirelessClientLatencyHistoryRequest(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $client_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 791 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 791 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 791 days. The default is 1 day. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 86400. The default is 86400. (optional)
Tags
Return values
Request —getNetworkWirelessLatencyHistoryRequest()
Create request for operation 'getNetworkWirelessLatencyHistory'
protected
getNetworkWirelessLatencyHistoryRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ][, string $access_category = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
- $t1 : string = null
-
The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
- $auto_resolution : bool = null
-
Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
- $client_id : string = null
-
Filter results by network client. (optional)
- $device_serial : string = null
-
Filter results by device. (optional)
- $ap_tag : string = null
-
Filter results by AP tag. (optional)
- $band : string = null
-
Filter results by band (either '2.4' or '5'). (optional)
- $ssid : int = null
-
Filter results by SSID number. (optional)
- $access_category : string = null
-
Filter by access category. (optional)