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

original QueryIntrospectionMetadata

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

Name string

The unique name of the query.

Namespace string

The full namespace of the query type.

Route string

The HTTP route path configured for this query.

FullyQualifiedName string

The fully qualified type name of the query.

Type string

The type of the query.

DocumentationSummary string

The XML documentation summary of the query type.

ArgumentsSchema JsonNode

JSON 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

JsonNode

DocumentationSummary

The XML documentation summary of the query type.

public string DocumentationSummary { get; init; }

Property Value

string

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

FullyQualifiedName

The fully qualified type name of the query.

public string FullyQualifiedName { get; init; }

Property Value

string

Name

The unique name of the query.

public string Name { get; init; }

Property Value

string

Namespace

The full namespace of the query type.

public string Namespace { get; init; }

Property Value

string

Route

The HTTP route path configured for this query.

public string Route { get; init; }

Property Value

string

Type

The type of the query.

public string Type { get; init; }

Property Value

string

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

Name string
Namespace string
Route string
FullyQualifiedName string
Type string
DocumentationSummary string
ArgumentsSchema JsonNode

Equals(QueryIntrospectionMetadata?)

public virtual bool Equals(QueryIntrospectionMetadata? other)

Parameters

other QueryIntrospectionMetadata

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

Operators

operator ==(QueryIntrospectionMetadata?, QueryIntrospectionMetadata?)

public static bool operator ==(QueryIntrospectionMetadata? left, QueryIntrospectionMetadata? right)

Parameters

left QueryIntrospectionMetadata
right QueryIntrospectionMetadata

Returns

bool

operator !=(QueryIntrospectionMetadata?, QueryIntrospectionMetadata?)

public static bool operator !=(QueryIntrospectionMetadata? left, QueryIntrospectionMetadata? right)

Parameters

left QueryIntrospectionMetadata
right QueryIntrospectionMetadata

Returns

bool