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

    Interface TopicsRequestBuilder

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

    interface TopicsRequestBuilder {
        byTopic_name(topic_name: string): WithTopic_nameItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | TopicsGetResponse>;
        post(
            body: Kafka_topic_create,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | TopicsPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPostRequestInformation(
            body: Kafka_topic_create,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): TopicsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byTopic_name get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • To list all of a Kafka cluster's topics, send a GET request to/v2/databases/$DATABASE_ID/topics.The result will be a JSON object with a topics key.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | TopicsGetResponse>

      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

    post

    • post(
          body: Kafka_topic_create,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | TopicsPostResponse>

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

      Parameters

      • body: Kafka_topic_create

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | TopicsPostResponse>

      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 list all of a Kafka cluster's topics, send a GET request to/v2/databases/$DATABASE_ID/topics.The result will be a JSON object with a topics key.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

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

      Parameters

      • body: Kafka_topic_create

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns TopicsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods