EventRouter Service, gRPC: BusService.Update

Written by

Yandex Cloud

Updated at April 24, 2025

gRPC request
UpdateBusRequest
LogOptions
operation.Operation
UpdateBusMetadata
Bus
LogOptions

Updates the specified bus.

gRPC request

rpc Update (UpdateBusRequest) returns (operation.Operation)

UpdateBusRequest

{
  "bus_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "deletion_protection": "bool",
  "logging_enabled": "bool",
  "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
    "min_level": "Level",
    "service_account_id": "string"
  }
}

Field	Description
bus_id	string Required field. ID of the bus to update.
update_mask	google.protobuf.FieldMask Field mask that specifies which fields of the bus are going to be updated.
name	string New name of the bus.
description	string New description of the bus.
labels	object (map<string, string>) New labels of the bus.
deletion_protection	bool New flag that disallow deletion of the bus.
logging_enabled	bool Is logging from the bus enabled.
log_options	LogOptions New options for logging from the bus.

LogOptions

Field	Description
log_group_id	string Entry will be written to log group resolved by ID. Includes only one of the fields `log_group_id`, `folder_id`. Log entries destination.
folder_id	string Entry will be written to default log group for specified folder. Includes only one of the fields `log_group_id`, `folder_id`. Log entries destination.
min_level	enum Level Minimum log entry level. See LogLevel.Level for details. `LEVEL_UNSPECIFIED`: Default log level. Equivalent to not specifying log level at all. `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.
service_account_id	string Required field. Service account, which has permission to write to destination

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "bus_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folder_id": "string",
    "cloud_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "map<string, string>",
    "deletion_protection": "bool",
    "status": "Status",
    "logging_enabled": "bool",
    "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
      "min_level": "Level",
      "service_account_id": "string"
    }
  }
  // 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	UpdateBusMetadata 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	Bus 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.

UpdateBusMetadata

Field

Description

bus_id

string

Required field. ID of the bus that is being updated.

Bus

Field	Description
id	string ID of the bus.
folder_id	string ID of the folder that the bus belongs to.
cloud_id	string ID of the cloud that the bus resides in.
created_at	google.protobuf.Timestamp Creation timestamp.
name	string Name of the bus.
description	string Description of the bus.
labels	object (map<string, string>) Resource labels as `key:value` pairs.
deletion_protection	bool Deletion protection.
status	enum Status Status of the bus. `STATUS_UNSPECIFIED` `CREATING` `ACTIVE` `DELETING`
logging_enabled	bool Is logging from the bus enabled.
log_options	LogOptions Options for logging from the bus.

LogOptions

Field	Description
log_group_id	string Entry will be written to log group resolved by ID. Includes only one of the fields `log_group_id`, `folder_id`. Log entries destination.
folder_id	string Entry will be written to default log group for specified folder. Includes only one of the fields `log_group_id`, `folder_id`. Log entries destination.
min_level	enum Level Minimum log entry level. See LogLevel.Level for details. `LEVEL_UNSPECIFIED`: Default log level. Equivalent to not specifying log level at all. `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.
service_account_id	string Required field. Service account, which has permission to write to destination

EventRouter Service, gRPC: BusService.Update

gRPC requestgRPC request

UpdateBusRequestUpdateBusRequest

LogOptionsLogOptions

operation.Operationoperation.Operation

UpdateBusMetadataUpdateBusMetadata

BusBus

LogOptionsLogOptions

Was the article helpful?

gRPC request

UpdateBusRequest

LogOptions

operation.Operation

UpdateBusMetadata

Bus

LogOptions