Skip to main content

Update

Updates an Apache Kafka® connector.

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

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

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

  const operation = await client.update(
    UpdateConnectorRequest.fromPartial({
      clusterId: "clusterId",
      connectorName: "connectorName",
      // updateMask: {
      // paths: ["paths"]
      // },
      connectorSpec: {
        // 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",
        // 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);
  }
})();

UpdateConnectorRequest​

clusterId : string​

ID of the Apache Kafka® cluster to update the connector in.

To get this ID, make a ClusterService.List request.

connectorName : string​

Name of the connector to update.

To get this name, make a ConnectorService.List request.

updateMask : google.protobuf.FieldMask​

Field mask that specifies which settings of the connector should be updated.

connectorSpec : UpdateConnectorSpec​

Configuration of the connector to update.

UpdateConnectorSpec​

tasksMax : google.protobuf.Int64Value​

Maximum number of connector tasks to update.

properties : string​

A set of new or changed properties to update for the connector. They are passed with the connector configuration to Managed Service for Apache Kafka®. Example: sync.topics.config.enabled: false.

One of connectorConfig​

Updated configuration for the connector.

  • connectorConfigMirrormaker : ConnectorConfigMirrorMakerSpec​

    Configuration of the MirrorMaker connector.

  • connectorConfigS3Sink : UpdateConnectorConfigS3SinkSpec​

    Update specification for S3-Sink Connector.

ConnectorConfigMirrorMakerSpec​

sourceCluster : ClusterConnectionSpec​

Source cluster configuration for the MirrorMaker connector.

targetCluster : ClusterConnectionSpec​

Target cluster configuration for the MirrorMaker connector.

topics : string​

List of Kafka topics, separated by ,.

replicationFactor : google.protobuf.Int64Value​

Replication factor for automatically created topics.

UpdateConnectorConfigS3SinkSpec​

Specification for update Kafka S3-Sink Connector.

topics : string​

List of Kafka topics, separated by ','.

fileMaxRecords : google.protobuf.Int64Value​

Max records per file.

s3Connection : S3ConnectionSpec​

Credentials for connecting to S3 storage.

ClusterConnectionSpec​

alias : string​

Alias of cluster connection configuration. Examples: source, target.

One of clusterConnection​

Type of connection to Apache Kafka® cluster.

  • thisCluster : ThisClusterSpec​

    Connection configuration of the cluster the connector belongs to. As all credentials are already known, leave this parameter empty.

  • externalCluster : ExternalClusterConnectionSpec​

    Configuration of connection to an external cluster with all the necessary credentials.

S3ConnectionSpec​

Specification for S3Connection - settings of connection to AWS-compatible S3 storage, that are source or target of Kafka S3-connectors. YC Object Storage is AWS-compatible.

bucketName : string​

One of storage​

  • externalS3 : ExternalS3StorageSpec​

ThisClusterSpec​

ExternalClusterConnectionSpec​

bootstrapServers : string​

List of bootstrap servers of the cluster, separated by ,.

saslUsername : string​

SASL username to use for connection to the cluster.

saslPassword : string​

SASL password to use for connection to the cluster.

saslMechanism : string​

SASL mechanism to use for connection to the cluster.

securityProtocol : string​

Security protocol to use for connection to the cluster.

sslTruststoreCertificates : string​

CA in PEM format to connect to external cluster. Lines of certificate separated by '\n' symbol.

ExternalS3StorageSpec​

accessKeyId : string​
secretAccessKey : string​
endpoint : string​
region : string​

Default is 'us-east-1'.

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.