Kafka API models

ClusterView

Option	Description
CLUSTER_VIEW_INVALID	Invalid cluster view value.
CLUSTER_VIEW_BASIC	Output basic information about the cluster.
CLUSTER_VIEW_FULL	Output full information about the cluster including allocated resources and Apache Kafka® settings.

Connector.Health

Option	Description
HEALTH_INVALID	Health of the connector is unknown.
HEALTH_ALIVE	Connector is running.
HEALTH_DEAD	Connector has failed to start.

Connector.Status

Option	Description
STATUS_INVALID	Connector state is unknown.
STATUS_RUNNING	Connector is running normally.
STATUS_ERROR	Connector has encountered a problem and cannot operate.
STATUS_PAUSED	Connector is paused.

TopicConfig28.CleanupPolicy

Option	Description
CLEANUP_POLICY_INVALID
CLEANUP_POLICY_DELETE
CLEANUP_POLICY_COMPACT
CLEANUP_POLICY_COMPACT_AND_DELETE

TopicConfig28.CompressionType

Option	Description
COMPRESSION_TYPE_INVALID
COMPRESSION_TYPE_UNCOMPRESSED
COMPRESSION_TYPE_ZSTD
COMPRESSION_TYPE_LZ4
COMPRESSION_TYPE_SNAPPY
COMPRESSION_TYPE_GZIP
COMPRESSION_TYPE_PRODUCER

TopicConfig3.CleanupPolicy

Option	Description
CLEANUP_POLICY_INVALID
CLEANUP_POLICY_DELETE
CLEANUP_POLICY_COMPACT
CLEANUP_POLICY_COMPACT_AND_DELETE

TopicConfig3.CompressionType

Option	Description
COMPRESSION_TYPE_INVALID
COMPRESSION_TYPE_UNCOMPRESSED
COMPRESSION_TYPE_ZSTD
COMPRESSION_TYPE_LZ4
COMPRESSION_TYPE_SNAPPY
COMPRESSION_TYPE_GZIP
COMPRESSION_TYPE_PRODUCER

Permission.AccessRole

Each role abstracts away multiple operations

Option	Description
ACCESS_ROLE_INVALID
ACCESS_ROLE_PRODUCER	Grants describe, read and write topic operations
ACCESS_ROLE_CONSUMER	Grants describe and read topic operations
ACCESS_ROLE_ADMIN	Grants full access, including describe, read, write, manage and delete topic

Cluster

Field	Description
`id`	string ID of the Apache Kafka® cluster.
`project_id`	string ID of the project that the Apache Kafka® cluster belongs to.
`cloud_type`	string Type of the cloud where instances should be hosted.
`region_id`	string ID of the region to place instances.
`create_time`	google.protobuf.Timestamp Creation timestamp.
`name`	string Name of the Apache Kafka® cluster. The name is unique within the project.
`description`	string Description of the Apache Kafka® cluster.
`status`	doublecloud.v1.ClusterStatus Current state of the cluster.
`version`	string Version of Apache Kafka®.
`resources`	doublecloud.kafka.v1.ClusterResources Resources allocated to the Apache Kafka® cluster.
`connection_info`	doublecloud.kafka.v1.ConnectionInfo Connection information.
`access`	doublecloud.v1.Access Access settings
`encryption`	doublecloud.v1.DataEncryption DataEncryption settings
`network_id`	string ID of the network that the Apache Kafka® cluster belongs to.
`private_connection_info`	doublecloud.kafka.v1.PrivateConnectionInfo Private connection information.
`maintenance_window`	doublecloud.v1.MaintenanceWindow Window of maintenance operations.
`planned_operation`	doublecloud.v1.MaintenanceOperation Maintenance operation planned at nearest maintenance_window.
`kafka_config`	doublecloud.kafka.v1.KafkaConfig Configuration of the Apache Kafka cluster.
`metrics_exporter_connection_info`	doublecloud.kafka.v1.MetricsExporterConnectionInfo Prometheus metrics exporter endpoint HTTP basic auth information.
`schema_registry_config`	doublecloud.kafka.v1.SchemaRegistryConfig Configuration of Schema Registry.
`rest_api_config`	doublecloud.kafka.v1.RestAPIConfig Configuration of REST API.

ClusterResources

Field	Description
`kafka`	doublecloud.kafka.v1.ClusterResources.Kafka Resources allocated to Apache Kafka® hosts.

ClusterResources.Kafka

Field	Description
`resource_preset_id`	string ID of the preset for computational resources available to a host (CPU, memory etc.).
`disk_size`	google.protobuf.Int64Value Volume of the storage available to a host, in bytes.
`broker_count`	google.protobuf.Int64Value The number of Kafka brokers deployed in each availability zone.
`zone_count`	google.protobuf.Int64Value The number of availability zones where Kafka brokers reside.

ConnectionInfo

Field	Description
`connection_string`	string String to use in clients.
`user`	string Apache Kafka® user.
`password`	string Password for Apache Kafka® user.

Host

Field	Description
`name`	string Required. Name of the host.
`cluster_id`	string Required. ID of the Apache Kafka® cluster.
`status`	doublecloud.v1.HostStatus Aggregated host status

MetricsExporterConnectionInfo

Field	Description
`user`	string User for HTTP basic auth.
`password`	string Password for HTTP basic auth.

PrivateConnectionInfo

Field	Description
`connection_string`	string String to use in clients.
`user`	string Apache Kafka® user.
`password`	string Password for Apache Kafka® user.

CreateClusterRequest

Field	Description
`project_id`	string ID of the project to create the Apache Kafka® cluster in.
`cloud_type`	string Type of the cloud where instances should be hosted.
`region_id`	string ID of the region to place instances.
`name`	string Name of the Apache Kafka® cluster. The name must be unique within the project.
`description`	string Description of the Apache Kafka® cluster.
`version`	string Version of Apache Kafka®.
`resources`	doublecloud.kafka.v1.ClusterResources Resources allocated to the Apache Kafka® cluster.
`access`	doublecloud.v1.Access Access settings
`encryption`	doublecloud.v1.DataEncryption DataEncryption settings
`network_id`	string ID of the network to create the Apache Kafka® cluster in.
`maintenance_window`	doublecloud.v1.MaintenanceWindow Window of maintenance operations.
`kafka_config`	doublecloud.kafka.v1.KafkaConfig Configuration and resources for hosts that should be created for the Apache Kafka® cluster.
`schema_registry_config`	doublecloud.kafka.v1.SchemaRegistryConfig Configuration of Schema Registry.
`rest_api_config`	doublecloud.kafka.v1.RestAPIConfig Configuration of REST API.

DeleteClusterRequest

Field	Description
`cluster_id`	string ID of the Apache Kafka® cluster to delete. To get the Apache Kafka® cluster ID, use a [ClusterService.List] request.

GetClusterRequest

Field	Description
`cluster_id`	string ID of the Apache Kafka® cluster resource to return.
`sensitive`	bool Whether to include sensitive data in the response. If unspecified, defaults to false.

ListClusterHostsRequest

Field	Description
`cluster_id`	string ID of the Apache Kafka cluster. To get the Apache Kafka cluster ID use a [ClusterService.List] request.
`paging`	doublecloud.v1.Paging Paging information of the request

ListClusterHostsResponse

Field	Description
`hosts`	list List of Host resources.
`hosts[]`	doublecloud.kafka.v1.Host
`next_page`	doublecloud.v1.NextPage Pagination information of the response

ListClusterOperationsRequest

Field	Description
`cluster_id`	string Required. ID of the Kafka cluster.
`paging`	doublecloud.v1.Paging Paging information of the request

ListClusterOperationsResponse

Field	Description
`operations`	list
`operations[]`	doublecloud.v1.Operation
`next_page`	doublecloud.v1.NextPage Pagination information of the response

ListClustersRequest

Field	Description
`project_id`	string ID of the project to list Apache Kafka® clusters in.
`paging`	doublecloud.v1.Paging Paging information of the request
`view`	doublecloud.kafka.v1.ClusterView The level of detail to be returned. If unspecified, defaults to CLUSTER_VIEW_BASIC.

