2025-05-15
▼ ▲ managedkafka.projects.locations.schemaRegistries.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the schema registry instance to return. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get the schema registry instance.
▼ ▲ managedkafka.projects.locations.schemaRegistries.list
Path : v1/{+parent}/schemaRegistries
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries
HTTP Method : GET
Parameters :
parent
Description : Required. The parent whose schema registry instances are to be listed. Structured like: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List schema registries.
▼ ▲ managedkafka.projects.locations.schemaRegistries.create
Path : v1/{+parent}/schemaRegistries
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries
HTTP Method : POST
Parameters :
parent
Description : Required. The parent whose schema registry instance is to be created. Structured like: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Create a schema registry instance.
▼ ▲ managedkafka.projects.locations.schemaRegistries.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the schema registry instance to delete. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete a schema registry instance.
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the context to return. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get the context.
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.list
Path : v1/{+parent}/contexts
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts
HTTP Method : GET
Parameters :
parent
Description : Required. The parent of the contexts. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List contexts for a schema registry.
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.schemas.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/schemas/{schemasId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the schema to return. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/schemas/.*$
Location : path
Required : Yes
Type : string
subject
Description : Optional. Used to limit the search for the schema ID to a specific subject, otherwise the schema ID will be searched for in all subjects in the given specified context.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get the schema for the given schema id.
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.schemas.getSchema
Path : v1/{+name}/schema
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/schemas/{schemasId}/schema
HTTP Method : GET
Parameters :
name
Description : Required. The name of the schema to return. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/schemas/.*$
Location : path
Required : Yes
Type : string
subject
Description : Optional. Used to limit the search for the schema ID to a specific subject, otherwise the schema ID will be searched for in all subjects in the given specified context.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get the schema string for the given schema id. The response will be the schema string.
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.schemas.versions.list
Path : v1/{+parent}/versions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/schemas/{schemasId}/versions
HTTP Method : GET
Parameters :
parent
Description : Required. The schema whose schema versions are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/schemas/ids/{schema}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/schemas/.*$
Location : path
Required : Yes
Type : string
subject
Description : Optional. The subject to filter the subjects by.
Location : query
Type : string
deleted
Description : Optional. If true, the response will include soft-deleted versions of the schema, even if the subject is soft-deleted. The default is false.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List the schema versions for the given schema id. The response will be an array of subject-version pairs as: [{"subject":"subject1", "version":1}, {"subject":"subject2", "version":2}].
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.schemas.types.list
Path : v1/{+parent}/schemas/types
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/schemas/types
HTTP Method : GET
Parameters :
parent
Description : Required. The parent schema registry whose schema types are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List the supported schema types. The response will be an array of schema types.
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.schemas.subjects.list
Path : v1/{+parent}/subjects
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/schemas/{schemasId}/subjects
HTTP Method : GET
Parameters :
parent
Description : Required. The schema resource whose associated subjects are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/schemas/ids/{schema}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/schemas/.*$
Location : path
Required : Yes
Type : string
subject
Description : Optional. The subject to filter the subjects by.
Location : query
Type : string
deleted
Description : Optional. If true, the response will include soft-deleted subjects. The default is false.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List subjects which reference a particular schema id. The response will be an array of subject names.
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.subjects.list
Path : v1/{+parent}/subjects
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects
HTTP Method : GET
Parameters :
parent
Description : Required. The parent schema registry/context whose subjects are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+$
Location : path
Required : Yes
Type : string
subjectPrefix
Description : Optional. The context to filter the subjects by, in the format of `:.{context}:`. If unset, all subjects in the registry are returned. Set to empty string or add as '?subjectPrefix=' at the end of this request to list subjects in the default context.
Location : query
Type : string
deleted
Description : Optional. If true, the response will include soft-deleted subjects. The default is false.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List subjects in the schema registry. The response will be an array of subject names.
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.subjects.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects/{subjectsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the subject to delete. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/subjects/[^/]+$
Location : path
Required : Yes
Type : string
permanent
Description : Optional. If true, the subject and all associated metadata including the schema ID will be deleted permanently. Otherwise, only the subject is soft-deleted. The default is false. Soft-deleted subjects can still be searched in ListSubjects API call with deleted=true query parameter. A soft-delete of a subject must be performed before a hard-delete.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete a subject. The response will be an array of versions of the deleted subject.
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.subjects.lookupVersion
Path : v1/{+parent}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects/{subjectsId}
HTTP Method : POST
Parameters :
parent
Description : Required. The subject to lookup the schema in. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/subjects/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lookup a schema under the specified subject.
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.subjects.versions.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects/{subjectsId}/versions/{versionsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the subject to return versions. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/subjects/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
deleted
Description : Optional. If true, no matter if the subject/version is soft-deleted or not, it returns the version details. If false, it returns NOT_FOUND error if the subject/version is soft-deleted. The default is false.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a versioned schema (schema with subject/version) of a subject.
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.subjects.versions.getSchema
Path : v1/{+name}/schema
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects/{subjectsId}/versions/{versionsId}/schema
HTTP Method : GET
Parameters :
name
Description : Required. The name of the subject to return versions. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/subjects/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
deleted
Description : Optional. If true, no matter if the subject/version is soft-deleted or not, it returns the version details. If false, it returns NOT_FOUND error if the subject/version is soft-deleted. The default is false.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get the schema string only for a version of a subject. The response will be the schema string.
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.subjects.versions.list
Path : v1/{+parent}/versions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects/{subjectsId}/versions
HTTP Method : GET
Parameters :
parent
Description : Required. The subject whose versions are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/subjects/[^/]+$
Location : path
Required : Yes
Type : string
deleted
Description : Optional. If true, the response will include soft-deleted versions of an active or soft-deleted subject. The default is false.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get all versions of a subject. The response will be an array of versions of the subject.
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.subjects.versions.create
Path : v1/{+parent}/versions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects/{subjectsId}/versions
HTTP Method : POST
Parameters :
parent
Description : Required. The subject to create the version for. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/subjects/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Register a new version under a given subject with the given schema.
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.subjects.versions.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects/{subjectsId}/versions/{versionsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the subject version to delete. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/subjects/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
permanent
Description : Optional. If true, both the version and the referenced schema ID will be permanently deleted. The default is false. If false, the version will be deleted but the schema ID will be retained. Soft-deleted versions can still be searched in ListVersions API call with deleted=true query parameter. A soft-delete of a version must be performed before a hard-delete.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete a version of a subject. The response will be the deleted version id.
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.subjects.versions.referencedby.list
Path : v1/{+parent}/referencedby
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/subjects/{subjectsId}/versions/{versionsId}/referencedby
HTTP Method : GET
Parameters :
parent
Description : Required. The version to list referenced by. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/subjects/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a list of IDs of schemas that reference the schema with the given subject and version.
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.compatibility.checkCompatibility
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/compatibility/{compatibilityId}
HTTP Method : POST
Parameters :
name
Description : 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.
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/compatibility/.*$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Check compatibility of a schema with all versions or a specific version of a subject.
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.config.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/config/{configId}
HTTP Method : GET
Parameters :
name
Description : 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.
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/config/.*$
Location : path
Required : Yes
Type : string
defaultToGlobal
Description : Optional. If true, the config will fall back to the config at the global level if no subject level config is found.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get schema config at global level or for a subject.
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.config.update
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/config/{configId}
HTTP Method : PUT
Parameters :
name
Description : 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.
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/config/.*$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update config at global level or for a subject. Creates a SchemaSubject-level SchemaConfig if it does not exist.
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.config.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/config/{configId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of subject to delete the config for. The format is * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config/{subject}
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/config/.*$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete schema config for a subject.
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.mode.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/mode/{modeId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the mode. The format is * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/mode/{subject}: mode for a schema registry, or * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/mode/{subject}: mode for a specific subject in a specific context
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/mode/.*$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get mode at global level or for a subject.
▼ ▲ managedkafka.projects.locations.schemaRegistries.contexts.mode.update
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/contexts/{contextsId}/mode/{modeId}
HTTP Method : PUT
Parameters :
name
Description : Required. The resource name of the mode. The format is * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/mode/{subject}: mode for a schema registry, or * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/mode/{subject}: mode for a specific subject in a specific context
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/contexts/[^/]+/mode/.*$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update mode at global level or for a subject.
▼ ▲ managedkafka.projects.locations.schemaRegistries.schemas.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/schemas/{schemasId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the schema to return. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/schemas/.*$
Location : path
Required : Yes
Type : string
subject
Description : Optional. Used to limit the search for the schema ID to a specific subject, otherwise the schema ID will be searched for in all subjects in the given specified context.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get the schema for the given schema id.
▼ ▲ managedkafka.projects.locations.schemaRegistries.schemas.getSchema
Path : v1/{+name}/schema
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/schemas/{schemasId}/schema
HTTP Method : GET
Parameters :
name
Description : Required. The name of the schema to return. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/schemas/.*$
Location : path
Required : Yes
Type : string
subject
Description : Optional. Used to limit the search for the schema ID to a specific subject, otherwise the schema ID will be searched for in all subjects in the given specified context.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get the schema string for the given schema id. The response will be the schema string.
▼ ▲ managedkafka.projects.locations.schemaRegistries.schemas.versions.list
Path : v1/{+parent}/versions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/schemas/{schemasId}/versions
HTTP Method : GET
Parameters :
parent
Description : Required. The schema whose schema versions are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/schemas/ids/{schema}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/schemas/.*$
Location : path
Required : Yes
Type : string
subject
Description : Optional. The subject to filter the subjects by.
Location : query
Type : string
deleted
Description : Optional. If true, the response will include soft-deleted versions of the schema, even if the subject is soft-deleted. The default is false.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List the schema versions for the given schema id. The response will be an array of subject-version pairs as: [{"subject":"subject1", "version":1}, {"subject":"subject2", "version":2}].
▼ ▲ managedkafka.projects.locations.schemaRegistries.schemas.types.list
Path : v1/{+parent}/schemas/types
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/schemas/types
HTTP Method : GET
Parameters :
parent
Description : Required. The parent schema registry whose schema types are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List the supported schema types. The response will be an array of schema types.
▼ ▲ managedkafka.projects.locations.schemaRegistries.schemas.subjects.list
Path : v1/{+parent}/subjects
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/schemas/{schemasId}/subjects
HTTP Method : GET
Parameters :
parent
Description : Required. The schema resource whose associated subjects are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/schemas/ids/{schema}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/schemas/.*$
Location : path
Required : Yes
Type : string
subject
Description : Optional. The subject to filter the subjects by.
Location : query
Type : string
deleted
Description : Optional. If true, the response will include soft-deleted subjects. The default is false.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List subjects which reference a particular schema id. The response will be an array of subject names.
▼ ▲ managedkafka.projects.locations.schemaRegistries.subjects.list
Path : v1/{+parent}/subjects
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects
HTTP Method : GET
Parameters :
parent
Description : Required. The parent schema registry/context whose subjects are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+$
Location : path
Required : Yes
Type : string
subjectPrefix
Description : Optional. The context to filter the subjects by, in the format of `:.{context}:`. If unset, all subjects in the registry are returned. Set to empty string or add as '?subjectPrefix=' at the end of this request to list subjects in the default context.
Location : query
Type : string
deleted
Description : Optional. If true, the response will include soft-deleted subjects. The default is false.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : List subjects in the schema registry. The response will be an array of subject names.
▼ ▲ managedkafka.projects.locations.schemaRegistries.subjects.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects/{subjectsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the subject to delete. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/subjects/[^/]+$
Location : path
Required : Yes
Type : string
permanent
Description : Optional. If true, the subject and all associated metadata including the schema ID will be deleted permanently. Otherwise, only the subject is soft-deleted. The default is false. Soft-deleted subjects can still be searched in ListSubjects API call with deleted=true query parameter. A soft-delete of a subject must be performed before a hard-delete.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete a subject. The response will be an array of versions of the deleted subject.
▼ ▲ managedkafka.projects.locations.schemaRegistries.subjects.lookupVersion
Path : v1/{+parent}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects/{subjectsId}
HTTP Method : POST
Parameters :
parent
Description : Required. The subject to lookup the schema in. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/subjects/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lookup a schema under the specified subject.
▼ ▲ managedkafka.projects.locations.schemaRegistries.subjects.versions.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects/{subjectsId}/versions/{versionsId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of the subject to return versions. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/subjects/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
deleted
Description : Optional. If true, no matter if the subject/version is soft-deleted or not, it returns the version details. If false, it returns NOT_FOUND error if the subject/version is soft-deleted. The default is false.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a versioned schema (schema with subject/version) of a subject.
▼ ▲ managedkafka.projects.locations.schemaRegistries.subjects.versions.getSchema
Path : v1/{+name}/schema
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects/{subjectsId}/versions/{versionsId}/schema
HTTP Method : GET
Parameters :
name
Description : Required. The name of the subject to return versions. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/subjects/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
deleted
Description : Optional. If true, no matter if the subject/version is soft-deleted or not, it returns the version details. If false, it returns NOT_FOUND error if the subject/version is soft-deleted. The default is false.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get the schema string only for a version of a subject. The response will be the schema string.
▼ ▲ managedkafka.projects.locations.schemaRegistries.subjects.versions.list
Path : v1/{+parent}/versions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects/{subjectsId}/versions
HTTP Method : GET
Parameters :
parent
Description : Required. The subject whose versions are to be listed. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/subjects/[^/]+$
Location : path
Required : Yes
Type : string
deleted
Description : Optional. If true, the response will include soft-deleted versions of an active or soft-deleted subject. The default is false.
Location : query
Type : boolean
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get all versions of a subject. The response will be an array of versions of the subject.
▼ ▲ managedkafka.projects.locations.schemaRegistries.subjects.versions.create
Path : v1/{+parent}/versions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects/{subjectsId}/versions
HTTP Method : POST
Parameters :
parent
Description : Required. The subject to create the version for. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/subjects/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Register a new version under a given subject with the given schema.
▼ ▲ managedkafka.projects.locations.schemaRegistries.subjects.versions.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects/{subjectsId}/versions/{versionsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the subject version to delete. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/subjects/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
permanent
Description : Optional. If true, both the version and the referenced schema ID will be permanently deleted. The default is false. If false, the version will be deleted but the schema ID will be retained. Soft-deleted versions can still be searched in ListVersions API call with deleted=true query parameter. A soft-delete of a version must be performed before a hard-delete.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete a version of a subject. The response will be the deleted version id.
▼ ▲ managedkafka.projects.locations.schemaRegistries.subjects.versions.referencedby.list
Path : v1/{+parent}/referencedby
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/subjects/{subjectsId}/versions/{versionsId}/referencedby
HTTP Method : GET
Parameters :
parent
Description : Required. The version to list referenced by. Structured like: `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version}` or `projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}`
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/subjects/[^/]+/versions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get a list of IDs of schemas that reference the schema with the given subject and version.
▼ ▲ managedkafka.projects.locations.schemaRegistries.compatibility.checkCompatibility
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/compatibility/{compatibilityId}
HTTP Method : POST
Parameters :
name
Description : 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.
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/compatibility/.*$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Check compatibility of a schema with all versions or a specific version of a subject.
▼ ▲ managedkafka.projects.locations.schemaRegistries.config.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/config/{configId}
HTTP Method : GET
Parameters :
name
Description : 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.
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/config/.*$
Location : path
Required : Yes
Type : string
defaultToGlobal
Description : Optional. If true, the config will fall back to the config at the global level if no subject level config is found.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get schema config at global level or for a subject.
▼ ▲ managedkafka.projects.locations.schemaRegistries.config.update
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/config/{configId}
HTTP Method : PUT
Parameters :
name
Description : 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.
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/config/.*$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update config at global level or for a subject. Creates a SchemaSubject-level SchemaConfig if it does not exist.
▼ ▲ managedkafka.projects.locations.schemaRegistries.config.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/config/{configId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of subject to delete the config for. The format is * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config/{subject}
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/config/.*$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete schema config for a subject.
▼ ▲ managedkafka.projects.locations.schemaRegistries.mode.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/mode/{modeId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the mode. The format is * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/mode/{subject}: mode for a schema registry, or * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/mode/{subject}: mode for a specific subject in a specific context
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/mode/.*$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get mode at global level or for a subject.
▼ ▲ managedkafka.projects.locations.schemaRegistries.mode.update
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/schemaRegistries/{schemaRegistriesId}/mode/{modeId}
HTTP Method : PUT
Parameters :
name
Description : Required. The resource name of the mode. The format is * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/mode/{subject}: mode for a schema registry, or * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/mode/{subject}: mode for a specific subject in a specific context
Pattern : ^projects/[^/]+/locations/[^/]+/schemaRegistries/[^/]+/mode/.*$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update mode at global level or for a subject.