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

    Interface SchemaRegistryRequestBuilder

    Builds and executes requests for operations under /v2/databases/{database_cluster_uuid}/schema-registry

    interface SchemaRegistryRequestBuilder {
        get config(): ConfigRequestBuilder;
        bySubject_name(subject_name: string): WithSubject_nameItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | SchemaRegistryGetResponse>;
        post(
            body: Database_kafka_schema_create,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | Kafka_schema_verbose>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPostRequestInformation(
            body: Database_kafka_schema_create,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): SchemaRegistryRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    config

    Methods

    bySubject_name get post toGetRequestInformation toPostRequestInformation withUrl

    Accessors

    Methods

    • To list all schemas for a Kafka cluster, send a GET request to/v2/databases/$DATABASE_ID/schema-registry.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | SchemaRegistryGetResponse>

      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: Database_kafka_schema_create,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | Kafka_schema_verbose>

      To create a Kafka schema for a database cluster, send a POST request to/v2/databases/$DATABASE_ID/schema-registry.

      Parameters

      • body: Database_kafka_schema_create

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | Kafka_schema_verbose>

      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 schemas for a Kafka cluster, send a GET request to/v2/databases/$DATABASE_ID/schema-registry.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To create a Kafka schema for a database cluster, send a POST request to/v2/databases/$DATABASE_ID/schema-registry.

      Parameters

      • body: Database_kafka_schema_create

        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

    Accessors
    Methods