ListClustersResponse

Field	Description
`clusters`	list List of Apache Kafka® cluster resources.
`clusters[]`	doublecloud.kafka.v1.Cluster
`next_page`	doublecloud.v1.NextPage Pagination information of the response

RescheduleMaintenanceRequest

Field	Description
`cluster_id`	string Required. ID of the Kafka cluster to maintenance reschedule.
`reschedule_type`	doublecloud.v1.RescheduleType Required. The type of reschedule request.
`delayed_until_time`	google.protobuf.Timestamp The time for SPECIFIC_TIME reschedule. Limited by two weeks since first time scheduled.

ResetClusterCredentialsRequest

Field	Description
`cluster_id`	string ID of the Apache Kafka® cluster to reset credentials. To get the Apache Kafka® cluster ID, use a [ClusterService.List] request.

StartClusterRequest

Field	Description
`cluster_id`	string ID of the Kafka cluster to start.

StopClusterRequest

Field	Description
`cluster_id`	string ID of the Kafka cluster to stop.

UpdateClusterRequest

Field	Description
`cluster_id`	string ID of the Apache Kafka Cluster resource to update. To get the Apache Kafka cluster ID, use a [ClusterService.List] request.
`name`	string New name of the Apache Kafka® cluster. The name must be unique within the project.
`description`	string New description of the Apache Kafka cluster.
`version`	string Version of Apache Kafka®.
`resources`	doublecloud.kafka.v1.ClusterResources New resources allocated to the Apache Kafka® cluster.
`access`	doublecloud.v1.Access Access settings
`maintenance_window`	doublecloud.v1.MaintenanceWindow Window of maintenance operations.
`kafka_config`	doublecloud.kafka.v1.KafkaConfig Configuration and resources for hosts that should be created for the Apache Kafka® cluster.
`schema_registry_config`	doublecloud.kafka.v1.SchemaRegistryConfig Configuration of Schema Registry.
`rest_api_config`	doublecloud.kafka.v1.RestAPIConfig Configuration of REST API.

KafkaConfig

Field	Description
`message_max_bytes`	google.protobuf.Int64Value The largest record batch size allowed by Kafka. Default value: 1048588.
`replica_fetch_max_bytes`	google.protobuf.Int64Value The number of bytes of messages to attempt to fetch for each partition. Default value: 1048576.

RestAPIConfig

Field	Description
`enabled`	bool Is REST API enabled for this cluster.

SchemaRegistryConfig

Field	Description
`enabled`	bool Is Schema Registry enabled for this cluster.

ClusterConnection

Field	Description
`alias`	string Alias of cluster connection configuration. Examples: `source`, `target`.
`cluster_connection`	one of: `this_cluster` / `external_cluster` Connection configuration of the cluster the connector belongs to. As all credentials are already known, leave this parameter empty.
`this_cluster`	doublecloud.kafka.v1.ThisCluster Connection configuration of the cluster the connector belongs to. As all credentials are already known, leave this parameter empty.
`external_cluster`	doublecloud.kafka.v1.ExternalClusterConnection Configuration of connection to an external cluster with all the necessary credentials.

ClusterConnectionSpec

Field	Description
`alias`	google.protobuf.StringValue Alias of cluster connection configuration. Examples: `source`, `target`.
`cluster_connection`	one of: `this_cluster` / `external_cluster` Connection configuration of the cluster the connector belongs to. As all credentials are already known, leave this parameter empty.
`this_cluster`	doublecloud.kafka.v1.ThisCluster Connection configuration of the cluster the connector belongs to. As all credentials are already known, leave this parameter empty.
`external_cluster`	doublecloud.kafka.v1.ExternalClusterConnectionSpec Configuration of connection to an external cluster with all the necessary credentials.

Connector

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.

Connector.PropertiesEntry

Field	Description
`key`	string
`value`	string

ConnectorConfigMirrorMaker

