IoT Core Broker Service, gRPC: BrokerService.Get
Returns the specified broker.
To get the list of available brokers, make a List request.
gRPC request
rpc Get (GetBrokerRequest) returns (Broker)
GetBrokerRequest
{
"broker_id": "string"
}
|
Field |
Description |
|
broker_id |
string Required field. ID of the broker to return. The maximum string length in characters is 50. |
Broker
{
"id": "string",
"folder_id": "string",
"created_at": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"status": "Status",
"log_options": {
// Includes only one of the fields `log_group_id`, `folder_id`
"log_group_id": "string",
"folder_id": "string",
// end of the list of possible fields
"disabled": "bool",
"min_level": "Level"
}
}
A broker.
|
Field |
Description |
|
id |
string ID of the broker. |
|
folder_id |
string ID of the folder that the broker belongs to. |
|
created_at |
Creation timestamp. |
|
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 (map<string, string>) Resource labels as |
|
status |
enum Status Status of the broker.
|
|
log_options |
Options for logging broker events |
LogOptions
|
Field |
Description |
|
log_group_id |
string Entry should be written to log group resolved by ID. Value must match the regular expression Includes only one of the fields Log entries destination. |
|
folder_id |
string Entry should be written to default log group for specified folder. Value must match the regular expression Includes only one of the fields Log entries destination. |
|
disabled |
bool Is logging from broker disabled. |
|
min_level |
enum Level Minimum log entry level.
|