Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
    • Yandex Cloud Partner program
  • Blog
  • Pricing
  • Documentation
© 2025 Direct Cursus Technology L.L.C.
Yandex Serverless Integrations
  • Pricing policy
  • Terraform reference
    • API authentication
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • Start
        • Stop
        • ListAccessBindings
        • SetAccessBindings
        • UpdateAccessBindings
        • ListOperations
  • Release notes

In this article:

  • gRPC request
  • GetConnectorRequest
  • Connector
  • Source
  • DataStream
  • MessageQueue
  • Timer
  1. EventRouter API reference
  2. gRPC
  3. Connector
  4. Get

EventRouter Service, gRPC: ConnectorService.Get

Written by
Yandex Cloud
Updated at April 24, 2025
  • gRPC request
  • GetConnectorRequest
  • Connector
  • Source
  • DataStream
  • MessageQueue
  • Timer

Returns the specified bus.
To get the list of all available connectors, make a List request.

gRPC requestgRPC request

rpc Get (GetConnectorRequest) returns (Connector)

GetConnectorRequestGetConnectorRequest

{
  "connector_id": "string"
}

Field

Description

connector_id

string

Required field. ID of the connector to return.

ConnectorConnector

{
  "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`
    "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"
    }
    // end of the list of possible fields
  },
  "deletion_protection": "bool",
  "status": "Status"
}

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

google.protobuf.Timestamp

Creation timestamp.

name

string

Name of the connector.

description

string

Description of the connector.

labels

object (map<string, string>)

Resource labels as key:value pairs.

source

Source

Source of the connector.

deletion_protection

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

SourceSource

Field

Description

data_stream

DataStream

Includes only one of the fields data_stream, message_queue, timer.

message_queue

MessageQueue

Includes only one of the fields data_stream, message_queue, timer.

timer

Timer

Includes only one of the fields data_stream, message_queue, timer.

DataStreamDataStream

Field

Description

database

string

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

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.

MessageQueueMessageQueue

Field

Description

queue_arn

string

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

service_account_id

string

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

visibility_timeout

google.protobuf.Duration

Queue visibility timeout override.

batch_size

int64

Batch size for polling.

polling_timeout

google.protobuf.Duration

Queue polling timeout.

TimerTimer

Field

Description

cron_expression

string

Required field. cron expression, with second precision

time_zone

string

time zone, e.g. Europe/Moscow

payload

string

payload to send to target

Was the article helpful?

Previous
Overview
Next
List
© 2025 Direct Cursus Technology L.L.C.