Kafka API models
- ClusterView
- Connector.Health
- Connector.Status
- TopicConfig28.CleanupPolicy
- TopicConfig28.CompressionType
- TopicConfig3.CleanupPolicy
- TopicConfig3.CompressionType
- Permission.AccessRole
- Cluster
- ClusterResources
- ClusterResources.Kafka
- ConnectionInfo
- Host
- MetricsExporterConnectionInfo
- PrivateConnectionInfo
- CreateClusterRequest
- DeleteClusterRequest
- GetClusterRequest
- ListClusterHostsRequest
- ListClusterHostsResponse
- ListClusterOperationsRequest
- ListClusterOperationsResponse
- ListClustersRequest
- ListClustersResponse
- RescheduleMaintenanceRequest
- ResetClusterCredentialsRequest
- StartClusterRequest
- StopClusterRequest
- UpdateClusterRequest
- KafkaConfig
- RestAPIConfig
- SchemaRegistryConfig
- ClusterConnection
- ClusterConnectionSpec
- Connector
- Connector.PropertiesEntry
- ConnectorConfigMirrorMaker
- ConnectorConfigMirrorMakerSpec
- ConnectorConfigS3Sink
- ConnectorConfigS3SinkSpec
- ConnectorSpec
- ConnectorSpec.PropertiesEntry
- ExternalClusterConnection
- ExternalClusterConnectionSpec
- S3Connection
- S3ConnectionSpec
- ThisCluster
- UpdateConnectorConfigMirrorMakerSpec
- UpdateConnectorConfigS3SinkSpec
- UpdateConnectorSpec
- UpdateConnectorSpec.UpdateProperties
- UpdateConnectorSpec.UpdateProperties.PropertiesEntry
- CreateConnectorMetadata
- CreateConnectorRequest
- DeleteConnectorMetadata
- DeleteConnectorRequest
- GetConnectorRequest
- ListConnectorsRequest
- ListConnectorsResponse
- PauseConnectorMetadata
- PauseConnectorRequest
- ResumeConnectorMetadata
- ResumeConnectorRequest
- UpdateConnectorMetadata
- UpdateConnectorRequest
- GetOperationRequest
- ListOperationsRequest
- ListOperationsResponse
- Topic
- TopicConfig28
- TopicConfig3
- TopicSpec
- CreateTopicRequest
- DeleteTopicRequest
- GetTopicRequest
- ListTopicsRequest
- ListTopicsResponse
- UpdateTopicRequest
- Permission
- User
- UserSpec
- CreateUserRequest
- DeleteUserRequest
- GetUserRequest
- GrantUserPermissionRequest
- ListUsersRequest
- ListUsersResponse
- RevokeUserPermissionRequest
- UpdateUserRequest
- UpdateUserRequest.UpdateSpec
- UpdateUserRequest.UpdateSpec.UpdatePermissions
- Version
- ListVersionsRequest
- ListVersionsResponse
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 |
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 |
|
string |
|
string |
|
string |
|
string |
|
google.protobuf.Timestamp |
|
string |
|
string |
|
doublecloud.v1.ClusterStatus |
|
string |
|
doublecloud.kafka.v1.ClusterResources |
|
doublecloud.kafka.v1.ConnectionInfo |
|
doublecloud.v1.Access |
|
doublecloud.v1.DataEncryption |
|
string |
|
doublecloud.kafka.v1.PrivateConnectionInfo |
|
doublecloud.v1.MaintenanceWindow |
|
doublecloud.v1.MaintenanceOperation |
|
doublecloud.kafka.v1.KafkaConfig |
|
doublecloud.kafka.v1.MetricsExporterConnectionInfo |
|
doublecloud.kafka.v1.SchemaRegistryConfig |
|
doublecloud.kafka.v1.RestAPIConfig |
ClusterResources
Field |
Description |
|
doublecloud.kafka.v1.ClusterResources.Kafka |
ClusterResources.Kafka
Field |
Description |
|
string |
|
google.protobuf.Int64Value |
|
google.protobuf.Int64Value |
|
google.protobuf.Int64Value |
ConnectionInfo
Field |
Description |
|
string |
|
string |
|
string |
Host
Field |
Description |
|
string |
|
string |
|
doublecloud.v1.HostStatus |
MetricsExporterConnectionInfo
Field |
Description |
|
string |
|
string |
PrivateConnectionInfo
Field |
Description |
|
string |
|
string |
|
string |
CreateClusterRequest
Field |
Description |
|
string |
|
string |
|
string |
|
string |
|
string |
|
string |
|
doublecloud.kafka.v1.ClusterResources |
|
doublecloud.v1.Access |
|
doublecloud.v1.DataEncryption |
|
string |
|
doublecloud.v1.MaintenanceWindow |
|
doublecloud.kafka.v1.KafkaConfig |
|
doublecloud.kafka.v1.SchemaRegistryConfig |
|
doublecloud.kafka.v1.RestAPIConfig |
DeleteClusterRequest
Field |
Description |
|
string |
GetClusterRequest
Field |
Description |
|
string |
|
bool |
ListClusterHostsRequest
Field |
Description |
|
string |
|
doublecloud.v1.Paging |
ListClusterHostsResponse
Field |
Description |
|
list |
|
|
|
doublecloud.v1.NextPage |
ListClusterOperationsRequest
Field |
Description |
|
string |
|
doublecloud.v1.Paging |
ListClusterOperationsResponse
Field |
Description |
|
list |
|
|
|
doublecloud.v1.NextPage |
ListClustersRequest
Field |
Description |
|
string |
|
doublecloud.v1.Paging |
|
doublecloud.kafka.v1.ClusterView |
ListClustersResponse
Field |
Description |
|
list |
|
|
|
doublecloud.v1.NextPage |
RescheduleMaintenanceRequest
Field |
Description |
|
string |
|
doublecloud.v1.RescheduleType |
|
google.protobuf.Timestamp |
ResetClusterCredentialsRequest
Field |
Description |
|
string |
StartClusterRequest
Field |
Description |
|
string |
StopClusterRequest
Field |
Description |
|
string |
UpdateClusterRequest
Field |
Description |
|
string |
|
string |
|
string |
|
string |
|
doublecloud.kafka.v1.ClusterResources |
|
doublecloud.v1.Access |
|
doublecloud.v1.MaintenanceWindow |
|
doublecloud.kafka.v1.KafkaConfig |
|
doublecloud.kafka.v1.SchemaRegistryConfig |
|
doublecloud.kafka.v1.RestAPIConfig |
KafkaConfig
Field |
Description |
|
google.protobuf.Int64Value |
|
google.protobuf.Int64Value |
RestAPIConfig
Field |
Description |
|
bool |
SchemaRegistryConfig
Field |
Description |
|
bool |
ClusterConnection
Field |
Description |
|
string |
|
one of: |
|
doublecloud.kafka.v1.ThisCluster |
|
doublecloud.kafka.v1.ExternalClusterConnection |
ClusterConnectionSpec
Field |
Description |
|
google.protobuf.StringValue |
|
one of: |
|
doublecloud.kafka.v1.ThisCluster |
|
doublecloud.kafka.v1.ExternalClusterConnectionSpec |
Connector
Field |
Description |
|
string |
|
google.protobuf.Int64Value |
|
list |
|
|
|
doublecloud.kafka.v1.Connector.Health |
|
doublecloud.kafka.v1.Connector.Status |
|
string |
|
one of: |
|
doublecloud.kafka.v1.ConnectorConfigMirrorMaker |
|
doublecloud.kafka.v1.ConnectorConfigS3Sink |
Connector.PropertiesEntry
Field |
Description |
|
string |
|
string |
ConnectorConfigMirrorMaker
Field |
Description |
|
doublecloud.kafka.v1.ClusterConnection |
|
doublecloud.kafka.v1.ClusterConnection |
|
string |
|
google.protobuf.Int64Value |
ConnectorConfigMirrorMakerSpec
Field |
Description |
|
doublecloud.kafka.v1.ClusterConnectionSpec |
|
doublecloud.kafka.v1.ClusterConnectionSpec |
|
string |
|
google.protobuf.Int64Value |
ConnectorConfigS3Sink
Field |
Description |
|
string |
|
string |
|
google.protobuf.Int64Value |
|
doublecloud.kafka.v1.S3Connection |
ConnectorConfigS3SinkSpec
Field |
Description |
|
string |
|
string |
|
google.protobuf.Int64Value |
|
doublecloud.kafka.v1.S3ConnectionSpec |
ConnectorSpec
Field |
Description |
|
string |
|
google.protobuf.Int64Value |
|
list |
|
|
|
one of: |
|
doublecloud.kafka.v1.ConnectorConfigMirrorMakerSpec |
|
doublecloud.kafka.v1.ConnectorConfigS3SinkSpec |
ConnectorSpec.PropertiesEntry
Field |
Description |
|
string |
|
string |
ExternalClusterConnection
Field |
Description |
|
string |
|
string |
|
string |
|
string |
ExternalClusterConnectionSpec
Field |
Description |
|
google.protobuf.StringValue |
|
google.protobuf.StringValue |
|
google.protobuf.StringValue |
|
google.protobuf.StringValue |
|
google.protobuf.StringValue |
|
google.protobuf.StringValue |
S3Connection
Field |
Description |
|
string |
|
string |
|
string |
|
string |
S3ConnectionSpec
Field |
Description |
|
google.protobuf.StringValue |
|
google.protobuf.StringValue |
|
google.protobuf.StringValue |
|
google.protobuf.StringValue |
|
google.protobuf.StringValue |
ThisCluster
Field |
Description |
UpdateConnectorConfigMirrorMakerSpec
Field |
Description |
|
doublecloud.kafka.v1.ClusterConnectionSpec |
|
doublecloud.kafka.v1.ClusterConnectionSpec |
|
google.protobuf.StringValue |
|
google.protobuf.Int64Value |
UpdateConnectorConfigS3SinkSpec
Field |
Description |
|
google.protobuf.StringValue |
|
google.protobuf.Int64Value |
|
doublecloud.kafka.v1.S3ConnectionSpec |
UpdateConnectorSpec
Field |
Description |
|
google.protobuf.Int64Value |
|
doublecloud.kafka.v1.UpdateConnectorSpec.UpdateProperties |
|
one of: |
|
doublecloud.kafka.v1.UpdateConnectorConfigMirrorMakerSpec |
|
doublecloud.kafka.v1.UpdateConnectorConfigS3SinkSpec |
UpdateConnectorSpec.UpdateProperties
Field |
Description |
|
list |
|
doublecloud.kafka.v1.UpdateConnectorSpec.UpdateProperties.PropertiesEntry |
UpdateConnectorSpec.UpdateProperties.PropertiesEntry
Field |
Description |
|
string |
|
string |
CreateConnectorMetadata
Field |
Description |
|
string |
|
string |
CreateConnectorRequest
Field |
Description |
|
string To get this ID, make a [ClusterService.List] request. |
|
doublecloud.kafka.v1.ConnectorSpec |
DeleteConnectorMetadata
Field |
Description |
|
string |
|
string |
DeleteConnectorRequest
Field |
Description |
|
string To get this ID, make a [ClusterService.List] request. |
|
string To get this name, make a [ConnectorService.List] request. |
GetConnectorRequest
Field |
Description |
|
string To get this ID, make a [ClusterService.List] request. |
|
string To get this name, make a [ConnectorService.List] request. |
ListConnectorsRequest
Field |
Description |
|
string To get this ID, make a [ClusterService.List] request. |
|
doublecloud.v1.Paging Following constraints applied:
|
ListConnectorsResponse
Field |
Description |
|
list |
|
|
|
doublecloud.v1.NextPage |
PauseConnectorMetadata
Field |
Description |
|
string |
|
string |
PauseConnectorRequest
Field |
Description |
|
string To get this ID, make a [ClusterService.List] request. |
|
string To get this name, make a [ConnectorService.List] request. |
ResumeConnectorMetadata
Field |
Description |
|
string |
|
string |
ResumeConnectorRequest
Field |
Description |
|
string To get this ID, make a [ClusterService.List] request. |
|
string To get this name, make a [ConnectorService.List] request. |
UpdateConnectorMetadata
Field |
Description |
|
string |
|
string |
UpdateConnectorRequest
Field |
Description |
|
string To get this ID, make a [ClusterService.List] request. |
|
string To get this name, make a [ConnectorService.List] request. |
|
doublecloud.kafka.v1.UpdateConnectorSpec |
GetOperationRequest
Field |
Description |
|
string |
ListOperationsRequest
Field |
Description |
|
string |
|
doublecloud.v1.Paging |
ListOperationsResponse
Field |
Description |
|
list |
|
|
|
doublecloud.v1.NextPage |
Topic
Field |
Description |
|
string |
|
string |
|
google.protobuf.Int64Value |
|
google.protobuf.Int64Value |
|
one of: |
|
|
|
|
|
bool |
TopicConfig28
Field |
Description |
|
doublecloud.kafka.v1.TopicConfig28.CleanupPolicy |
|
doublecloud.kafka.v1.TopicConfig28.CompressionType |
|
google.protobuf.Int64Value |
|
google.protobuf.Int64Value |
|
google.protobuf.Int64Value |
TopicConfig3
Field |
Description |
|
doublecloud.kafka.v1.TopicConfig3.CleanupPolicy |
|
doublecloud.kafka.v1.TopicConfig3.CompressionType |
|
google.protobuf.Int64Value |
|
google.protobuf.Int64Value |
|
google.protobuf.Int64Value |
TopicSpec
Field |
Description |
|
string |
|
google.protobuf.Int64Value |
|
google.protobuf.Int64Value |
|
one of: |
|
|
|
CreateTopicRequest
Field |
Description |
|
string |
|
doublecloud.kafka.v1.TopicSpec |
DeleteTopicRequest
Field |
Description |
|
string |
|
string |
GetTopicRequest
Field |
Description |
|
string |
|
string |
ListTopicsRequest
Field |
Description |
|
string |
|
doublecloud.v1.Paging |
ListTopicsResponse
Field |
Description |
|
list |
|
|
|
doublecloud.v1.NextPage |
UpdateTopicRequest
Field |
Description |
|
string |
|
string |
|
doublecloud.kafka.v1.TopicSpec |
Permission
Field |
Description |
|
string Examples:
|
|
doublecloud.kafka.v1.Permission.AccessRole |
User
Field |
Description |
|
string For a string spec see [UserSpec.name] |
|
string |
|
list |
|
UserSpec
Field |
Description |
|
string Value must be a non-empty string:
|
|
string Value must be a non-empty string:
|
|
list |
|
CreateUserRequest
Field |
Description |
|
string |
|
doublecloud.kafka.v1.UserSpec |
DeleteUserRequest
Field |
Description |
|
string |
|
string |
GetUserRequest
Field |
Description |
|
string |
|
string |
GrantUserPermissionRequest
Field |
Description |
|
string |
|
string |
|
doublecloud.kafka.v1.Permission |
ListUsersRequest
Field |
Description |
|
string |
|
doublecloud.v1.Paging Following constraints applied:
|
ListUsersResponse
Field |
Description |
|
list |
|
|
|
doublecloud.v1.NextPage |
RevokeUserPermissionRequest
Field |
Description |
|
string |
|
string |
|
doublecloud.kafka.v1.Permission |
UpdateUserRequest
Field |
Description |
|
string |
|
string |
|
doublecloud.kafka.v1.UpdateUserRequest.UpdateSpec |
UpdateUserRequest.UpdateSpec
Field |
Description |
|
google.protobuf.StringValue |
|
doublecloud.kafka.v1.UpdateUserRequest.UpdateSpec.UpdatePermissions |
UpdateUserRequest.UpdateSpec.UpdatePermissions
Field |
Description |
|
list |
|
Version
Field |
Description |
|
string |
|
string |
|
bool |
|
list |
|
string |
ListVersionsRequest
Field |
Description |
|
doublecloud.v1.Paging |
ListVersionsResponse
Field |
Description |
|
list |
|
|
|
doublecloud.v1.NextPage |