Field	Description
`source_cluster`	doublecloud.kafka.v1.ClusterConnection Source cluster connection configuration.
`target_cluster`	doublecloud.kafka.v1.ClusterConnection Target cluster connection configuration.
`topics`	string List of Kafka topics, separated by `,`.
`replication_factor`	google.protobuf.Int64Value Replication factor for automatically created topics.

ConnectorConfigMirrorMakerSpec

Field	Description
`source_cluster`	doublecloud.kafka.v1.ClusterConnectionSpec Source cluster configuration for the MirrorMaker connector.
`target_cluster`	doublecloud.kafka.v1.ClusterConnectionSpec Target cluster configuration for the MirrorMaker connector.
`topics`	string List of Kafka topics, separated by `,`.
`replication_factor`	google.protobuf.Int64Value Replication factor for automatically created topics.

ConnectorConfigS3Sink

Field	Description
`topics`	string List of Kafka topics, separated by ','.
`file_compression_type`	string The compression type used for files put on S3. The supported values are: `gzip`, `snappy`, `zstd`, `none`. Optional, the default is `none`. Empty value will be represent as `none`.
`file_max_records`	google.protobuf.Int64Value Max records per file.
`s3_connection`	doublecloud.kafka.v1.S3Connection Credentials for connecting to S3 storage.

ConnectorConfigS3SinkSpec

Field	Description
`topics`	string List of Kafka topics, separated by ','.
`file_compression_type`	string The compression type used for files put on S3. The supported values are: `gzip`, `snappy`, `zstd`, `none`. Optional, the default is `none`. Empty value will be represent as `none`.
`file_max_records`	google.protobuf.Int64Value Max records per file.
`s3_connection`	doublecloud.kafka.v1.S3ConnectionSpec Credentials for connecting to S3 storage.

ConnectorSpec

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.ConnectorSpec.PropertiesEntry
`connector_config`	one of: `connector_config_mirrormaker` / `connector_config_s3_sink` Configuration of the MirrorMaker connector.
`connector_config_mirrormaker`	doublecloud.kafka.v1.ConnectorConfigMirrorMakerSpec Configuration of the MirrorMaker connector.
`connector_config_s3_sink`	doublecloud.kafka.v1.ConnectorConfigS3SinkSpec Configuration of S3-Sink connector.

ConnectorSpec.PropertiesEntry

Field	Description
`key`	string
`value`	string

ExternalClusterConnection

Field	Description
`bootstrap_servers`	string List of bootstrap servers of the cluster, separated by `,`.
`sasl_username`	string SASL username to use for connection to the cluster.
`sasl_mechanism`	string SASL mechanism to use for connection to the cluster.
`security_protocol`	string Security protocol to use for connection to the cluster.

ExternalClusterConnectionSpec

Field	Description
`bootstrap_servers`	google.protobuf.StringValue List of bootstrap servers of the cluster, separated by `,`.
`sasl_username`	google.protobuf.StringValue SASL username to use for connection to the cluster.
`sasl_password`	google.protobuf.StringValue SASL password to use for connection to the cluster.
`sasl_mechanism`	google.protobuf.StringValue SASL mechanism to use for connection to the cluster.
`security_protocol`	google.protobuf.StringValue Security protocol to use for connection to the cluster.
`ssl_truststore_certificates`	google.protobuf.StringValue CA in PEM format to connect to external cluster. Lines of certificate separated by '\n' symbol.

S3Connection

Field	Description
`bucket_name`	string
`access_key_id`	string
`endpoint`	string
`region`	string Default is 'us-east-1'

S3ConnectionSpec

Field	Description
`bucket_name`	google.protobuf.StringValue
`access_key_id`	google.protobuf.StringValue
`secret_access_key`	google.protobuf.StringValue
`endpoint`	google.protobuf.StringValue
`region`	google.protobuf.StringValue Default is 'us-east-1'.

ThisCluster

Field

Description

UpdateConnectorConfigMirrorMakerSpec

Field	Description
`source_cluster`	doublecloud.kafka.v1.ClusterConnectionSpec Source cluster configuration for the MirrorMaker connector.
`target_cluster`	doublecloud.kafka.v1.ClusterConnectionSpec Target cluster configuration for the MirrorMaker connector.
`topics`	google.protobuf.StringValue List of Kafka topics, separated by ','.
`replication_factor`	google.protobuf.Int64Value Replication factor for automatically created topics.

