Contact UsGet started

EventRouter Service, gRPC: ConnectorService.List

Written by
Updated at November 7, 2024

Retrieves the list of connectors in the specified folder.

gRPC request

rpc List (ListConnectorsRequest) returns (ListConnectorsResponse)

ListConnectorsRequest

{
  // Includes only one of the fields `busId`, `folderId`
  "busId": "string",
  "folderId": "string",
  // end of the list of possible fields
  "pageSize": "int64",
  "pageToken": "string",
  "filter": "string"
}

Field

Description

busId

string

ID of the bus to list connectors in.

Includes only one of the fields busId, folderId.

ID of the folder or bus to list connectors in.

folderId

string

ID of the folder to list connectors in.

Includes only one of the fields busId, folderId.

ID of the folder or bus to list connectors in.

pageSize

int64

The maximum number of results per response.

pageToken

string

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

filter

string

Supported fields for filter:
name
created_at

ListConnectorsResponse

{
  "connectors": [
    {
      "id": "string",
      "busId": "string",
      "folderId": "string",
      "cloudId": "string",
      "createdAt": "google.protobuf.Timestamp",
      "name": "string",
      "description": "string",
      "labels": "string",
      "source": {
        // Includes only one of the fields `dataStream`, `messageQueue`
        "dataStream": {
          "database": "string",
          "streamName": "string",
          "consumer": "string",
          "serviceAccountId": "string"
        },
        "messageQueue": {
          "queueArn": "string",
          "serviceAccountId": "string",
          "visibilityTimeout": "google.protobuf.Duration",
          "batchSize": "int64",
          "pollingTimeout": "google.protobuf.Duration"
        }
        // end of the list of possible fields
      },
      "deletionProtection": "bool",
      "status": "Status"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

connectors[]

Connector

List of connectors.

nextPageToken

string

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

Connector

Field

Description

id

string

ID of the connector.

busId

string

ID of the bus that the connector belongs to.

folderId

string

ID of the folder that the connector resides in.

cloudId

string

ID of the cloud that the connector resides in.

createdAt

google.protobuf.Timestamp

Creation timestamp.

name

string

Name of the connector.

description

string

Description of the connector.

labels

string

Resource labels as key:value pairs.

source

Source

Source of the connector.

deletionProtection

bool

Deletion protection.

status

enum Status

Status of the connector.

  • STATUS_UNSPECIFIED
  • RUNNING
  • STOPPED: disabled by user
  • RESOURCE_NOT_FOUND: source does not exist
  • PERMISSION_DENIED: service account does not have read permission on source
  • SUBJECT_NOT_FOUND: service account not found
  • DELETING: deletion in progress
  • CREATING: creation in progress

Source

Field

Description

dataStream

DataStream

Includes only one of the fields dataStream, messageQueue.

messageQueue

MessageQueue

Includes only one of the fields dataStream, messageQueue.

DataStream

Field

Description

database

string

Required field. Stream database.
example: /ru-central1/aoegtvhtp8ob********/cc8004q4lbo6********

streamName

string

Required field. Stream name, absolute or relative.

consumer

string

Required field. Consumer name.

serviceAccountId

string

Required field. Service account which has read permission on the stream.

MessageQueue

Field

Description

queueArn

string

Required field. Queue ARN.
Example: yrn:yc:ymq:ru-central1:aoe***:test

serviceAccountId

string

Required field. Service account which has read access to the queue.

visibilityTimeout

google.protobuf.Duration

Queue visibility timeout override.

batchSize

int64

Batch size for polling.

pollingTimeout

google.protobuf.Duration

Queue polling timeout.
Previous
Get
Next
Create