Skip to main content

Create

Creates a connector in the specified folder.

import {
  cloudApi,
  decodeMessage,
  serviceClients,
  Session,
  waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const Connector = cloudApi.mdb.kafka_connector.Connector;
const CreateConnectorRequest =
  cloudApi.mdb.kafka_connector_service.CreateConnectorRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.ConnectorServiceClient);

  const operation = await client.create(
    CreateConnectorRequest.fromPartial({
      clusterId: "clusterId",
      connectorSpec: {
        // name: "name",
        // tasksMax: {
        // value: 0
        // },
        // properties: {"key": "properties"},
        // connectorConfigMirrormaker: {
        // sourceCluster: {
        // alias: "alias",
        // thisCluster: {
        // },
        // externalCluster: {
        // bootstrapServers: "bootstrapServers",
        // saslUsername: "saslUsername",
        // saslPassword: "saslPassword",
        // saslMechanism: "saslMechanism",
        // securityProtocol: "securityProtocol",
        // sslTruststoreCertificates: "sslTruststoreCertificates"
        // }
        // },
        // targetCluster: {
        // alias: "alias",
        // thisCluster: {
        // },
        // externalCluster: {
        // bootstrapServers: "bootstrapServers",
        // saslUsername: "saslUsername",
        // saslPassword: "saslPassword",
        // saslMechanism: "saslMechanism",
        // securityProtocol: "securityProtocol",
        // sslTruststoreCertificates: "sslTruststoreCertificates"
        // }
        // },
        // topics: "topics",
        // replicationFactor: {
        // value: 0
        // }
        // },
        // connectorConfigS3Sink: {
        // topics: "topics",
        // fileCompressionType: "fileCompressionType",
        // fileMaxRecords: {
        // value: 0
        // },
        // s3Connection: {
        // bucketName: "bucketName",
        // externalS3: {
        // accessKeyId: "accessKeyId",
        // secretAccessKey: "secretAccessKey",
        // endpoint: "endpoint",
        // region: "region"
        // }
        // }
        // }
      },
    })
  );
  const finishedOp = await waitForOperation(operation, session);

  if (finishedOp.response) {
    const result = decodeMessage<typeof Connector>(finishedOp.response);
    console.log(result);
  }
})();

CreateConnectorRequest​

busId : string​

ID of the bus to create a connector in.

name : string​

Name of the connector.

description : string​

Description of the connector.

labels : string​

Labels for the connector.

source : Source​

Source of the connector.

deletionProtection : bool​

Flag that disallow deletion of the connector.

Source​

One of source​

  • dataStream : DataStream​
  • messageQueue : MessageQueue​

DataStream​

database : string​

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

streamName : string​

Stream name, absolute or relative.

consumer : string​

Consumer name.

serviceAccountId : string​

Service account which has read permission on the stream.

MessageQueue​

queueArn : string​

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

serviceAccountId : string​

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.

Operation​

An Operation resource. For more information, see Operation.

id : string​

ID of the operation.

description : string​

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

createdBy : string​

ID of the user or service account who initiated the operation.

modifiedAt : google.protobuf.Timestamp​

The time when the Operation resource was last modified.

done : bool​

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadata : google.protobuf.Any​

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.

One of result​

The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.

  • error : google.rpc.Status​

    The error result of the operation in case of failure or cancellation.

  • response : google.protobuf.Any​
    The normal response of the operation in case of success.

    If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.