Update Schema Registry Configuration for a kafka Cluster

client.Databases.SchemaRegistry.Config.Update(ctx, databaseClusterUuid, body) (*DatabaseSchemaRegistryConfigUpdateResponse, error)

put/v2/databases/{database_cluster_uuid}/schema-registry/config

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

ParametersExpand Collapse

databaseClusterUuid string

formatuuid

body DatabaseSchemaRegistryConfigUpdateParams

CompatibilityLevel param.Field[DatabaseSchemaRegistryConfigUpdateParamsCompatibilityLevel]

The compatibility level of the schema registry.

const DatabaseSchemaRegistryConfigUpdateParamsCompatibilityLevelNone DatabaseSchemaRegistryConfigUpdateParamsCompatibilityLevel = "NONE"

const DatabaseSchemaRegistryConfigUpdateParamsCompatibilityLevelBackward DatabaseSchemaRegistryConfigUpdateParamsCompatibilityLevel = "BACKWARD"

const DatabaseSchemaRegistryConfigUpdateParamsCompatibilityLevelBackwardTransitive DatabaseSchemaRegistryConfigUpdateParamsCompatibilityLevel = "BACKWARD_TRANSITIVE"

const DatabaseSchemaRegistryConfigUpdateParamsCompatibilityLevelForward DatabaseSchemaRegistryConfigUpdateParamsCompatibilityLevel = "FORWARD"

const DatabaseSchemaRegistryConfigUpdateParamsCompatibilityLevelForwardTransitive DatabaseSchemaRegistryConfigUpdateParamsCompatibilityLevel = "FORWARD_TRANSITIVE"

const DatabaseSchemaRegistryConfigUpdateParamsCompatibilityLevelFull DatabaseSchemaRegistryConfigUpdateParamsCompatibilityLevel = "FULL"

const DatabaseSchemaRegistryConfigUpdateParamsCompatibilityLevelFullTransitive DatabaseSchemaRegistryConfigUpdateParamsCompatibilityLevel = "FULL_TRANSITIVE"

ReturnsExpand Collapse

type DatabaseSchemaRegistryConfigUpdateResponse struct{…}

CompatibilityLevel DatabaseSchemaRegistryConfigUpdateResponseCompatibilityLevel

The compatibility level of the schema registry.

Accepts one of the following:

const DatabaseSchemaRegistryConfigUpdateResponseCompatibilityLevelNone DatabaseSchemaRegistryConfigUpdateResponseCompatibilityLevel = "NONE"

const DatabaseSchemaRegistryConfigUpdateResponseCompatibilityLevelBackward DatabaseSchemaRegistryConfigUpdateResponseCompatibilityLevel = "BACKWARD"

const DatabaseSchemaRegistryConfigUpdateResponseCompatibilityLevelBackwardTransitive DatabaseSchemaRegistryConfigUpdateResponseCompatibilityLevel = "BACKWARD_TRANSITIVE"

const DatabaseSchemaRegistryConfigUpdateResponseCompatibilityLevelForward DatabaseSchemaRegistryConfigUpdateResponseCompatibilityLevel = "FORWARD"

const DatabaseSchemaRegistryConfigUpdateResponseCompatibilityLevelForwardTransitive DatabaseSchemaRegistryConfigUpdateResponseCompatibilityLevel = "FORWARD_TRANSITIVE"

const DatabaseSchemaRegistryConfigUpdateResponseCompatibilityLevelFull DatabaseSchemaRegistryConfigUpdateResponseCompatibilityLevel = "FULL"

const DatabaseSchemaRegistryConfigUpdateResponseCompatibilityLevelFullTransitive DatabaseSchemaRegistryConfigUpdateResponseCompatibilityLevel = "FULL_TRANSITIVE"

Update Schema Registry Configuration for a kafka Cluster

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  config, err := client.Databases.SchemaRegistry.Config.Update(
    context.TODO(),
    "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
    gradient.DatabaseSchemaRegistryConfigUpdateParams{
      CompatibilityLevel: gradient.F(gradient.DatabaseSchemaRegistryConfigUpdateParamsCompatibilityLevelBackward),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", config.CompatibilityLevel)
}

{
  "compatibility_level": "NONE"
}

Returns Examples

{
  "compatibility_level": "NONE"
}