Связаться с намиПодключиться

EventRouter Service, gRPC: BusService.List

Статья создана
Обновлена 24 апреля 2025 г.

Retrieves the list of buses in the specified folder.

gRPC request

rpc List (ListBusesRequest) returns (ListBusesResponse)

ListBusesRequest

{
  "folder_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "filter": "string"
}

Field

Description

folder_id

string

Required field. ID of the folder to list buses in.

page_size

int64

Maximum number of buses to return.

page_token

string

Page token. To get the next page of results, set page_token to the
ListBusesResponse.next_page_token returned by a previous list request.

filter

string

Supported fields for filter:
name
created_at

ListBusesResponse

{
  "buses": [
    {
      "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"
      }
    }
  ],
  "next_page_token": "string"
}

Field

Description

buses[]

Bus

List of buses.

next_page_token

string

Token for getting the next page of the list of buses.

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
Предыдущая
Get
Следующая
Create