Get
Returns the specified Apache Kafka Topic resource.
To get the list of available Apache Kafka Topic resources, make a [List]
request.
Request
|
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.
|
Response
|
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
|
List
Retrieves the list of Apache Kafka Topic resources in the specified cluster.
Request
|
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
|
Response
Create
Creates a new Apache Kafka topic in the specified cluster.
Request
|
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.
|
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 the specified Apache Kafka topic.
Request
|
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.
|
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 the specified Apache Kafka topic.
Request
|
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.
|
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.
|
