IoT Core Broker Service, REST: Broker methods
A set of methods for managing broker.
JSON Representation
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"status": "string",
"logOptions": {
"disabled": true,
"minLevel": "string",
// `logOptions` includes only one of the fields `logGroupId`, `folderId`
"logGroupId": "string",
"folderId": "string",
// end of the list of possible fields`logOptions`
}
}
Field | Description |
---|---|
id | string ID of the broker. |
folderId | string ID of the folder that the broker belongs to. |
createdAt | string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
name | string Name of the broker. The name is unique within the folder. |
description | string Description of the broker. 0-256 characters long. |
labels | object Resource labels as |
status | string Status of the broker.
|
logOptions | object Options for logging broker events |
logOptions. disabled |
boolean (boolean) Is logging from broker disabled. |
logOptions. minLevel |
string Minimum log entry level. See [LogLevel.Level] for details.
|
logOptions. logGroupId |
string logOptions includes only one of the fields logGroupId , folderId Entry should be written to log group resolved by ID. Value must match the regular expression |
logOptions. folderId |
string logOptions includes only one of the fields logGroupId , folderId Entry should be written to default log group for specified folder. Value must match the regular expression |
Methods
Method | Description |
---|---|
addCertificate | Adds a certificate. |
addPassword | Adds password for the specified broker. |
create | Creates a broker in the specified folder. |
delete | Deletes the specified broker. |
deleteCertificate | Deletes the specified broker certificate. |
deletePassword | Deletes the specified password. |
get | Returns the specified broker. |
list | Retrieves the list of brokers in the specified folder. |
listCertificates | Retrieves the list of broker certificates for the specified broker. |
listOperations | Lists operations for the specified broker. |
listPasswords | Retrieves the list of passwords for the specified broker. |
update | Updates the specified broker. |