Class QueryIntrospectionMetadata
- Namespace
- Cratis.Arc.Introspection
- Assembly
- Cratis.Arc.Core.dll
Contains metadata for an introspected query endpoint, including route information and associated documentation.
public record QueryIntrospectionMetadata : IEquatable<QueryIntrospectionMetadata>
- Inheritance
-
QueryIntrospectionMetadata
- Implements
- Inherited Members
- Extension Methods
Constructors
QueryIntrospectionMetadata(QueryIntrospectionMetadata)
protected QueryIntrospectionMetadata(QueryIntrospectionMetadata original)
Parameters
originalQueryIntrospectionMetadata
QueryIntrospectionMetadata(string, string, string, string, string, string, JsonNode)
Contains metadata for an introspected query endpoint, including route information and associated documentation.
public QueryIntrospectionMetadata(string Name, string Namespace, string Route, string FullyQualifiedName, string Type, string DocumentationSummary, JsonNode ArgumentsSchema)
Parameters
NamestringThe unique name of the query.
NamespacestringThe full namespace of the query type.
RoutestringThe HTTP route path configured for this query.
FullyQualifiedNamestringThe fully qualified type name of the query.
TypestringThe type of the query.
DocumentationSummarystringThe XML documentation summary of the query type.
ArgumentsSchemaJsonNodeJSON schema for query arguments, including required and optional fields.
Properties
ArgumentsSchema
JSON schema for query arguments, including required and optional fields.
public JsonNode ArgumentsSchema { get; init; }
Property Value
DocumentationSummary
The XML documentation summary of the query type.
public string DocumentationSummary { get; init; }
Property Value
EqualityContract
protected virtual Type EqualityContract { get; }
Property Value
FullyQualifiedName
The fully qualified type name of the query.
public string FullyQualifiedName { get; init; }
Property Value
Name
The unique name of the query.
public string Name { get; init; }
Property Value
Namespace
The full namespace of the query type.
public string Namespace { get; init; }
Property Value
Route
The HTTP route path configured for this query.
public string Route { get; init; }
Property Value
Type
The type of the query.
public string Type { get; init; }
Property Value
Methods
Deconstruct(out string, out string, out string, out string, out string, out string, out JsonNode)
public void Deconstruct(out string Name, out string Namespace, out string Route, out string FullyQualifiedName, out string Type, out string DocumentationSummary, out JsonNode ArgumentsSchema)
Parameters
NamestringNamespacestringRoutestringFullyQualifiedNamestringTypestringDocumentationSummarystringArgumentsSchemaJsonNode
Equals(QueryIntrospectionMetadata?)
public virtual bool Equals(QueryIntrospectionMetadata? other)
Parameters
Returns
Equals(object?)
public override bool Equals(object? obj)
Parameters
objobject
Returns
GetHashCode()
public override int GetHashCode()
Returns
PrintMembers(StringBuilder)
protected virtual bool PrintMembers(StringBuilder builder)
Parameters
builderStringBuilder
Returns
ToString()
public override string ToString()
Returns
Operators
operator ==(QueryIntrospectionMetadata?, QueryIntrospectionMetadata?)
public static bool operator ==(QueryIntrospectionMetadata? left, QueryIntrospectionMetadata? right)
Parameters
Returns
operator !=(QueryIntrospectionMetadata?, QueryIntrospectionMetadata?)
public static bool operator !=(QueryIntrospectionMetadata? left, QueryIntrospectionMetadata? right)