EventRouter Service, gRPC: BusService.List
Retrieves the list of buses in the specified folder.
gRPC request
rpc List (ListBusesRequest) returns (ListBusesResponse)
ListBusesRequest
{
"folderId": "string",
"pageSize": "int64",
"pageToken": "string",
"filter": "string"
}
|
Field |
Description |
|
folderId |
string Required field. ID of the folder to list buses in. |
|
pageSize |
int64 Maximum number of buses to return. |
|
pageToken |
string Page token. To get the next page of results, set |
|
filter |
string Supported fields for filter: |
ListBusesResponse
{
"buses": [
{
"id": "string",
"folderId": "string",
"cloudId": "string",
"createdAt": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "string",
"deletionProtection": "bool",
"status": "Status"
}
],
"nextPageToken": "string"
}
|
Field |
Description |
|
buses[] |
List of buses. |
|
nextPageToken |
string Token for getting the next page of the list of buses. |
Bus
|
Field |
Description |
|
id |
string ID of the bus. |
|
folderId |
string ID of the folder that the bus belongs to. |
|
cloudId |
string ID of the cloud that the bus resides in. |
|
createdAt |
Creation timestamp. |
|
name |
string Name of the bus. |
|
description |
string Description of the bus. |
|
labels |
string Resource labels as |
|
deletionProtection |
bool Deletion protection. |
|
status |
enum Status Status of the bus.
|