UpdateConnectorConfigS3SinkSpec

Field	Description
`topics`	google.protobuf.StringValue List of Kafka topics, separated by ','.
`file_max_records`	google.protobuf.Int64Value Max records per file.
`s3_connection`	doublecloud.kafka.v1.S3ConnectionSpec Credentials for connecting to S3 storage.

UpdateConnectorSpec

Field	Description
`tasks_max`	google.protobuf.Int64Value Maximum number of connector tasks to update. Nil value is ignored and considered as non-set value.
`properties`	doublecloud.kafka.v1.UpdateConnectorSpec.UpdateProperties When provided, current properties will be replaced. See [UpdateProperties.properties] for details.
`connector_config`	one of: `connector_config_mirrormaker` / `connector_config_s3_sink` Configuration of the MirrorMaker connector.
`connector_config_mirrormaker`	doublecloud.kafka.v1.UpdateConnectorConfigMirrorMakerSpec Configuration of the MirrorMaker connector.
`connector_config_s3_sink`	doublecloud.kafka.v1.UpdateConnectorConfigS3SinkSpec Update specification for S3-Sink Connector.

UpdateConnectorSpec.UpdateProperties

Field	Description
`properties`	list New set of properties for the connector. Empty slice will remove all existing the properties.
`properties[]`	doublecloud.kafka.v1.UpdateConnectorSpec.UpdateProperties.PropertiesEntry

UpdateConnectorSpec.UpdateProperties.PropertiesEntry

Field	Description
`key`	string
`value`	string

CreateConnectorMetadata

Field	Description
`cluster_id`	string ID of the Apache Kafka® cluster the connector is being created in.
`connector_name`	string Name of the Apache Kafka® connector that is being created.

CreateConnectorRequest

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.

DeleteConnectorMetadata

Field	Description
`cluster_id`	string ID of the Apache Kafka® cluster the connector is being deleted from.
`connector_name`	string Name of the Apache Kafka® connector that is being deleted.

DeleteConnectorRequest

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.

GetConnectorRequest

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.

ListConnectorsRequest

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

ListConnectorsResponse

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

PauseConnectorMetadata

Field	Description
`cluster_id`	string ID of the Apache Kafka® cluster the connector is being paused in.
`connector_name`	string Name of the Apache Kafka® connector that is being paused.

PauseConnectorRequest

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.

ResumeConnectorMetadata

Field	Description
`cluster_id`	string ID of the Apache Kafka® cluster the connector is being resumed in.
`connector_name`	string Name of the Apache Kafka® connector that is beign resumed.

ResumeConnectorRequest

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.

UpdateConnectorMetadata

Field	Description
`cluster_id`	string ID of the Apache Kafka® cluster the connector is being updated in.
`connector_name`	string Name of the Apache Kafka® connector that is being updated.

UpdateConnectorRequest

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.

GetOperationRequest

Field	Description
`operation_id`	string Required. ID of the operation to return.

ListOperationsRequest

Field	Description
`project_id`	string ID of the project to list clusters operations in.
`paging`	doublecloud.v1.Paging Paging information of the request

ListOperationsResponse

Field	Description
`operations`	list List of operations.
`operations[]`	doublecloud.v1.Operation
`next_page`	doublecloud.v1.NextPage Pagination information of the response

Topic

Field	Description
`name`	string Name of the topic.
`cluster_id`	string ID of the Apache Kafka cluster that the topic belongs to.
`partitions`	google.protobuf.Int64Value Number of topic partitions.
`replication_factor`	google.protobuf.Int64Value Amount of copies of a topic data kept in a cluster.
`topic_config`	one of: `topic_config_2_8` / `topic_config_3`
`topic_config_2_8`	doublecloud.kafka.v1.TopicConfig28
`topic_config_3`	doublecloud.kafka.v1.TopicConfig3
`is_ha`	bool True if topic has SLA guaranties

TopicConfig28

