TrafficApi
TrafficApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getNetworkTraffic() : object
- Operation getNetworkTraffic
- getNetworkTrafficAsync() : PromiseInterface
- Operation getNetworkTrafficAsync
- getNetworkTrafficAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkTrafficAsyncWithHttpInfo
- getNetworkTrafficWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkTrafficWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getNetworkTrafficRequest() : Request
- Create request for operation 'getNetworkTraffic'
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 —getNetworkTraffic()
Operation getNetworkTraffic
public
getNetworkTraffic(string $network_id[, string $t0 = null ][, float $timespan = null ][, string $device_type = null ]) : object
Return the traffic analysis data for this network
Parameters
- $network_id : string
-
network_id (required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 30 days from today. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 30 days. (optional)
- $device_type : string = null
-
Filter the data by device type: 'combined', 'wireless', 'switch' or 'appliance'. Defaults to 'combined'. When using 'combined', for each rule the data will come from the device type with the most usage. (optional)
Tags
Return values
object —getNetworkTrafficAsync()
Operation getNetworkTrafficAsync
public
getNetworkTrafficAsync(string $network_id[, string $t0 = null ][, float $timespan = null ][, string $device_type = null ]) : PromiseInterface
Return the traffic analysis data for this network
Parameters
- $network_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 30 days from today. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 30 days. (optional)
- $device_type : string = null
-
Filter the data by device type: 'combined', 'wireless', 'switch' or 'appliance'. Defaults to 'combined'. When using 'combined', for each rule the data will come from the device type with the most usage. (optional)
Tags
Return values
PromiseInterface —getNetworkTrafficAsyncWithHttpInfo()
Operation getNetworkTrafficAsyncWithHttpInfo
public
getNetworkTrafficAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, float $timespan = null ][, string $device_type = null ]) : PromiseInterface
Return the traffic analysis data for this network
Parameters
- $network_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 30 days from today. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 30 days. (optional)
- $device_type : string = null
-
Filter the data by device type: 'combined', 'wireless', 'switch' or 'appliance'. Defaults to 'combined'. When using 'combined', for each rule the data will come from the device type with the most usage. (optional)
Tags
Return values
PromiseInterface —getNetworkTrafficWithHttpInfo()
Operation getNetworkTrafficWithHttpInfo
public
getNetworkTrafficWithHttpInfo(string $network_id[, string $t0 = null ][, float $timespan = null ][, string $device_type = null ]) : array<string|int, mixed>
Return the traffic analysis data for this network
Parameters
- $network_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 30 days from today. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 30 days. (optional)
- $device_type : string = null
-
Filter the data by device type: 'combined', 'wireless', 'switch' or 'appliance'. Defaults to 'combined'. When using 'combined', for each rule the data will come from the device type with the most usage. (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
getNetworkTrafficRequest()
Create request for operation 'getNetworkTraffic'
protected
getNetworkTrafficRequest(string $network_id[, string $t0 = null ][, float $timespan = null ][, string $device_type = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $t0 : string = null
-
The beginning of the timespan for the data. The maximum lookback period is 30 days from today. (optional)
- $timespan : float = null
-
The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 30 days. (optional)
- $device_type : string = null
-
Filter the data by device type: 'combined', 'wireless', 'switch' or 'appliance'. Defaults to 'combined'. When using 'combined', for each rule the data will come from the device type with the most usage. (optional)