EventRouter Service, REST: Connector methods
A set of methods for managing connectors for serverless eventrouter.
JSON Representation
{
"id": "string",
"busId": "string",
"folderId": "string",
"cloudId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"source": {
// `source` includes only one of the fields `dataStream`, `messageQueue`
"dataStream": {
"database": "string",
"streamName": "string",
"consumer": "string",
"serviceAccountId": "string"
},
"messageQueue": {
"queueArn": "string",
"serviceAccountId": "string",
"visibilityTimeout": "string",
"batchSize": "string",
"pollingTimeout": "string"
},
// end of the list of possible fields`source`
},
"deletionProtection": true,
"status": "string"
}
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 | string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
name | string Name of the connector. |
description | string Description of the connector. |
labels | object Resource labels as |
source | object Source of the connector. |
source. dataStream |
object source includes only one of the fields dataStream , messageQueue |
source. dataStream. database |
string Required. Stream database. example: /ru-central1/aoegtvhtp8ob********/cc8004q4lbo6******** |
source. dataStream. streamName |
string Required. Stream name, absolute or relative. |
source. dataStream. consumer |
string Required. Consumer name. |
source. dataStream. serviceAccountId |
string Required. Service account which has read permission on the stream. |
source. messageQueue |
object source includes only one of the fields dataStream , messageQueue |
source. messageQueue. queueArn |
string Required. Queue ARN. Example: yrn:yc:ymq:ru-central1:aoe***:test |
source. messageQueue. serviceAccountId |
string Required. Service account which has read access to the queue. The maximum string length in characters is 50. |
source. messageQueue. visibilityTimeout |
string Queue visibility timeout override. The maximum value is 43200 seconds. |
source. messageQueue. batchSize |
string (int64) Batch size for polling. The maximum value is 10. |
source. messageQueue. pollingTimeout |
string Queue polling timeout. The maximum value is 20 seconds. |
deletionProtection | boolean (boolean) Deletion protection. |
status | string Status of the connector. Status of the connector.
|
Methods
Method | Description |
---|---|
create | Creates a connector in the specified folder. |
delete | Deletes the specified connector. |
get | Returns the specified bus. To get the list of all available connectors, make a list request. |
list | Retrieves the list of connectors in the specified folder. |
listAccessBindings | Lists existing access bindings for the specified bus. |
listOperations | Lists operations for the specified connector. |
setAccessBindings | Sets access bindings for the connector. |
start | Starts the specified connector. |
stop | Stops the specified connector. |
update | Updates the specified connector. |
updateAccessBindings | Updates access bindings for the specified connector. |