Field	Description
`cleanup_policy`	doublecloud.kafka.v1.TopicConfig28.CleanupPolicy Retention policy to use on old log segments.
`compression_type`	doublecloud.kafka.v1.TopicConfig28.CompressionType Specify the final compression type for a given topic.
`retention_bytes`	google.protobuf.Int64Value This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the "delete" retention policy
`retention_ms`	google.protobuf.Int64Value This configuration controls the maximum time we will retain a log before we will discard old log segments to free up space if we are using the "delete" retention policy.
`max_message_bytes`	google.protobuf.Int64Value The largest record batch size allowed in topic.

TopicConfig3

Field	Description
`cleanup_policy`	doublecloud.kafka.v1.TopicConfig3.CleanupPolicy Retention policy to use on old log segments.
`compression_type`	doublecloud.kafka.v1.TopicConfig3.CompressionType Specify the final compression type for a given topic.
`retention_bytes`	google.protobuf.Int64Value This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the "delete" retention policy
`retention_ms`	google.protobuf.Int64Value This configuration controls the maximum time we will retain a log before we will discard old log segments to free up space if we are using the "delete" retention policy.
`max_message_bytes`	google.protobuf.Int64Value The largest record batch size allowed in topic.

TopicSpec

Field	Description
`name`	string Name of the topic.
`partitions`	google.protobuf.Int64Value Number of topic partitions
`replication_factor`	google.protobuf.Int64Value Amount of copies of a topic data kept in a cluster.
`topic_config`	one of: `topic_config_2_8` / `topic_config_3`
`topic_config_2_8`	doublecloud.kafka.v1.TopicConfig28
`topic_config_3`	doublecloud.kafka.v1.TopicConfig3

CreateTopicRequest

Field	Description
`cluster_id`	string Required. ID of the Apache Kafka cluster to create a topic in. To get the cluster ID use a [ClusterService.List] request.
`topic_spec`	doublecloud.kafka.v1.TopicSpec Required. Configuration of the topic to create.

DeleteTopicRequest

Field	Description
`cluster_id`	string Required. ID of the Apache Kafka cluster to delete a topic in. To get the cluster ID, use a [ClusterService.List] request.
`topic_name`	string Required. Name of the topic to delete. To get the name of the topic, use a [TopicService.List] request.

GetTopicRequest

Field	Description
`cluster_id`	string ID of the Apache Kafka cluster that the topic belongs to. To get the cluster ID use a [ClusterService.List] request.
`topic_name`	string Name of the Apache Kafka Topic resource to return. To get the name of the topic use a [TopicService.List] request.

ListTopicsRequest

Field	Description
`cluster_id`	string ID of the Apache Kafka cluster to list topics in. To get the cluster ID use a [ClusterService.List] request.
`paging`	doublecloud.v1.Paging Paging information of the request

ListTopicsResponse

Field	Description
`topics`	list List of Apache Kafka Topic resources.
`topics[]`	doublecloud.kafka.v1.Topic
`next_page`	doublecloud.v1.NextPage Pagination information of the response

UpdateTopicRequest

Field	Description
`cluster_id`	string Required. ID of the Apache Kafka cluster to update a topic in. To get the cluster ID use a [ClusterService.List] request.
`topic_name`	string Required. Name of the topic to update. To get the name of the topic use a [TopicService.List] request.
`topic_spec`	doublecloud.kafka.v1.TopicSpec Required. Configuration of the topic to create.

Permission

Field

Description

topic_name

string
Name or prefix-pattern with wildcard for the topic that the permission grants
access to.

Examples:

cluster.events.v1
cluster.events.*

role

doublecloud.kafka.v1.Permission.AccessRole
Access role to be granted to the user.

User

Field	Description
`name`	string Apache Kafka User's name. For a string spec see [UserSpec.name]
`cluster_id`	string Apache Kafka cluster ID the user belongs to.
`permissions`	list Set of permissions the user is granted with.
`permissions[]`	doublecloud.kafka.v1.Permission

UserSpec

