@digitalocean/dots - v1.0.1
    Preparing search index...

    Interface WithTopic_nameItemRequestBuilder

    Builds and executes requests for operations under /v2/databases/{database_cluster_uuid}/topics/{topic_name}

    interface WithTopic_nameItemRequestBuilder {
        delete(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<void>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithTopic_nameGetResponse>;
        put(
            body: Kafka_topic_update,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithTopic_namePutResponse>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPutRequestInformation(
            body: Kafka_topic_update,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithTopic_nameItemRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    delete get put toDeleteRequestInformation toGetRequestInformation toPutRequestInformation withUrl

    Methods

    • To delete a single topic within a Kafka cluster, send a DELETE requestto /v2/databases/$DATABASE_ID/topics/$TOPIC_NAME.A status of 204 will be given. This indicates that the request wasprocessed successfully, but that no response body is needed.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<void>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • To retrieve a given topic by name from the set of a Kafka cluster's topics,send a GET request to /v2/databases/$DATABASE_ID/topics/$TOPIC_NAME.The result will be a JSON object with a topic key.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | WithTopic_nameGetResponse>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • To update a topic attached to a Kafka cluster, send a PUT request to/v2/databases/$DATABASE_ID/topics/$TOPIC_NAME.The result will be a JSON object with a topic key.

      Parameters

      • body: Kafka_topic_update

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | WithTopic_namePutResponse>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • To delete a single topic within a Kafka cluster, send a DELETE requestto /v2/databases/$DATABASE_ID/topics/$TOPIC_NAME.A status of 204 will be given. This indicates that the request wasprocessed successfully, but that no response body is needed.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    • To retrieve a given topic by name from the set of a Kafka cluster's topics,send a GET request to /v2/databases/$DATABASE_ID/topics/$TOPIC_NAME.The result will be a JSON object with a topic key.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    • To update a topic attached to a Kafka cluster, send a PUT request to/v2/databases/$DATABASE_ID/topics/$TOPIC_NAME.The result will be a JSON object with a topic key.

      Parameters

      • body: Kafka_topic_update

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Methods