...

Text file src/github.com/twmb/franz-go/generate/definitions/20_delete_topics

Documentation: github.com/twmb/franz-go/generate/definitions

     1// DeleteTopicsRequest deletes Kafka topics.
     2DeleteTopicsRequest => key 20, max version 6, flexible v4+, admin
     3  // Topics is an array of topics to delete.
     4  TopicNames: [string] // v0-v5
     5  // The name or topic ID of topics to delete.
     6  Topics: [=>] // v6+
     7    Topic: nullable-string
     8    TopicID: uuid
     9  TimeoutMillis
    10
    11// DeleteTopicsResponse is returned from a DeleteTopicsRequest.
    12// Version 3 added the TOPIC_DELETION_DISABLED error proposed in KIP-322
    13// and introduced in Kafka 2.1.0. Prior, the request timed out.
    14DeleteTopicsResponse =>
    15  ThrottleMillis(2) // v1+
    16  // Topics contains responses for each topic requested for deletion.
    17  Topics: [=>]
    18    // Topic is the topic requested for deletion.
    19    Topic: nullable-string-v6+
    20    // The topic ID requested for deletion.
    21    TopicID: uuid // v6+
    22    // ErrorCode is the error code returned for an individual topic in
    23    // deletion request.
    24    //
    25    // TOPIC_AUTHORIZATION_FAILED is returned if the client is not authorized
    26    // to delete a topic.
    27    //
    28    // UNKNOWN_TOPIC_OR_PARTITION is returned if the broker does not know of
    29    // the topic.
    30    //
    31    // NOT_CONTROLLER is returned if the request was not issued to a Kafka
    32    // controller.
    33    //
    34    // TOPIC_DELETION_DISABLED is returned for deletion requests version 3+
    35    // and brokers >= 2.1.0. INVALID_REQUEST is issued for request versions
    36    // 0-2 against brokers >= 2.1.0. Otherwise, the request hangs until it
    37    // times out.
    38    //
    39    // UNSUPPORTED_VERSION is returned when using topic IDs with a cluster
    40    // that is not yet Kafka v2.8+.
    41    //
    42    // UNKNOWN_TOPIC_ID is returned when using topic IDs to a Kafka cluster
    43    // v2.8+ and the topic ID is not found.
    44    ErrorCode: int16
    45    // ErrorMessage is a message for an error.
    46    ErrorMessage: nullable-string // v5+

View as plain text