MqttBrokersApi
MqttBrokersApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- createNetworkMqttBroker() : object
- Operation createNetworkMqttBroker
- createNetworkMqttBrokerAsync() : PromiseInterface
- Operation createNetworkMqttBrokerAsync
- createNetworkMqttBrokerAsyncWithHttpInfo() : PromiseInterface
- Operation createNetworkMqttBrokerAsyncWithHttpInfo
- createNetworkMqttBrokerWithHttpInfo() : array<string|int, mixed>
- Operation createNetworkMqttBrokerWithHttpInfo
- deleteNetworkMqttBroker() : void
- Operation deleteNetworkMqttBroker
- deleteNetworkMqttBrokerAsync() : PromiseInterface
- Operation deleteNetworkMqttBrokerAsync
- deleteNetworkMqttBrokerAsyncWithHttpInfo() : PromiseInterface
- Operation deleteNetworkMqttBrokerAsyncWithHttpInfo
- deleteNetworkMqttBrokerWithHttpInfo() : array<string|int, mixed>
- Operation deleteNetworkMqttBrokerWithHttpInfo
- getConfig() : Configuration
- getNetworkMqttBroker() : object
- Operation getNetworkMqttBroker
- getNetworkMqttBrokerAsync() : PromiseInterface
- Operation getNetworkMqttBrokerAsync
- getNetworkMqttBrokerAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkMqttBrokerAsyncWithHttpInfo
- getNetworkMqttBrokers() : object
- Operation getNetworkMqttBrokers
- getNetworkMqttBrokersAsync() : PromiseInterface
- Operation getNetworkMqttBrokersAsync
- getNetworkMqttBrokersAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkMqttBrokersAsyncWithHttpInfo
- getNetworkMqttBrokersWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkMqttBrokersWithHttpInfo
- getNetworkMqttBrokerWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkMqttBrokerWithHttpInfo
- updateNetworkMqttBroker() : object
- Operation updateNetworkMqttBroker
- updateNetworkMqttBrokerAsync() : PromiseInterface
- Operation updateNetworkMqttBrokerAsync
- updateNetworkMqttBrokerAsyncWithHttpInfo() : PromiseInterface
- Operation updateNetworkMqttBrokerAsyncWithHttpInfo
- updateNetworkMqttBrokerWithHttpInfo() : array<string|int, mixed>
- Operation updateNetworkMqttBrokerWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- createNetworkMqttBrokerRequest() : Request
- Create request for operation 'createNetworkMqttBroker'
- deleteNetworkMqttBrokerRequest() : Request
- Create request for operation 'deleteNetworkMqttBroker'
- getNetworkMqttBrokerRequest() : Request
- Create request for operation 'getNetworkMqttBroker'
- getNetworkMqttBrokersRequest() : Request
- Create request for operation 'getNetworkMqttBrokers'
- updateNetworkMqttBrokerRequest() : Request
- Create request for operation 'updateNetworkMqttBroker'
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 —createNetworkMqttBroker()
Operation createNetworkMqttBroker
public
createNetworkMqttBroker(string $network_id, CreateNetworkMqttBroker $create_network_mqtt_broker) : object
Add an MQTT broker
Parameters
- $network_id : string
-
network_id (required)
- $create_network_mqtt_broker : CreateNetworkMqttBroker
-
create_network_mqtt_broker (required)
Tags
Return values
object —createNetworkMqttBrokerAsync()
Operation createNetworkMqttBrokerAsync
public
createNetworkMqttBrokerAsync(string $network_id, CreateNetworkMqttBroker $create_network_mqtt_broker) : PromiseInterface
Add an MQTT broker
Parameters
- $network_id : string
-
(required)
- $create_network_mqtt_broker : CreateNetworkMqttBroker
-
(required)
Tags
Return values
PromiseInterface —createNetworkMqttBrokerAsyncWithHttpInfo()
Operation createNetworkMqttBrokerAsyncWithHttpInfo
public
createNetworkMqttBrokerAsyncWithHttpInfo(string $network_id, CreateNetworkMqttBroker $create_network_mqtt_broker) : PromiseInterface
Add an MQTT broker
Parameters
- $network_id : string
-
(required)
- $create_network_mqtt_broker : CreateNetworkMqttBroker
-
(required)
Tags
Return values
PromiseInterface —createNetworkMqttBrokerWithHttpInfo()
Operation createNetworkMqttBrokerWithHttpInfo
public
createNetworkMqttBrokerWithHttpInfo(string $network_id, CreateNetworkMqttBroker $create_network_mqtt_broker) : array<string|int, mixed>
Add an MQTT broker
Parameters
- $network_id : string
-
(required)
- $create_network_mqtt_broker : CreateNetworkMqttBroker
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
deleteNetworkMqttBroker()
Operation deleteNetworkMqttBroker
public
deleteNetworkMqttBroker(string $network_id, string $mqtt_broker_id) : void
Delete an MQTT broker
Parameters
- $network_id : string
-
network_id (required)
- $mqtt_broker_id : string
-
mqtt_broker_id (required)
Tags
Return values
void —deleteNetworkMqttBrokerAsync()
Operation deleteNetworkMqttBrokerAsync
public
deleteNetworkMqttBrokerAsync(string $network_id, string $mqtt_broker_id) : PromiseInterface
Delete an MQTT broker
Parameters
- $network_id : string
-
(required)
- $mqtt_broker_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteNetworkMqttBrokerAsyncWithHttpInfo()
Operation deleteNetworkMqttBrokerAsyncWithHttpInfo
public
deleteNetworkMqttBrokerAsyncWithHttpInfo(string $network_id, string $mqtt_broker_id) : PromiseInterface
Delete an MQTT broker
Parameters
- $network_id : string
-
(required)
- $mqtt_broker_id : string
-
(required)
Tags
Return values
PromiseInterface —deleteNetworkMqttBrokerWithHttpInfo()
Operation deleteNetworkMqttBrokerWithHttpInfo
public
deleteNetworkMqttBrokerWithHttpInfo(string $network_id, string $mqtt_broker_id) : array<string|int, mixed>
Delete an MQTT broker
Parameters
- $network_id : string
-
(required)
- $mqtt_broker_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getNetworkMqttBroker()
Operation getNetworkMqttBroker
public
getNetworkMqttBroker(string $network_id, string $mqtt_broker_id) : object
Return an MQTT broker
Parameters
- $network_id : string
-
network_id (required)
- $mqtt_broker_id : string
-
mqtt_broker_id (required)
Tags
Return values
object —getNetworkMqttBrokerAsync()
Operation getNetworkMqttBrokerAsync
public
getNetworkMqttBrokerAsync(string $network_id, string $mqtt_broker_id) : PromiseInterface
Return an MQTT broker
Parameters
- $network_id : string
-
(required)
- $mqtt_broker_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkMqttBrokerAsyncWithHttpInfo()
Operation getNetworkMqttBrokerAsyncWithHttpInfo
public
getNetworkMqttBrokerAsyncWithHttpInfo(string $network_id, string $mqtt_broker_id) : PromiseInterface
Return an MQTT broker
Parameters
- $network_id : string
-
(required)
- $mqtt_broker_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkMqttBrokers()
Operation getNetworkMqttBrokers
public
getNetworkMqttBrokers(string $network_id) : object
List the MQTT brokers for this network
Parameters
- $network_id : string
-
network_id (required)
Tags
Return values
object —getNetworkMqttBrokersAsync()
Operation getNetworkMqttBrokersAsync
public
getNetworkMqttBrokersAsync(string $network_id) : PromiseInterface
List the MQTT brokers for this network
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkMqttBrokersAsyncWithHttpInfo()
Operation getNetworkMqttBrokersAsyncWithHttpInfo
public
getNetworkMqttBrokersAsyncWithHttpInfo(string $network_id) : PromiseInterface
List the MQTT brokers for this network
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkMqttBrokersWithHttpInfo()
Operation getNetworkMqttBrokersWithHttpInfo
public
getNetworkMqttBrokersWithHttpInfo(string $network_id) : array<string|int, mixed>
List the MQTT brokers for this network
Parameters
- $network_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getNetworkMqttBrokerWithHttpInfo()
Operation getNetworkMqttBrokerWithHttpInfo
public
getNetworkMqttBrokerWithHttpInfo(string $network_id, string $mqtt_broker_id) : array<string|int, mixed>
Return an MQTT broker
Parameters
- $network_id : string
-
(required)
- $mqtt_broker_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateNetworkMqttBroker()
Operation updateNetworkMqttBroker
public
updateNetworkMqttBroker(string $network_id, string $mqtt_broker_id[, UpdateNetworkMqttBroker $update_network_mqtt_broker = null ]) : object
Update an MQTT broker
Parameters
- $network_id : string
-
network_id (required)
- $mqtt_broker_id : string
-
mqtt_broker_id (required)
- $update_network_mqtt_broker : UpdateNetworkMqttBroker = null
-
update_network_mqtt_broker (optional)
Tags
Return values
object —updateNetworkMqttBrokerAsync()
Operation updateNetworkMqttBrokerAsync
public
updateNetworkMqttBrokerAsync(string $network_id, string $mqtt_broker_id[, UpdateNetworkMqttBroker $update_network_mqtt_broker = null ]) : PromiseInterface
Update an MQTT broker
Parameters
- $network_id : string
-
(required)
- $mqtt_broker_id : string
-
(required)
- $update_network_mqtt_broker : UpdateNetworkMqttBroker = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkMqttBrokerAsyncWithHttpInfo()
Operation updateNetworkMqttBrokerAsyncWithHttpInfo
public
updateNetworkMqttBrokerAsyncWithHttpInfo(string $network_id, string $mqtt_broker_id[, UpdateNetworkMqttBroker $update_network_mqtt_broker = null ]) : PromiseInterface
Update an MQTT broker
Parameters
- $network_id : string
-
(required)
- $mqtt_broker_id : string
-
(required)
- $update_network_mqtt_broker : UpdateNetworkMqttBroker = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkMqttBrokerWithHttpInfo()
Operation updateNetworkMqttBrokerWithHttpInfo
public
updateNetworkMqttBrokerWithHttpInfo(string $network_id, string $mqtt_broker_id[, UpdateNetworkMqttBroker $update_network_mqtt_broker = null ]) : array<string|int, mixed>
Update an MQTT broker
Parameters
- $network_id : string
-
(required)
- $mqtt_broker_id : string
-
(required)
- $update_network_mqtt_broker : UpdateNetworkMqttBroker = null
-
(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
createNetworkMqttBrokerRequest()
Create request for operation 'createNetworkMqttBroker'
protected
createNetworkMqttBrokerRequest(string $network_id, CreateNetworkMqttBroker $create_network_mqtt_broker) : Request
Parameters
- $network_id : string
-
(required)
- $create_network_mqtt_broker : CreateNetworkMqttBroker
-
(required)
Tags
Return values
Request —deleteNetworkMqttBrokerRequest()
Create request for operation 'deleteNetworkMqttBroker'
protected
deleteNetworkMqttBrokerRequest(string $network_id, string $mqtt_broker_id) : Request
Parameters
- $network_id : string
-
(required)
- $mqtt_broker_id : string
-
(required)
Tags
Return values
Request —getNetworkMqttBrokerRequest()
Create request for operation 'getNetworkMqttBroker'
protected
getNetworkMqttBrokerRequest(string $network_id, string $mqtt_broker_id) : Request
Parameters
- $network_id : string
-
(required)
- $mqtt_broker_id : string
-
(required)
Tags
Return values
Request —getNetworkMqttBrokersRequest()
Create request for operation 'getNetworkMqttBrokers'
protected
getNetworkMqttBrokersRequest(string $network_id) : Request
Parameters
- $network_id : string
-
(required)
Tags
Return values
Request —updateNetworkMqttBrokerRequest()
Create request for operation 'updateNetworkMqttBroker'
protected
updateNetworkMqttBrokerRequest(string $network_id, string $mqtt_broker_id[, UpdateNetworkMqttBroker $update_network_mqtt_broker = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $mqtt_broker_id : string
-
(required)
- $update_network_mqtt_broker : UpdateNetworkMqttBroker = null
-
(optional)