Service doublecloud.kafka.v1.ConnectorService

Get

Returns information about an Apache Kafka® connector.

Request

Field

Description

cluster_id

string
ID of the Apache Kafka® cluster the connector belongs to.

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

connector_name

string
Name of the Apache Kafka® connector to return information about.

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

Response

Field

Description

name

string
Name of the connector.

tasks_max

google.protobuf.Int64Value
Maximum number of connector tasks. Default value is the number of brokers.

properties

list
A set of properties passed to Managed Service for Apache Kafka® with the
connector configuration.
Example: sync.topics.config.enabled: true.

properties[]

doublecloud.kafka.v1.Connector.PropertiesEntry

health

doublecloud.kafka.v1.Connector.Health
Connector health.

status

doublecloud.kafka.v1.Connector.Status
Current status of the connector.

cluster_id

string
ID of the Apache Kafka® cluster that the connector belongs to.

connector_config

one of: connector_config_mirrormaker / connector_config_s3_sink
Configuration of the MirrorMaker connector.

connector_config_mirrormaker

doublecloud.kafka.v1.ConnectorConfigMirrorMaker
Configuration of the MirrorMaker connector.

connector_config_s3_sink

doublecloud.kafka.v1.ConnectorConfigS3Sink
Configuration of S3-Sink connector.

List

Retrieves the list of Apache Kafka® connectors in a cluster.

Request

Field

Description

cluster_id

string
ID of the Apache Kafka® cluster to list connectors in.

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

paging

doublecloud.v1.Paging
Paging information of the request.
See [doublecloud.priv.v1.Paging] for details

Following constraints applied:

  • page_size will be set to 1000 items when exceeded
  • page_size expected to be >= 0
  • default page_size is 100

Response

Field

Description

connectors

list
List of Apache Kafka® Connectors.

connectors[]

doublecloud.kafka.v1.Connector

next_page

doublecloud.v1.NextPage
Pagination information of the response
See [doublecloud.priv.v1.NextPage] for details

Create

Creates a new Apache Kafka® connector in a cluster.

Request

Field

Description

cluster_id

string
ID of the Apache Kafka® cluster to create the connector in.

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

connector_spec

doublecloud.kafka.v1.ConnectorSpec
Configuration of the connector to create.

Response

Field

Description

id

string
ID of the operation.

project_id

string
ID of the project where operation performed.

description

string
Description of the operation.

created_by

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

metadata

list
Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp
The time when the operation was created.

start_time

google.protobuf.Timestamp
The time when the operation was started.

finish_time

google.protobuf.Timestamp
The time when the operation was finished.

status

doublecloud.v1.Operation.Status
The status of the operation.

error

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

resource_id

string
ID of the resource operation performed on.

Update

Updates an Apache Kafka® connector.

Request

Field

Description

cluster_id

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

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

connector_name

string
Name of the connector to update.

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

connector_spec

doublecloud.kafka.v1.UpdateConnectorSpec
Configuration of the connector to update.

Response

Field

Description

id

string
ID of the operation.

project_id

string
ID of the project where operation performed.

description

string
Description of the operation.

created_by

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

metadata

list
Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp
The time when the operation was created.

start_time

google.protobuf.Timestamp
The time when the operation was started.

finish_time

google.protobuf.Timestamp
The time when the operation was finished.

status

doublecloud.v1.Operation.Status
The status of the operation.

error

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

resource_id

string
ID of the resource operation performed on.

Delete

Deletes an Apache Kafka® connector.

Request

Field

Description

cluster_id

string
ID of the Apache Kafka® cluster to delete the connector from.

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

connector_name

string
Name of the connector to delete.

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

Response

Field

Description

id

string
ID of the operation.

project_id

string
ID of the project where operation performed.

description

string
Description of the operation.

created_by

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

metadata

list
Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp
The time when the operation was created.

start_time

google.protobuf.Timestamp
The time when the operation was started.

finish_time

google.protobuf.Timestamp
The time when the operation was finished.

status

doublecloud.v1.Operation.Status
The status of the operation.

error

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

resource_id

string
ID of the resource operation performed on.

Resume

Resumes an Apache Kafka® connector.

Request

Field

Description

cluster_id

string
ID of the Apache Kafka® cluster to resume the connector in.

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

connector_name

string
Name of the Apache Kafka® connector to resume.

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

Response

Field

Description

id

string
ID of the operation.

project_id

string
ID of the project where operation performed.

description

string
Description of the operation.

created_by

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

metadata

list
Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp
The time when the operation was created.

start_time

google.protobuf.Timestamp
The time when the operation was started.

finish_time

google.protobuf.Timestamp
The time when the operation was finished.

status

doublecloud.v1.Operation.Status
The status of the operation.

error

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

resource_id

string
ID of the resource operation performed on.

Pause

Pauses an Apache Kafka® connector.

Request

Field

Description

cluster_id

string
ID of the Apache Kafka® cluster to pause the connector in.

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

connector_name

string
Name of the Apache Kafka® connector to pause.

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

Response

Field

Description

id

string
ID of the operation.

project_id

string
ID of the project where operation performed.

description

string
Description of the operation.

created_by

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

metadata

list
Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp
The time when the operation was created.

start_time

google.protobuf.Timestamp
The time when the operation was started.

finish_time

google.protobuf.Timestamp
The time when the operation was finished.

status

doublecloud.v1.Operation.Status
The status of the operation.

error

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

resource_id

string
ID of the resource operation performed on.