Field	Description
`name`	string Apache Kafka User's name. Value must be a non-empty string: up to 256 characters compliant with pattern: ^[a-zA-Z0-9_][a-zA-Z0-9_-]*$ with values blocklisted: default with prefixes blocklisted: mdb_
`password`	string Apache Kafka User's password Value must be a non-empty string: with characters forbidden: '[]
`permissions`	list Set of permissions granted to the user.
`permissions[]`	doublecloud.kafka.v1.Permission

CreateUserRequest

Field	Description
`cluster_id`	string Required. ID of the Apache Kafka cluster to create a user in. To get the cluster ID, use a [ClusterService.List] request.
`user_spec`	doublecloud.kafka.v1.UserSpec User creation payload. See [UserSpec] for details

DeleteUserRequest

Field	Description
`cluster_id`	string Required. ID of the Apache Kafka cluster the user belongs to. To get the cluster ID, use a [ClusterService.List] request.
`user_name`	string Required. Name of the user to delete. To get the name of the user, use a [UserService.List] request.

GetUserRequest

Field	Description
`cluster_id`	string Required. ID of the Apache Kafka cluster the user belongs to. To get the cluster ID, use a [ClusterService.List] request.
`user_name`	string Required. Name of the Apache Kafka User resource to return. To get the name of the user, use a [UserService.List] request.

GrantUserPermissionRequest

Field	Description
`cluster_id`	string Required. ID of the Apache Kafka cluster the user belongs to. To get the cluster ID, use a [ClusterService.List] request.
`user_name`	string Required. Name of the user to grant the permission to. To get the name of the user, use a [UserService.List] request.
`permission`	doublecloud.kafka.v1.Permission Required. Permission that should be granted to the specified user.

ListUsersRequest

Field

Description

cluster_id

string
Required. ID of the cluster to list Apache Kafka users in.
To get the cluster ID, use 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

ListUsersResponse

Field	Description
`users`	list List of Apache Kafka User resources.
`users[]`	doublecloud.kafka.v1.User
`next_page`	doublecloud.v1.NextPage Pagination information of the response See [doublecloud.priv.v1.NextPage] for details

RevokeUserPermissionRequest

Field	Description
`cluster_id`	string Required. ID of the Apache Kafka cluster the user belongs to. To get the cluster ID, use a [ClusterService.List] request.
`user_name`	string Required. Name of the user to revoke a permission from. To get the name of the user, use a [UserService.List] request.
`permission`	doublecloud.kafka.v1.Permission Required. Permission that should be revoked from the specified user.

UpdateUserRequest

Field	Description
`cluster_id`	string Required. ID of the Apache Kafka cluster the user belongs to. To get the cluster ID use a [ClusterService.List] request.
`user_name`	string Required. Name of the user to be updated. To get the name of the user use a [UserService.List] request.
`update_spec`	doublecloud.kafka.v1.UpdateUserRequest.UpdateSpec Defines which exact attributes to be updated.

UpdateUserRequest.UpdateSpec

Field	Description
`password`	google.protobuf.StringValue When provided, Apache Kafka User's password will be updated. Empty string is ignored and considered as non-set password value. Regular password constraints applied, see [UserSpec.password] for details.
`permissions`	doublecloud.kafka.v1.UpdateUserRequest.UpdateSpec.UpdatePermissions When provided, current Apache Kafka User's permissions will be replaced. See [UpdatePermissions.permissions] for details.

UpdateUserRequest.UpdateSpec.UpdatePermissions

Field	Description
`permissions`	list New set of permissions for the user. Empty slice will remove all existing the permissions.
`permissions[]`	doublecloud.kafka.v1.Permission

Version

Field	Description
`id`	string ID of the version.
`name`	string Name of the version.
`deprecated`	bool Whether version is deprecated.
`updatable_to`	list List of versions that can be updated from current.
`updatable_to[]`	string

ListVersionsRequest

Field	Description
`paging`	doublecloud.v1.Paging Paging information of the request

ListVersionsResponse

Field	Description
`versions`	list Requested list of available versions.
`versions[]`	doublecloud.kafka.v1.Version
`next_page`	doublecloud.v1.NextPage Pagination information of the response