File: managedkafka_v1.projects.locations.schemaRegistries.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 (234 lines) | stat: -rw-r--r-- 8,803 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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
<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></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="managedkafka_v1.projects.locations.schemaRegistries.compatibility.html">compatibility()</a></code>
</p>
<p class="firstline">Returns the compatibility Resource.</p>

<p class="toc_element">
  <code><a href="managedkafka_v1.projects.locations.schemaRegistries.config.html">config()</a></code>
</p>
<p class="firstline">Returns the config Resource.</p>

<p class="toc_element">
  <code><a href="managedkafka_v1.projects.locations.schemaRegistries.contexts.html">contexts()</a></code>
</p>
<p class="firstline">Returns the contexts Resource.</p>

<p class="toc_element">
  <code><a href="managedkafka_v1.projects.locations.schemaRegistries.mode.html">mode()</a></code>
</p>
<p class="firstline">Returns the mode Resource.</p>

<p class="toc_element">
  <code><a href="managedkafka_v1.projects.locations.schemaRegistries.schemas.html">schemas()</a></code>
</p>
<p class="firstline">Returns the schemas Resource.</p>

<p class="toc_element">
  <code><a href="managedkafka_v1.projects.locations.schemaRegistries.subjects.html">subjects()</a></code>
</p>
<p class="firstline">Returns the subjects Resource.</p>

<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a schema registry instance.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Delete a schema registry instance.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get the schema registry instance.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">List schema registries.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Create a schema registry instance.

Args:
  parent: string, Required. The parent whose schema registry instance is to be created. Structured like: `projects/{project}/locations/{location}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request to create a schema registry instance.
  &quot;schemaRegistry&quot;: { # SchemaRegistry is a schema registry instance. # Required. The schema registry instance to create. The name field is ignored.
    &quot;contexts&quot;: [ # Output only. The contexts of the schema registry instance.
      &quot;A String&quot;,
    ],
    &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the schema registry instance. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}` The instance name {schema_registry} can contain the following: * Up to 255 characters. * Letters (uppercase or lowercase), numbers, and underscores.
  },
  &quot;schemaRegistryId&quot;: &quot;A String&quot;, # Required. The schema registry instance ID to use for this schema registry. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (-). The maximum length is 63 characters. The ID must not start with a number.
}

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

Returns:
  An object of the form:

    { # SchemaRegistry is a schema registry instance.
  &quot;contexts&quot;: [ # Output only. The contexts of the schema registry instance.
    &quot;A String&quot;,
  ],
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the schema registry instance. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}` The instance name {schema_registry} can contain the following: * Up to 255 characters. * Letters (uppercase or lowercase), numbers, and underscores.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Delete a schema registry instance.

Args:
  name: string, Required. The name of the schema registry instance to delete. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Get the schema registry instance.

Args:
  name: string, Required. The name of the schema registry instance to return. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # SchemaRegistry is a schema registry instance.
  &quot;contexts&quot;: [ # Output only. The contexts of the schema registry instance.
    &quot;A String&quot;,
  ],
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the schema registry instance. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}` The instance name {schema_registry} can contain the following: * Up to 255 characters. * Letters (uppercase or lowercase), numbers, and underscores.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, view=None, x__xgafv=None)</code>
  <pre>List schema registries.

Args:
  parent: string, Required. The parent whose schema registry instances are to be listed. Structured like: `projects/{project}/locations/{location}` (required)
  view: string, Optional. Specifies the view to return for the schema registry instances. If not specified, the default view is SCHEMA_REGISTRY_VIEW_BASIC.
    Allowed values
      SCHEMA_REGISTRY_VIEW_UNSPECIFIED - The unset value. The API will default to SCHEMA_REGISTRY_VIEW_BASIC.
      SCHEMA_REGISTRY_VIEW_BASIC - If SchemaRegistryView is not specified, this is the default value. Returns only the name of the schema registry. The contexts associated with it are not included.
      SCHEMA_REGISTRY_VIEW_FULL - Returns the name of the schema registry and all the contexts associated with it.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Request for ListSchemaRegistries.
  &quot;schemaRegistries&quot;: [ # The schema registry instances.
    { # SchemaRegistry is a schema registry instance.
      &quot;contexts&quot;: [ # Output only. The contexts of the schema registry instance.
        &quot;A String&quot;,
      ],
      &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the schema registry instance. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}` The instance name {schema_registry} can contain the following: * Up to 255 characters. * Letters (uppercase or lowercase), numbers, and underscores.
    },
  ],
}</pre>
</div>

</body></html>