Managed Service for Apache Kafka® API, gRPC: TopicService
A set of methods for managing Kafka topics.
Call | Description |
---|---|
Get | Returns the specified Kafka topic. |
List | Retrieves the list of Kafka topics in the specified cluster. |
Create | Creates a new Kafka topic in the specified cluster. |
Update | Updates the specified Kafka topic. |
Delete | Deletes the specified Kafka topic. |
Calls TopicService
Get
Returns the specified Kafka topic.
To get the list of available Kafka topics, make a List request.
rpc Get (GetTopicRequest) returns (Topic)
GetTopicRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Apache Kafka® cluster that the topic belongs to. To get the cluster ID, make a ClusterService.List request. The maximum string length in characters is 50. |
topic_name | string Required. Name of the Kafka topic resource to return. To get the name of the topic, make a TopicService.List request. The string length in characters must be 1-256. Value must match the regular expression [a-zA-Z0-9_-]* . |
Topic
Field | Description |
---|---|
name | string Name of the topic. |
cluster_id | string ID of an Apache Kafka® cluster that the topic belongs to. To get the Apache Kafka® cluster ID, make a ClusterService.List request. |
partitions | google.protobuf.Int64Value The number of the topic's partitions. |
replication_factor | google.protobuf.Int64Value Amount of data copies (replicas) for the topic in the cluster. |
topic_config | oneof: topic_config_2_8 or topic_config_3 User-defined settings for the topic. |
topic_config_2_8 | TopicConfig2_8 User-defined settings for the topic. |
topic_config_3 | TopicConfig3 User-defined settings for the topic. |
TopicConfig2_8
Field | Description |
---|---|
cleanup_policy | enum CleanupPolicy Retention policy to use on old log messages.
|
compression_type | enum CompressionType The compression type for a given topic.
|
delete_retention_ms | google.protobuf.Int64Value The amount of time in milliseconds to retain delete tombstone markers for log compacted topics. |
file_delete_delay_ms | google.protobuf.Int64Value The time to wait before deleting a file from the filesystem. |
flush_messages | google.protobuf.Int64Value The number of messages accumulated on a log partition before messages are flushed to disk. This setting overrides the cluster-level KafkaConfig2_8.log_flush_interval_messages setting on the topic level. |
flush_ms | google.protobuf.Int64Value The maximum time in milliseconds that a message in the topic is kept in memory before flushed to disk. This setting overrides the cluster-level KafkaConfig2_8.log_flush_interval_ms setting on the topic level. |
min_compaction_lag_ms | google.protobuf.Int64Value The minimum time in milliseconds a message will remain uncompacted in the log. |
retention_bytes | google.protobuf.Int64Value The maximum size a partition can grow to before Kafka will discard old log segments to free up space if the delete cleanup_policy is in effect. It is helpful if you need to control the size of log due to limited disk space. This setting overrides the cluster-level KafkaConfig2_8.log_retention_bytes setting on the topic level. |
retention_ms | google.protobuf.Int64Value The number of milliseconds to keep a log segment's file before deleting it. This setting overrides the cluster-level KafkaConfig2_8.log_retention_ms setting on the topic level. |
max_message_bytes | google.protobuf.Int64Value The largest record batch size allowed in topic. |
min_insync_replicas | google.protobuf.Int64Value This configuration specifies the minimum number of replicas that must acknowledge a write to topic for the write to be considered successful (when a producer sets acks to "all"). |
segment_bytes | google.protobuf.Int64Value This configuration controls the segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention. This setting overrides the cluster-level KafkaConfig2_8.log_segment_bytes setting on the topic level. |
preallocate | google.protobuf.BoolValue True if we should preallocate the file on disk when creating a new log segment. This setting overrides the cluster-level KafkaConfig2_8.log_preallocate setting on the topic level. |
TopicConfig3
Field | Description |
---|---|
cleanup_policy | enum CleanupPolicy Retention policy to use on old log messages.
|
compression_type | enum CompressionType The compression type for a given topic.
|
delete_retention_ms | google.protobuf.Int64Value The amount of time in milliseconds to retain delete tombstone markers for log compacted topics. |
file_delete_delay_ms | google.protobuf.Int64Value The time to wait before deleting a file from the filesystem. |
flush_messages | google.protobuf.Int64Value The number of messages accumulated on a log partition before messages are flushed to disk. This setting overrides the cluster-level KafkaConfig3.log_flush_interval_messages setting on the topic level. |
flush_ms | google.protobuf.Int64Value The maximum time in milliseconds that a message in the topic is kept in memory before flushed to disk. This setting overrides the cluster-level KafkaConfig3.log_flush_interval_ms setting on the topic level. |
min_compaction_lag_ms | google.protobuf.Int64Value The minimum time in milliseconds a message will remain uncompacted in the log. |
retention_bytes | google.protobuf.Int64Value The maximum size a partition can grow to before Kafka will discard old log segments to free up space if the delete cleanup_policy is in effect. It is helpful if you need to control the size of log due to limited disk space. This setting overrides the cluster-level KafkaConfig3.log_retention_bytes setting on the topic level. |
retention_ms | google.protobuf.Int64Value The number of milliseconds to keep a log segment's file before deleting it. This setting overrides the cluster-level KafkaConfig3.log_retention_ms setting on the topic level. |
max_message_bytes | google.protobuf.Int64Value The largest record batch size allowed in topic. |
min_insync_replicas | google.protobuf.Int64Value This configuration specifies the minimum number of replicas that must acknowledge a write to topic for the write to be considered successful (when a producer sets acks to "all"). |
segment_bytes | google.protobuf.Int64Value This configuration controls the segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention. This setting overrides the cluster-level KafkaConfig3.log_segment_bytes setting on the topic level. |
preallocate | google.protobuf.BoolValue True if we should preallocate the file on disk when creating a new log segment. This setting overrides the cluster-level KafkaConfig3.log_preallocate setting on the topic level. |
List
Retrieves the list of Kafka topics in the specified cluster.
rpc List (ListTopicsRequest) returns (ListTopicsResponse)
ListTopicsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Apache Kafka® cluster to list topics in. To get the cluster ID, make a ClusterService.List request. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListTopicsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListTopicsResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
ListTopicsResponse
Field | Description |
---|---|
topics[] | Topic List of Kafka topics. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListTopicsRequest.page_size, use the next_page_token as the value for the ListTopicsRequest.page_token parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
Topic
Field | Description |
---|---|
name | string Name of the topic. |
cluster_id | string ID of an Apache Kafka® cluster that the topic belongs to. To get the Apache Kafka® cluster ID, make a ClusterService.List request. |
partitions | google.protobuf.Int64Value The number of the topic's partitions. |
replication_factor | google.protobuf.Int64Value Amount of data copies (replicas) for the topic in the cluster. |
topic_config | oneof: topic_config_2_8 or topic_config_3 User-defined settings for the topic. |
topic_config_2_8 | TopicConfig2_8 User-defined settings for the topic. |
topic_config_3 | TopicConfig3 User-defined settings for the topic. |
TopicConfig2_8
Field | Description |
---|---|
cleanup_policy | enum CleanupPolicy Retention policy to use on old log messages.
|
compression_type | enum CompressionType The compression type for a given topic.
|
delete_retention_ms | google.protobuf.Int64Value The amount of time in milliseconds to retain delete tombstone markers for log compacted topics. |
file_delete_delay_ms | google.protobuf.Int64Value The time to wait before deleting a file from the filesystem. |
flush_messages | google.protobuf.Int64Value The number of messages accumulated on a log partition before messages are flushed to disk. This setting overrides the cluster-level KafkaConfig2_8.log_flush_interval_messages setting on the topic level. |
flush_ms | google.protobuf.Int64Value The maximum time in milliseconds that a message in the topic is kept in memory before flushed to disk. This setting overrides the cluster-level KafkaConfig2_8.log_flush_interval_ms setting on the topic level. |
min_compaction_lag_ms | google.protobuf.Int64Value The minimum time in milliseconds a message will remain uncompacted in the log. |
retention_bytes | google.protobuf.Int64Value The maximum size a partition can grow to before Kafka will discard old log segments to free up space if the delete cleanup_policy is in effect. It is helpful if you need to control the size of log due to limited disk space. This setting overrides the cluster-level KafkaConfig2_8.log_retention_bytes setting on the topic level. |
retention_ms | google.protobuf.Int64Value The number of milliseconds to keep a log segment's file before deleting it. This setting overrides the cluster-level KafkaConfig2_8.log_retention_ms setting on the topic level. |
max_message_bytes | google.protobuf.Int64Value The largest record batch size allowed in topic. |
min_insync_replicas | google.protobuf.Int64Value This configuration specifies the minimum number of replicas that must acknowledge a write to topic for the write to be considered successful (when a producer sets acks to "all"). |
segment_bytes | google.protobuf.Int64Value This configuration controls the segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention. This setting overrides the cluster-level KafkaConfig2_8.log_segment_bytes setting on the topic level. |
preallocate | google.protobuf.BoolValue True if we should preallocate the file on disk when creating a new log segment. This setting overrides the cluster-level KafkaConfig2_8.log_preallocate setting on the topic level. |
TopicConfig3
Field | Description |
---|---|
cleanup_policy | enum CleanupPolicy Retention policy to use on old log messages.
|
compression_type | enum CompressionType The compression type for a given topic.
|
delete_retention_ms | google.protobuf.Int64Value The amount of time in milliseconds to retain delete tombstone markers for log compacted topics. |
file_delete_delay_ms | google.protobuf.Int64Value The time to wait before deleting a file from the filesystem. |
flush_messages | google.protobuf.Int64Value The number of messages accumulated on a log partition before messages are flushed to disk. This setting overrides the cluster-level KafkaConfig3.log_flush_interval_messages setting on the topic level. |
flush_ms | google.protobuf.Int64Value The maximum time in milliseconds that a message in the topic is kept in memory before flushed to disk. This setting overrides the cluster-level KafkaConfig3.log_flush_interval_ms setting on the topic level. |
min_compaction_lag_ms | google.protobuf.Int64Value The minimum time in milliseconds a message will remain uncompacted in the log. |
retention_bytes | google.protobuf.Int64Value The maximum size a partition can grow to before Kafka will discard old log segments to free up space if the delete cleanup_policy is in effect. It is helpful if you need to control the size of log due to limited disk space. This setting overrides the cluster-level KafkaConfig3.log_retention_bytes setting on the topic level. |
retention_ms | google.protobuf.Int64Value The number of milliseconds to keep a log segment's file before deleting it. This setting overrides the cluster-level KafkaConfig3.log_retention_ms setting on the topic level. |
max_message_bytes | google.protobuf.Int64Value The largest record batch size allowed in topic. |
min_insync_replicas | google.protobuf.Int64Value This configuration specifies the minimum number of replicas that must acknowledge a write to topic for the write to be considered successful (when a producer sets acks to "all"). |
segment_bytes | google.protobuf.Int64Value This configuration controls the segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention. This setting overrides the cluster-level KafkaConfig3.log_segment_bytes setting on the topic level. |
preallocate | google.protobuf.BoolValue True if we should preallocate the file on disk when creating a new log segment. This setting overrides the cluster-level KafkaConfig3.log_preallocate setting on the topic level. |
Create
Creates a new Kafka topic in the specified cluster.
rpc Create (CreateTopicRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateTopicMetadata
Operation.response:Topic
CreateTopicRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Apache Kafka® cluster to create a topic in. To get the cluster ID, make a ClusterService.List request. The maximum string length in characters is 50. |
topic_spec | TopicSpec Required. Configuration of the topic to create. |
TopicSpec
Field | Description |
---|---|
name | string Name of the topic. |
partitions | google.protobuf.Int64Value The number of the topic's partitions. |
replication_factor | google.protobuf.Int64Value Amount of copies of a topic data kept in the cluster. |
topic_config | oneof: topic_config_2_8 or topic_config_3 User-defined settings for the topic. |
topic_config_2_8 | TopicConfig2_8 User-defined settings for the topic. |
topic_config_3 | TopicConfig3 User-defined settings for the topic. |
TopicConfig2_8
Field | Description |
---|---|
cleanup_policy | enum CleanupPolicy Retention policy to use on old log messages.
|
compression_type | enum CompressionType The compression type for a given topic.
|
delete_retention_ms | google.protobuf.Int64Value The amount of time in milliseconds to retain delete tombstone markers for log compacted topics. |
file_delete_delay_ms | google.protobuf.Int64Value The time to wait before deleting a file from the filesystem. |
flush_messages | google.protobuf.Int64Value The number of messages accumulated on a log partition before messages are flushed to disk. This setting overrides the cluster-level KafkaConfig2_8.log_flush_interval_messages setting on the topic level. |
flush_ms | google.protobuf.Int64Value The maximum time in milliseconds that a message in the topic is kept in memory before flushed to disk. This setting overrides the cluster-level KafkaConfig2_8.log_flush_interval_ms setting on the topic level. |
min_compaction_lag_ms | google.protobuf.Int64Value The minimum time in milliseconds a message will remain uncompacted in the log. |
retention_bytes | google.protobuf.Int64Value The maximum size a partition can grow to before Kafka will discard old log segments to free up space if the delete cleanup_policy is in effect. It is helpful if you need to control the size of log due to limited disk space. This setting overrides the cluster-level KafkaConfig2_8.log_retention_bytes setting on the topic level. |
retention_ms | google.protobuf.Int64Value The number of milliseconds to keep a log segment's file before deleting it. This setting overrides the cluster-level KafkaConfig2_8.log_retention_ms setting on the topic level. |
max_message_bytes | google.protobuf.Int64Value The largest record batch size allowed in topic. |
min_insync_replicas | google.protobuf.Int64Value This configuration specifies the minimum number of replicas that must acknowledge a write to topic for the write to be considered successful (when a producer sets acks to "all"). |
segment_bytes | google.protobuf.Int64Value This configuration controls the segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention. This setting overrides the cluster-level KafkaConfig2_8.log_segment_bytes setting on the topic level. |
preallocate | google.protobuf.BoolValue True if we should preallocate the file on disk when creating a new log segment. This setting overrides the cluster-level KafkaConfig2_8.log_preallocate setting on the topic level. |
TopicConfig3
Field | Description |
---|---|
cleanup_policy | enum CleanupPolicy Retention policy to use on old log messages.
|
compression_type | enum CompressionType The compression type for a given topic.
|
delete_retention_ms | google.protobuf.Int64Value The amount of time in milliseconds to retain delete tombstone markers for log compacted topics. |
file_delete_delay_ms | google.protobuf.Int64Value The time to wait before deleting a file from the filesystem. |
flush_messages | google.protobuf.Int64Value The number of messages accumulated on a log partition before messages are flushed to disk. This setting overrides the cluster-level KafkaConfig3.log_flush_interval_messages setting on the topic level. |
flush_ms | google.protobuf.Int64Value The maximum time in milliseconds that a message in the topic is kept in memory before flushed to disk. This setting overrides the cluster-level KafkaConfig3.log_flush_interval_ms setting on the topic level. |
min_compaction_lag_ms | google.protobuf.Int64Value The minimum time in milliseconds a message will remain uncompacted in the log. |
retention_bytes | google.protobuf.Int64Value The maximum size a partition can grow to before Kafka will discard old log segments to free up space if the delete cleanup_policy is in effect. It is helpful if you need to control the size of log due to limited disk space. This setting overrides the cluster-level KafkaConfig3.log_retention_bytes setting on the topic level. |
retention_ms | google.protobuf.Int64Value The number of milliseconds to keep a log segment's file before deleting it. This setting overrides the cluster-level KafkaConfig3.log_retention_ms setting on the topic level. |
max_message_bytes | google.protobuf.Int64Value The largest record batch size allowed in topic. |
min_insync_replicas | google.protobuf.Int64Value This configuration specifies the minimum number of replicas that must acknowledge a write to topic for the write to be considered successful (when a producer sets acks to "all"). |
segment_bytes | google.protobuf.Int64Value This configuration controls the segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention. This setting overrides the cluster-level KafkaConfig3.log_segment_bytes setting on the topic level. |
preallocate | google.protobuf.BoolValue True if we should preallocate the file on disk when creating a new log segment. This setting overrides the cluster-level KafkaConfig3.log_preallocate setting on the topic level. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreateTopicMetadata
Field | Description |
---|---|
cluster_id | string ID of the Apache Kafka® cluster where a topic is being created. |
topic_name | string Required. Name of the Kafka topic that is being created. The maximum string length in characters is 256. Value must match the regular expression [a-zA-Z0-9_-]* . |
Topic
Field | Description |
---|---|
name | string Name of the topic. |
cluster_id | string ID of an Apache Kafka® cluster that the topic belongs to. To get the Apache Kafka® cluster ID, make a ClusterService.List request. |
partitions | google.protobuf.Int64Value The number of the topic's partitions. |
replication_factor | google.protobuf.Int64Value Amount of data copies (replicas) for the topic in the cluster. |
topic_config | oneof: topic_config_2_8 or topic_config_3 User-defined settings for the topic. |
topic_config_2_8 | TopicConfig2_8 User-defined settings for the topic. |
topic_config_3 | TopicConfig3 User-defined settings for the topic. |
Update
Updates the specified Kafka topic.
rpc Update (UpdateTopicRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateTopicMetadata
Operation.response:Topic
UpdateTopicRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Apache Kafka® cluster to update a topic in. To get the cluster ID, make a ClusterService.List request. The maximum string length in characters is 50. |
topic_name | string Required. Name of the topic to update. To get the name of the topic, make a TopicService.List request. The string length in characters must be 1-256. Value must match the regular expression [a-zA-Z0-9_-]* . |
update_mask | google.protobuf.FieldMask |
topic_spec | TopicSpec New configuration of the topic. Use update_mask to prevent reverting all topic settings that are not listed in topic_spec to their default values. |
TopicSpec
Field | Description |
---|---|
name | string Name of the topic. |
partitions | google.protobuf.Int64Value The number of the topic's partitions. |
replication_factor | google.protobuf.Int64Value Amount of copies of a topic data kept in the cluster. |
topic_config | oneof: topic_config_2_8 or topic_config_3 User-defined settings for the topic. |
topic_config_2_8 | TopicConfig2_8 User-defined settings for the topic. |
topic_config_3 | TopicConfig3 User-defined settings for the topic. |
TopicConfig2_8
Field | Description |
---|---|
cleanup_policy | enum CleanupPolicy Retention policy to use on old log messages.
|
compression_type | enum CompressionType The compression type for a given topic.
|
delete_retention_ms | google.protobuf.Int64Value The amount of time in milliseconds to retain delete tombstone markers for log compacted topics. |
file_delete_delay_ms | google.protobuf.Int64Value The time to wait before deleting a file from the filesystem. |
flush_messages | google.protobuf.Int64Value The number of messages accumulated on a log partition before messages are flushed to disk. This setting overrides the cluster-level KafkaConfig2_8.log_flush_interval_messages setting on the topic level. |
flush_ms | google.protobuf.Int64Value The maximum time in milliseconds that a message in the topic is kept in memory before flushed to disk. This setting overrides the cluster-level KafkaConfig2_8.log_flush_interval_ms setting on the topic level. |
min_compaction_lag_ms | google.protobuf.Int64Value The minimum time in milliseconds a message will remain uncompacted in the log. |
retention_bytes | google.protobuf.Int64Value The maximum size a partition can grow to before Kafka will discard old log segments to free up space if the delete cleanup_policy is in effect. It is helpful if you need to control the size of log due to limited disk space. This setting overrides the cluster-level KafkaConfig2_8.log_retention_bytes setting on the topic level. |
retention_ms | google.protobuf.Int64Value The number of milliseconds to keep a log segment's file before deleting it. This setting overrides the cluster-level KafkaConfig2_8.log_retention_ms setting on the topic level. |
max_message_bytes | google.protobuf.Int64Value The largest record batch size allowed in topic. |
min_insync_replicas | google.protobuf.Int64Value This configuration specifies the minimum number of replicas that must acknowledge a write to topic for the write to be considered successful (when a producer sets acks to "all"). |
segment_bytes | google.protobuf.Int64Value This configuration controls the segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention. This setting overrides the cluster-level KafkaConfig2_8.log_segment_bytes setting on the topic level. |
preallocate | google.protobuf.BoolValue True if we should preallocate the file on disk when creating a new log segment. This setting overrides the cluster-level KafkaConfig2_8.log_preallocate setting on the topic level. |
TopicConfig3
Field | Description |
---|---|
cleanup_policy | enum CleanupPolicy Retention policy to use on old log messages.
|
compression_type | enum CompressionType The compression type for a given topic.
|
delete_retention_ms | google.protobuf.Int64Value The amount of time in milliseconds to retain delete tombstone markers for log compacted topics. |
file_delete_delay_ms | google.protobuf.Int64Value The time to wait before deleting a file from the filesystem. |
flush_messages | google.protobuf.Int64Value The number of messages accumulated on a log partition before messages are flushed to disk. This setting overrides the cluster-level KafkaConfig3.log_flush_interval_messages setting on the topic level. |
flush_ms | google.protobuf.Int64Value The maximum time in milliseconds that a message in the topic is kept in memory before flushed to disk. This setting overrides the cluster-level KafkaConfig3.log_flush_interval_ms setting on the topic level. |
min_compaction_lag_ms | google.protobuf.Int64Value The minimum time in milliseconds a message will remain uncompacted in the log. |
retention_bytes | google.protobuf.Int64Value The maximum size a partition can grow to before Kafka will discard old log segments to free up space if the delete cleanup_policy is in effect. It is helpful if you need to control the size of log due to limited disk space. This setting overrides the cluster-level KafkaConfig3.log_retention_bytes setting on the topic level. |
retention_ms | google.protobuf.Int64Value The number of milliseconds to keep a log segment's file before deleting it. This setting overrides the cluster-level KafkaConfig3.log_retention_ms setting on the topic level. |
max_message_bytes | google.protobuf.Int64Value The largest record batch size allowed in topic. |
min_insync_replicas | google.protobuf.Int64Value This configuration specifies the minimum number of replicas that must acknowledge a write to topic for the write to be considered successful (when a producer sets acks to "all"). |
segment_bytes | google.protobuf.Int64Value This configuration controls the segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention. This setting overrides the cluster-level KafkaConfig3.log_segment_bytes setting on the topic level. |
preallocate | google.protobuf.BoolValue True if we should preallocate the file on disk when creating a new log segment. This setting overrides the cluster-level KafkaConfig3.log_preallocate setting on the topic level. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateTopicMetadata
Field | Description |
---|---|
cluster_id | string ID of the Apache Kafka® cluster where a topic is being updated. |
topic_name | string Name of the Kafka topic that is being updated. |
Topic
Field | Description |
---|---|
name | string Name of the topic. |
cluster_id | string ID of an Apache Kafka® cluster that the topic belongs to. To get the Apache Kafka® cluster ID, make a ClusterService.List request. |
partitions | google.protobuf.Int64Value The number of the topic's partitions. |
replication_factor | google.protobuf.Int64Value Amount of data copies (replicas) for the topic in the cluster. |
topic_config | oneof: topic_config_2_8 or topic_config_3 User-defined settings for the topic. |
topic_config_2_8 | TopicConfig2_8 User-defined settings for the topic. |
topic_config_3 | TopicConfig3 User-defined settings for the topic. |
Delete
Deletes the specified Kafka topic.
rpc Delete (DeleteTopicRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteTopicMetadata
Operation.response:google.protobuf.Empty
DeleteTopicRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Apache Kafka® cluster to delete a topic in. To get the cluster ID, make a ClusterService.List request. The maximum string length in characters is 50. |
topic_name | string Required. Name of the topic to delete. To get the name of the topic, make a TopicService.List request. The string length in characters must be 1-256. Value must match the regular expression [a-zA-Z0-9_-]* . |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteTopicMetadata
Field | Description |
---|---|
cluster_id | string ID of the Apache Kafka® cluster where a topic is being deleted. |
topic_name | string Name of the Kafka topic that is being deleted. |