Interface ISchemaLookupResult<S>
- Namespace
- Solace.SchemaRegistry.Serdes.Core.Resolver
- Assembly
- Solace.SchemaRegistry.Serdes.Core.dll
Represents the result of a schema lookup operation, containing both the parsed schema and the artifact reference information. This interface provides access to the resolved schema and its associated metadata for serialization and deserialization operations.
public interface ISchemaLookupResult<out S>Type Parameters
SThe type of the schema object contained in the lookup result
Remarks
ISchemaLookupResult is returned by schema resolution operations and contains all the information needed for subsequent serialization or deserialization operations. It combines the parsed schema with artifact reference metadata to provide complete context for schema-based operations.
The lookup result is typically used by serializers and deserializers to access the resolved schema and artifact information needed for data processing operations. The artifact reference provides metadata about the schema's identity and version within the schema registry.
Properties
Artifact
Gets the artifact reference that identifies the schema within the schema registry.
IArtifactReference Artifact { get; }Property Value
- IArtifactReference
An IArtifactReference instance that contains the metadata identifying the schema artifact, including its ID, version, and other registry-specific information.
Remarks
The artifact reference provides the identity and versioning information for the schema within the schema registry system. This information is essential for tracking schema versions, ensuring compatibility, and managing schema evolution over time.
The artifact reference is typically used by serializers to embed schema identification information in serialized data, allowing deserializers to resolve the correct schema version during deserialization operations.
ParsedSchema
Gets the parsed schema object that was resolved during the lookup operation.
IParsedSchema<out S> ParsedSchema { get; }Property Value
- IParsedSchema<S>
An IParsedSchema<S> instance containing the strongly-typed schema object and the original raw schema bytes. This schema is ready for use in serialization and deserialization operations.
Remarks
The parsed schema provides access to both the processed schema object for runtime operations and the raw schema bytes for scenarios where the original format is needed. The schema has been validated and is guaranteed to be in a usable state.
This schema corresponds to the artifact referenced by the Artifact property and represents the specific version and format that was resolved during the lookup.