File: managedkafka_v1.projects.locations.schemaRegistries.contexts.compatibility.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (127 lines) | stat: -rw-r--r-- 3,973 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="managedkafka_v1.html">Managed Service for Apache Kafka API</a> . <a href="managedkafka_v1.projects.html">projects</a> . <a href="managedkafka_v1.projects.locations.html">locations</a> . <a href="managedkafka_v1.projects.locations.schemaRegistries.html">schemaRegistries</a> . <a href="managedkafka_v1.projects.locations.schemaRegistries.contexts.html">contexts</a> . <a href="managedkafka_v1.projects.locations.schemaRegistries.contexts.compatibility.html">compatibility</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#checkCompatibility">checkCompatibility(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Check compatibility of a schema with all versions or a specific version of a subject.</p>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="checkCompatibility">checkCompatibility(name, body=None, x__xgafv=None)</code>
  <pre>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.
  &quot;references&quot;: [ # Optional. The schema references used by the schema.
    { # SchemaReference is a reference to a schema.
      &quot;name&quot;: &quot;A String&quot;, # Required. The name of the reference.
      &quot;subject&quot;: &quot;A String&quot;, # Required. The subject of the reference.
      &quot;version&quot;: 42, # Required. The version of the reference.
    },
  ],
  &quot;schema&quot;: &quot;A String&quot;, # Required. The schema payload
  &quot;schemaType&quot;: &quot;A String&quot;, # Optional. The schema type of the schema.
  &quot;verbose&quot;: 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.
  &quot;is_compatible&quot;: True or False, # The compatibility check result. If true, the schema is compatible with the resource.
  &quot;messages&quot;: [ # Failure reasons if verbose = true.
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

</body></html>