NetworkHealthApi
NetworkHealthApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getNetworkNetworkHealthChannelUtilization() : object
- Operation getNetworkNetworkHealthChannelUtilization
- getNetworkNetworkHealthChannelUtilizationAsync() : PromiseInterface
- Operation getNetworkNetworkHealthChannelUtilizationAsync
- getNetworkNetworkHealthChannelUtilizationAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkNetworkHealthChannelUtilizationAsyncWithHttpInfo
- getNetworkNetworkHealthChannelUtilizationWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkNetworkHealthChannelUtilizationWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getNetworkNetworkHealthChannelUtilizationRequest() : Request
- Create request for operation 'getNetworkNetworkHealthChannelUtilization'
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 —getNetworkNetworkHealthChannelUtilization()
Operation getNetworkNetworkHealthChannelUtilization
public
getNetworkNetworkHealthChannelUtilization(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object
Get the channel utilization over each radio for all APs in a network.
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 1 day. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 600. The default is 600. (optional)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 100. Default is 10. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
Tags
Return values
object —getNetworkNetworkHealthChannelUtilizationAsync()
Operation getNetworkNetworkHealthChannelUtilizationAsync
public
getNetworkNetworkHealthChannelUtilizationAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface
Get the channel utilization over each radio for all APs in a network.
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 1 day. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 600. The default is 600. (optional)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 100. Default is 10. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
Tags
Return values
PromiseInterface —getNetworkNetworkHealthChannelUtilizationAsyncWithHttpInfo()
Operation getNetworkNetworkHealthChannelUtilizationAsyncWithHttpInfo
public
getNetworkNetworkHealthChannelUtilizationAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface
Get the channel utilization over each radio for all APs in a network.
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 1 day. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 600. The default is 600. (optional)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 100. Default is 10. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
Tags
Return values
PromiseInterface —getNetworkNetworkHealthChannelUtilizationWithHttpInfo()
Operation getNetworkNetworkHealthChannelUtilizationWithHttpInfo
public
getNetworkNetworkHealthChannelUtilizationWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>
Get the channel utilization over each radio for all APs in a network.
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 1 day. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 600. The default is 600. (optional)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 100. Default is 10. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (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
getNetworkNetworkHealthChannelUtilizationRequest()
Create request for operation 'getNetworkNetworkHealthChannelUtilization'
protected
getNetworkNetworkHealthChannelUtilizationRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = 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 1 day. (optional)
- $resolution : int = null
-
The time resolution in seconds for returned data. The valid resolutions are: 600. The default is 600. (optional)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 100. Default is 10. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)