IoT Core Broker Service, gRPC: BrokerService.Update

Статья создана

Yandex Cloud

Обновлена 1 июля 2026 г.

Открыть в Markdown

gRPC request
UpdateBrokerRequest
LogOptions
operation.Operation

Updates the specified broker.

gRPC request

rpc Update (UpdateBrokerRequest) returns (operation.Operation)

UpdateBrokerRequest

{
  "broker_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "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"
  }
}

Field	Description
broker_id	string Required field. ID of the broker to update. To get a broker ID make a BrokerService.List request. The maximum string length in characters is 50.
update_mask	google.protobuf.FieldMask Field mask that specifies which fields of the broker are going to be updated.
name	string Name of the broker. The name must be unique within the folder. The maximum string length in characters is 50. Value must match the regular expression `[a-zA-Z0-9_-]*`.
description	string Description of the broker. The maximum string length in characters is 256.
labels	object (map<string, string>) Resource labels as `key:value` pairs. Existing set of `labels` is completely replaced by the provided set. The maximum string length in characters for each value is 63. The string length in characters for each key must be 1-63. Each key must match the regular expression `[a-z][-_0-9a-z]`. Each value must match the regular expression `[-_0-9a-z]`. No more than 64 per resource.
log_options	LogOptions 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 `([a-zA-Z][-a-zA-Z0-9_.]{0,63})?`. Includes only one of the fields `log_group_id`, `folder_id`. Log entries destination.
folder_id	string Entry should be written to default log group for specified folder. Value must match the regular expression `([a-zA-Z][-a-zA-Z0-9_.]{0,63})?`. Includes only one of the fields `log_group_id`, `folder_id`. Log entries destination.
disabled	bool Is logging from broker disabled.
min_level	enum Level Minimum log entry level. See LogLevel.Level for details. `TRACE`: Trace log level. Possible use case: verbose logging of some business logic. `DEBUG`: Debug log level. Possible use case: debugging special cases in application logic. `INFO`: Info log level. Mostly used for information messages. `WARN`: Warn log level. May be used to alert about significant events. `ERROR`: Error log level. May be used to alert about errors in infrastructure, logic, etc. `FATAL`: Fatal log level. May be used to alert about unrecoverable failures and events.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	google.protobuf.Any The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

IoT Core Broker Service, gRPC: BrokerService.Update

gRPC requestgRPC request

UpdateBrokerRequestUpdateBrokerRequest

LogOptionsLogOptions

operation.Operationoperation.Operation

Была ли статья полезна?

gRPC request

UpdateBrokerRequest

LogOptions

operation.Operation