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

    Interface WithSubject_nameItemRequestBuilder

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

    interface WithSubject_nameItemRequestBuilder {
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithSubject_nameGetResponse>;
        put(
            body: WithSubject_namePutRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithSubject_namePutResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPutRequestInformation(
            body: WithSubject_namePutRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithSubject_nameItemRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    get put toGetRequestInformation toPutRequestInformation withUrl

    Methods

    • To retrieve the Schema Registry configuration for a Subject of a Kafka cluster, send a GET request to/v2/databases/$DATABASE_ID/schema-registry/config/$SUBJECT_NAME.The response is a JSON object with a compatibility_level key, which is set to an objectcontaining any database configuration parameters.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithSubject_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 the Schema Registry configuration for a Subject of a Kafka cluster, send a PUT request to/v2/databases/$DATABASE_ID/schema-registry/config/$SUBJECT_NAME.The response is a JSON object with a compatibility_level key, which is set to an objectcontaining any database configuration parameters.

      Parameters

      • body: WithSubject_namePutRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithSubject_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 retrieve the Schema Registry configuration for a Subject of a Kafka cluster, send a GET request to/v2/databases/$DATABASE_ID/schema-registry/config/$SUBJECT_NAME.The response is a JSON object with a compatibility_level key, which is set to an objectcontaining any database configuration parameters.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To update the Schema Registry configuration for a Subject of a Kafka cluster, send a PUT request to/v2/databases/$DATABASE_ID/schema-registry/config/$SUBJECT_NAME.The response is a JSON object with a compatibility_level key, which is set to an objectcontaining any database configuration parameters.

      Parameters

      • body: WithSubject_namePutRequestBody

        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