Application Pub/Sub APIs

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.Get
Request type GetApplicationPubSubRequest
Response type ApplicationPubSub
HTTP bindings

GET /api/v3/as/pubsub/{ids.application_ids.application_id}/{ids.pub_sub_id}

Method ApplicationPubSubRegistry.List
Request type ListApplicationPubSubsRequest
Response type ApplicationPubSubs
HTTP bindings

GET /api/v3/as/pubsub/{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 Type Description
ids ApplicationPubSubIdentifiers

required

created_at google.protobuf.Timestamp
updated_at google.protobuf.Timestamp
format string

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,}$

nats ApplicationPubSub.NATSProvider
mqtt ApplicationPubSub.MQTTProvider
aws_iot ApplicationPubSub.AWSIoTProvider
base_topic string

Base topic name to which the messages topic is appended.

max_len: 100

downlink_push ApplicationPubSub.Message

The topic to which the Application Server subscribes for downlink queue push operations.

downlink_replace ApplicationPubSub.Message

The topic to which the Application Server subscribes for downlink queue replace operations.

uplink_message ApplicationPubSub.Message
join_accept ApplicationPubSub.Message
downlink_ack ApplicationPubSub.Message
downlink_nack ApplicationPubSub.Message
downlink_sent ApplicationPubSub.Message
downlink_failed ApplicationPubSub.Message
downlink_queued ApplicationPubSub.Message
location_solved ApplicationPubSub.Message
service_data ApplicationPubSub.Message
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": {},
  "location_solved": {},
  "service_data": {},
}

Message ApplicationPubSub.Message

Field Type Description
topic string

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 Type Description
server_url string

uri

client_id string

max_len: 23

username string

max_len: 100

password string

max_len: 100

subscribe_qos ApplicationPubSub.MQTTProvider.QoS
publish_qos ApplicationPubSub.MQTTProvider.QoS
use_tls bool
tls_ca bytes

The server Root CA certificate. PEM formatted.

tls_client_cert bytes

The client certificate. PEM formatted.

tls_client_key bytes

The client private key. PEM formatted.

headers map of string to string

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 Type Description
server_url string

The server connection URL.

uri

Show object example
{
  "server_url": "",
}

Message ApplicationPubSubFormats

Field Type Description
formats map of string to string

Format and description.

Show object example
{
  "formats": {},
}

Message ApplicationPubSubIdentifiers

Field Type Description
application_ids ApplicationIdentifiers

required

pub_sub_id string

max_len: 36

pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$

Show object example
{
  "application_ids": {},
  "pub_sub_id": "",
}

Message ApplicationPubSubs

Field Type Description
pubsubs repeated ApplicationPubSub
Show object example
{
  "pubsubs": [],
}

Message GetApplicationPubSubRequest

Field Type Description
ids ApplicationPubSubIdentifiers

required

field_mask google.protobuf.FieldMask
Show object example
{
  "ids": {},
  "field_mask": {},
}

Message ListApplicationPubSubsRequest

Field Type Description
application_ids ApplicationIdentifiers

required

field_mask google.protobuf.FieldMask
Show object example
{
  "application_ids": {},
  "field_mask": {},
}

Message SetApplicationPubSubRequest

Field Type Description
pubsub ApplicationPubSub

required

field_mask 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