EventRouter Service, gRPC: ConnectorService.List
Retrieves the list of connectors in the specified folder.
gRPC request
rpc List (ListConnectorsRequest) returns (ListConnectorsResponse)
ListConnectorsRequest
{
// Includes only one of the fields `bus_id`, `folder_id`
"bus_id": "string",
"folder_id": "string",
// end of the list of possible fields
"page_size": "int64",
"page_token": "string",
"filter": "string"
}
|
Field |
Description |
|
bus_id |
string ID of the bus to list connectors in. Includes only one of the fields ID of the folder or bus to list connectors in. |
|
folder_id |
string ID of the folder to list connectors in. Includes only one of the fields ID of the folder or bus to list connectors in. |
|
page_size |
int64 The maximum number of results per response. |
|
page_token |
string Page token. To get the next page of results, set |
|
filter |
string Supported fields for filter: |
ListConnectorsResponse
{
"connectors": [
{
"id": "string",
"bus_id": "string",
"folder_id": "string",
"cloud_id": "string",
"created_at": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"source": {
// Includes only one of the fields `data_stream`, `message_queue`, `timer`, `event_service_source`, `audit_trails`
"data_stream": {
"database": "string",
"stream_name": "string",
"consumer": "string",
"service_account_id": "string"
},
"message_queue": {
"queue_arn": "string",
"service_account_id": "string",
"visibility_timeout": "google.protobuf.Duration",
"batch_size": "int64",
"polling_timeout": "google.protobuf.Duration"
},
"timer": {
"cron_expression": "string",
"time_zone": "string",
"payload": "string"
},
"event_service_source": "EventServiceSource",
"audit_trails": "AuditTrails"
// end of the list of possible fields
},
"deletion_protection": "bool",
"status": "Status"
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
connectors[] |
List of connectors. |
|
next_page_token |
string Token for getting the next page of the list of results. |
Connector
|
Field |
Description |
|
id |
string ID of the connector. |
|
bus_id |
string ID of the bus that the connector belongs to. |
|
folder_id |
string ID of the folder that the connector resides in. |
|
cloud_id |
string ID of the cloud that the connector resides in. |
|
created_at |
Creation timestamp. |
|
name |
string Name of the connector. |
|
description |
string Description of the connector. |
|
labels |
object (map<string, string>) Resource labels as |
|
source |
Source of the connector. |
|
deletion_protection |
bool Deletion protection. |
|
status |
enum Status Status of the connector.
|
Source
|
Field |
Description |
|
data_stream |
Includes only one of the fields |
|
message_queue |
Includes only one of the fields |
|
timer |
Includes only one of the fields |
|
event_service_source |
Includes only one of the fields |
|
audit_trails |
Includes only one of the fields |
DataStream
|
Field |
Description |
|
database |
string Required field. Stream database. |
|
stream_name |
string Required field. Stream name, absolute or relative. |
|
consumer |
string Required field. Consumer name. |
|
service_account_id |
string Required field. Service account which has read permission on the stream. |
MessageQueue
|
Field |
Description |
|
queue_arn |
string Required field. Queue ARN. |
|
service_account_id |
string Required field. Service account which has read access to the queue. The maximum string length in characters is 50. |
|
visibility_timeout |
Queue visibility timeout override. |
|
batch_size |
int64 Batch size for polling. The maximum value is 10. |
|
polling_timeout |
Queue polling timeout. |
Timer
|
Field |
Description |
|
cron_expression |
string Required field. cron expression, with second precision The maximum string length in characters is 100. |
|
time_zone |
string time zone, e.g. Europe/Moscow |
|
payload |
string payload to send to target The maximum string length in characters is 4096. |
EventServiceSource
|
Field |
Description |
|
Empty |
|
AuditTrails
|
Field |
Description |
|
Empty |
|