You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<pre>Check compatibility of a schema with all versions or a specific version of a subject.
87
+
88
+
Args:
89
+
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)
90
+
body: object, The request body.
91
+
The object takes the form of:
92
+
93
+
{ # Request for CheckCompatibility.
94
+
"references": [ # Optional. The schema references used by the schema.
95
+
{ # SchemaReference is a reference to a schema.
96
+
"name": "A String", # Required. The name of the reference.
97
+
"subject": "A String", # Required. The subject of the reference.
98
+
"version": 42, # Required. The version of the reference.
99
+
},
100
+
],
101
+
"schema": "A String", # Required. The schema payload
102
+
"schemaType": "A String", # Optional. The schema type of the schema.
103
+
"verbose": True or False, # Optional. If true, the response will contain the compatibility check result with reasons for failed checks. The default is false.
104
+
}
105
+
106
+
x__xgafv: string, V1 error format.
107
+
Allowed values
108
+
1 - v1 error format
109
+
2 - v2 error format
110
+
111
+
Returns:
112
+
An object of the form:
113
+
114
+
{ # Response for CheckCompatibility.
115
+
"is_compatible": True or False, # The compatibility check result. If true, the schema is compatible with the resource.
116
+
"messages": [ # Failure reasons if verbose = true.
name: string, Required. The resource name of subject to delete the config for. The format is * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config/{subject} (required)
101
+
x__xgafv: string, V1 error format.
102
+
Allowed values
103
+
1 - v1 error format
104
+
2 - v2 error format
105
+
106
+
Returns:
107
+
An object of the form:
108
+
109
+
{ # SchemaConfig represents configuration for a schema registry or a specific subject.
110
+
"alias": "A String", # Optional. The subject to which this subject is an alias of. Only applicable for subject config.
111
+
"compatibility": "A String", # Required. The compatibility type of the schema. The default value is BACKWARD. If unset in a SchemaSubject-level SchemaConfig, defaults to the global value. If unset in a SchemaRegistry-level SchemaConfig, reverts to the default value.
112
+
"normalize": True or False, # Optional. If true, the schema will be normalized before being stored or looked up. The default is false. If unset in a SchemaSubject-level SchemaConfig, the global value will be used. If unset in a SchemaRegistry-level SchemaConfig, reverts to the default value.
<pre>Get schema config at global level or for a subject.
119
+
120
+
Args:
121
+
name: string, Required. The resource name to get the config for. It can be either of following: * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config: Get config at global level. * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config/{subject}: Get config for a specific subject. (required)
122
+
defaultToGlobal: boolean, Optional. If true, the config will fall back to the config at the global level if no subject level config is found.
123
+
x__xgafv: string, V1 error format.
124
+
Allowed values
125
+
1 - v1 error format
126
+
2 - v2 error format
127
+
128
+
Returns:
129
+
An object of the form:
130
+
131
+
{ # SchemaConfig represents configuration for a schema registry or a specific subject.
132
+
"alias": "A String", # Optional. The subject to which this subject is an alias of. Only applicable for subject config.
133
+
"compatibility": "A String", # Required. The compatibility type of the schema. The default value is BACKWARD. If unset in a SchemaSubject-level SchemaConfig, defaults to the global value. If unset in a SchemaRegistry-level SchemaConfig, reverts to the default value.
134
+
"normalize": True or False, # Optional. If true, the schema will be normalized before being stored or looked up. The default is false. If unset in a SchemaSubject-level SchemaConfig, the global value will be used. If unset in a SchemaRegistry-level SchemaConfig, reverts to the default value.
<pre>Update config at global level or for a subject. Creates a SchemaSubject-level SchemaConfig if it does not exist.
141
+
142
+
Args:
143
+
name: string, Required. The resource name to update the config for. It can be either of following: * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config: Update config at global level. * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config/{subject}: Update config for a specific subject. (required)
144
+
body: object, The request body.
145
+
The object takes the form of:
146
+
147
+
{ # Request for updating schema config. On a SchemaSubject-level SchemaConfig, an unset field will be removed from the SchemaConfig.
148
+
"compatibility": "A String", # Required. The compatibility type of the schemas. Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the compatibility field for the SchemaConfig.
149
+
"normalize": True or False, # Optional. If true, the schema will be normalized before being stored or looked up. The default is false. Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the normalize field for the SchemaConfig.
150
+
}
151
+
152
+
x__xgafv: string, V1 error format.
153
+
Allowed values
154
+
1 - v1 error format
155
+
2 - v2 error format
156
+
157
+
Returns:
158
+
An object of the form:
159
+
160
+
{ # SchemaConfig represents configuration for a schema registry or a specific subject.
161
+
"alias": "A String", # Optional. The subject to which this subject is an alias of. Only applicable for subject config.
162
+
"compatibility": "A String", # Required. The compatibility type of the schema. The default value is BACKWARD. If unset in a SchemaSubject-level SchemaConfig, defaults to the global value. If unset in a SchemaRegistry-level SchemaConfig, reverts to the default value.
163
+
"normalize": True or False, # Optional. If true, the schema will be normalized before being stored or looked up. The default is false. If unset in a SchemaSubject-level SchemaConfig, the global value will be used. If unset in a SchemaRegistry-level SchemaConfig, reverts to the default value.
0 commit comments