Подключиться
Language / Region
© 2022 ООО «Яндекс.Облако»
Yandex Managed Service for Apache Kafka®

Connector

Статья создана

A set of methods for managing Apache Kafka Connectors resources.

JSON Representation

{
  "name": "string",
  "tasksMax": "integer",
  "properties": "object",
  "health": "string",
  "status": "string",
  "clusterId": "string",
  "connectorConfigMirrormaker": {
    "sourceCluster": {
      "alias": "string",

      // `connectorConfigMirrormaker.sourceCluster` includes only one of the fields `thisCluster`, `externalCluster`
      "thisCluster": {},
      "externalCluster": {
        "bootstrapServers": "string",
        "saslUsername": "string",
        "saslMechanism": "string",
        "securityProtocol": "string"
      },
      // end of the list of possible fields`connectorConfigMirrormaker.sourceCluster`

    },
    "targetCluster": {
      "alias": "string",

      // `connectorConfigMirrormaker.targetCluster` includes only one of the fields `thisCluster`, `externalCluster`
      "thisCluster": {},
      "externalCluster": {
        "bootstrapServers": "string",
        "saslUsername": "string",
        "saslMechanism": "string",
        "securityProtocol": "string"
      },
      // end of the list of possible fields`connectorConfigMirrormaker.targetCluster`

    },
    "topics": "string",
    "replicationFactor": "integer"
  }
}
Field Description
name string

Name of the connector.
tasksMax integer (int64)

Maximum number of tasks. Default is the number of brokers
properties object

Properties passed with connector config to Connect service Example: 'sync.topics.config.enabled: true'
health string
Connector health.
  • HEALTH_UNKNOWN: State of the connector is unknown.
  • ALIVE: Connector is running.
  • DEAD: Connector is failed to start.
status string
Current status of the connector.
  • STATUS_UNKNOWN: Connector state is unknown.
  • RUNNING: Connector is running normally.
  • ERROR: Connector encountered a problem and cannot operate.
  • PAUSED: Connector paused.
clusterId string

ID of the Apache Kafka cluster that the connector belongs to.
connectorConfigMirrormaker object

An An Apache Kafka® MirrorMaker connector resource.
connectorConfigMirrormaker.
sourceCluster		 object

Source cluster resource settings.

Resource ClusterConnection - settings of connection to clusters, that are source or target of MirrorMaker clusters.
connectorConfigMirrormaker.
sourceCluster.
alias		 string

Alias of ClusterConnection resource. For example: 'source', 'target', ...
connectorConfigMirrormaker.
sourceCluster.
thisCluster		 object
connectorConfigMirrormaker.sourceCluster includes only one of the fields thisCluster, externalCluster

Resource of cluster_connection type 'this_cluster'.
connectorConfigMirrormaker.
sourceCluster.
externalCluster		 object
connectorConfigMirrormaker.sourceCluster includes only one of the fields thisCluster, externalCluster

Resource of connection to external cluster. It contains all settings of connection to external cluster.
connectorConfigMirrormaker.
sourceCluster.
externalCluster.
bootstrapServers		 string

List bootstrap servers of cluster, separated by ','
connectorConfigMirrormaker.
sourceCluster.
externalCluster.
saslUsername		 string

Sasl username which we use to connect to cluster.
connectorConfigMirrormaker.
sourceCluster.
externalCluster.
saslMechanism		 string

Sasl mechanism, which we should use to connect to cluster.
connectorConfigMirrormaker.
sourceCluster.
externalCluster.
securityProtocol		 string

Security protocol, which we should use to connect to cluster.
connectorConfigMirrormaker.
targetCluster		 object

Target cluster resource settings.

Resource ClusterConnection - settings of connection to clusters, that are source or target of MirrorMaker clusters.
connectorConfigMirrormaker.
targetCluster.
alias		 string

Alias of ClusterConnection resource. For example: 'source', 'target', ...
connectorConfigMirrormaker.
targetCluster.
thisCluster		 object
If type is 'this_cluster' - we connect to cluster that is handle Kafka Connect Worker, on which we try to register connector.
connectorConfigMirrormaker.targetCluster includes only one of the fields thisCluster, externalCluster

Resource of cluster_connection type 'this_cluster'.
connectorConfigMirrormaker.
targetCluster.
externalCluster		 object
If type is 'external_cluster' - we connect to cluster that is not handle Kafka Connect Worker, on which we try to register connector.
connectorConfigMirrormaker.targetCluster includes only one of the fields thisCluster, externalCluster

Resource of connection to external cluster. It contains all settings of connection to external cluster.
connectorConfigMirrormaker.
targetCluster.
externalCluster.
bootstrapServers		 string

List bootstrap servers of cluster, separated by ','
connectorConfigMirrormaker.
targetCluster.
externalCluster.
saslUsername		 string

Sasl username which we use to connect to cluster.
connectorConfigMirrormaker.
targetCluster.
externalCluster.
saslMechanism		 string

Sasl mechanism, which we should use to connect to cluster.
connectorConfigMirrormaker.
targetCluster.
externalCluster.
securityProtocol		 string

Security protocol, which we should use to connect to cluster.
connectorConfigMirrormaker.
topics		 string

List of Kafka topics, separated by ','
connectorConfigMirrormaker.
replicationFactor		 integer (int64)

Replication factor for automatically created topics.

Methods

Method Description
create Creates a new Apache Kafka connector in the specified cluster.
delete Deletes the specified Apache Kafka connector.
get Returns the specified Apache Kafka Connector resource.
list Retrieves the list of Apache Kafka Connector resources in the specified cluster.
pause Pause the specified Apache Kafka connector.
resume Resume the specified Apache Kafka connector.
update Updates an Apache Kafka connector in the specified cluster.
Language / Region
© 2022 ООО «Яндекс.Облако»
В этой статье: