The ApplicationPubSubRegistry
service
Method
|
ApplicationPubSubRegistry.GetFormats
|
Request type
|
google.protobuf.Empty
|
Response type
|
ApplicationPubSubFormats
|
HTTP bindings
|
GET /api/v3/as/pubsub-formats
|
Method
|
ApplicationPubSubRegistry.Set
|
Request type
|
SetApplicationPubSubRequest
|
Response type
|
ApplicationPubSub
|
HTTP bindings
|
PUT /api/v3/as/pubsub/{pubsub.ids.application_ids.application_id}/{pubsub.ids.pub_sub_id}
POST /api/v3/as/pubsub/{pubsub.ids.application_ids.application_id}
|
Method
|
ApplicationPubSubRegistry.Delete
|
Request type
|
ApplicationPubSubIdentifiers
|
Response type
|
google.protobuf.Empty
|
HTTP bindings
|
DELETE /api/v3/as/pubsub/{application_ids.application_id}/{pub_sub_id}
|
Messages
Message ApplicationPubSub
Field
|
created_at
|
Type
|
google.protobuf.Timestamp |
Field
|
updated_at
|
Type
|
google.protobuf.Timestamp |
Field
|
format
|
Type
|
string |
Description
|
The format to use for the body.
Supported values depend on the Application Server configuration.
max_len : 20
pattern : ^[a-z0-9](?:[-]?[a-z0-9]){2,}$
|
Field
|
base_topic
|
Type
|
string |
Description
|
Base topic name to which the messages topic is appended.
max_len : 100
|
Field
|
downlink_push
|
Type
|
ApplicationPubSub.Message |
Description
|
The topic to which the Application Server subscribes for downlink queue push operations.
|
Field
|
downlink_replace
|
Type
|
ApplicationPubSub.Message |
Description
|
The topic to which the Application Server subscribes for downlink queue replace operations.
|
Restrictions |
Only one of nats , mqtt , aws_iot can be set.
|
Show object example
{
"ids": {},
"created_at": "0001-01-01T00:00:00Z",
"updated_at": "0001-01-01T00:00:00Z",
"format": "",
"nats": {},
"mqtt": {},
"aws_iot": {},
"base_topic": "",
"downlink_push": {},
"downlink_replace": {},
"uplink_message": {},
"join_accept": {},
"downlink_ack": {},
"downlink_nack": {},
"downlink_sent": {},
"downlink_failed": {},
"downlink_queued": {},
"downlink_queue_invalidated": {},
"location_solved": {},
"service_data": {},
}
Message ApplicationPubSub.Message
Field
|
topic
|
Type
|
string |
Description
|
The topic on which the Application Server publishes or receives the messages.
max_len : 100
|
Show object example
{
"topic": "",
}
Message ApplicationPubSub.MQTTProvider
The MQTT provider settings.
Field
|
server_url
|
Type
|
string |
Description
|
uri
|
Field
|
client_id
|
Type
|
string |
Description
|
max_len : 23
|
Field
|
username
|
Type
|
string |
Description
|
max_len : 100
|
Field
|
password
|
Type
|
string |
Description
|
max_len : 100
|
Field
|
tls_ca
|
Type
|
bytes |
Description
|
The server Root CA certificate. PEM formatted.
max_len : 8192
|
Field
|
tls_client_cert
|
Type
|
bytes |
Description
|
The client certificate. PEM formatted.
max_len : 8192
|
Field
|
tls_client_key
|
Type
|
bytes |
Description
|
The client private key. PEM formatted.
max_len : 8192
|
Field
|
headers
|
Type
|
map of string to string |
Description
|
HTTP headers to use on MQTT-over-Websocket connections.
|
Show object example
{
"server_url": "",
"client_id": "",
"username": "",
"password": "",
"subscribe_qos": "AT_MOST_ONCE",
"publish_qos": "AT_MOST_ONCE",
"use_tls": false,
"tls_ca": "",
"tls_client_cert": "",
"tls_client_key": "",
"headers": {},
}
Message ApplicationPubSub.NATSProvider
The NATS provider settings.
Field
|
server_url
|
Type
|
string |
Description
|
The server connection URL.
uri
|
Show object example
{
"server_url": "",
}
Field
|
formats
|
Type
|
map of string to string |
Description
|
Format and description.
|
Show object example
{
"formats": {},
}
Message ApplicationPubSubIdentifiers
Field
|
pub_sub_id
|
Type
|
string |
Description
|
max_len : 36
pattern : ^[a-z0-9](?:[-]?[a-z0-9]){2,}$
|
Show object example
{
"application_ids": {},
"pub_sub_id": "",
}
Message ApplicationPubSubs
Show object example
{
"pubsubs": [],
}
Message GetApplicationPubSubRequest
Field
|
field_mask
|
Type
|
google.protobuf.FieldMask |
Show object example
{
"ids": {},
"field_mask": {},
}
Message ListApplicationPubSubsRequest
Field
|
field_mask
|
Type
|
google.protobuf.FieldMask |
Show object example
{
"application_ids": {},
"field_mask": {},
}
Message SetApplicationPubSubRequest
Field
|
field_mask
|
Type
|
google.protobuf.FieldMask |
Show object example
{
"pubsub": {},
"field_mask": {},
}
Enums
Enum ApplicationPubSub.MQTTProvider.QoS
Name |
Value |
Description |
AT_MOST_ONCE |
0 |
|
AT_LEAST_ONCE |
1 |
|
EXACTLY_ONCE |
2 |
|