EventRouter Service, gRPC: ConnectorService.Get
Returns the specified bus.
To get the list of all available connectors, make a List request.
gRPC request
rpc Get (GetConnectorRequest) returns (Connector)
GetConnectorRequest
{
"connectorId": "string"
}
|
Field |
Description |
|
connectorId |
string Required field. ID of the connector to return. |
Connector
{
"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"
}
|
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 |
Creation timestamp. |
|
name |
string Name of the connector. |
|
description |
string Description of the connector. |
|
labels |
string Resource labels as |
|
source |
Source of the connector. |
|
deletionProtection |
bool Deletion protection. |
|
status |
enum Status Status of the connector.
|
Source
|
Field |
Description |
|
dataStream |
Includes only one of the fields |
|
messageQueue |
Includes only one of the fields |
DataStream
|
Field |
Description |
|
database |
string Required field. Stream database. |
|
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. |
|
serviceAccountId |
string Required field. Service account which has read access to the queue. |
|
visibilityTimeout |
Queue visibility timeout override. |
|
batchSize |
int64 Batch size for polling. |
|
pollingTimeout |
Queue polling timeout. |