Managed Service for Apache Kafka API . projects . locations . schemaRegistries . contexts . compatibility

checkCompatibility(name, body=None, x__xgafv=None)

Check compatibility of a schema with all versions or a specific version of a subject.

Args:
  name: string, Required. The name of the resource to check compatibility for. The format is either of following: * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/compatibility/subjects/*/versions: Check compatibility with one or more versions of the specified subject. * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/compatibility/subjects/{subject}/versions/{version}: Check compatibility with a specific version of the subject. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for CheckCompatibility.
  "references": [ # Optional. The schema references used by the schema.
    { # SchemaReference is a reference to a schema.
      "name": "A String", # Required. The name of the reference.
      "subject": "A String", # Required. The subject of the reference.
      "version": 42, # Required. The version of the reference.
    },
  ],
  "schema": "A String", # Required. The schema payload
  "schemaType": "A String", # Optional. The schema type of the schema.
  "verbose": True or False, # Optional. If true, the response will contain the compatibility check result with reasons for failed checks. The default is false.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for CheckCompatibility.
  "is_compatible": True or False, # The compatibility check result. If true, the schema is compatible with the resource.
  "messages": [ # Failure reasons if verbose = true.
    "A String",
  ],
}

close()

Close httplib2 connections.