Class CommandIntrospectionMetadata
- Namespace
- Cratis.Arc.Introspection
- Assembly
- Cratis.Arc.Core.dll
Contains metadata for an introspected command endpoint, including route information and associated documentation.
public record CommandIntrospectionMetadata : IEquatable<CommandIntrospectionMetadata>
- Inheritance
-
CommandIntrospectionMetadata
- Implements
- Inherited Members
- Extension Methods
Constructors
CommandIntrospectionMetadata(CommandIntrospectionMetadata)
protected CommandIntrospectionMetadata(CommandIntrospectionMetadata original)
Parameters
originalCommandIntrospectionMetadata
CommandIntrospectionMetadata(string, string, string, string, string, JsonNode)
Contains metadata for an introspected command endpoint, including route information and associated documentation.
public CommandIntrospectionMetadata(string Name, string Namespace, string Route, string Type, string DocumentationSummary, JsonNode PayloadSchema)
Parameters
NamestringThe unique name of the command.
NamespacestringThe full namespace of the command type.
RoutestringThe HTTP route path configured for this command.
TypestringThe fully qualified type name of the command.
DocumentationSummarystringThe XML documentation summary of the command type.
PayloadSchemaJsonNodeJSON schema for the command payload type.
Properties
DocumentationSummary
The XML documentation summary of the command type.
public string DocumentationSummary { get; init; }
Property Value
EqualityContract
protected virtual Type EqualityContract { get; }
Property Value
Name
The unique name of the command.
public string Name { get; init; }
Property Value
Namespace
The full namespace of the command type.
public string Namespace { get; init; }
Property Value
PayloadSchema
JSON schema for the command payload type.
public JsonNode PayloadSchema { get; init; }
Property Value
Route
The HTTP route path configured for this command.
public string Route { get; init; }
Property Value
Type
The fully qualified type name of the command.
public string Type { get; init; }
Property Value
Methods
Deconstruct(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 Type, out string DocumentationSummary, out JsonNode PayloadSchema)
Parameters
NamestringNamespacestringRoutestringTypestringDocumentationSummarystringPayloadSchemaJsonNode
Equals(CommandIntrospectionMetadata?)
public virtual bool Equals(CommandIntrospectionMetadata? 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 ==(CommandIntrospectionMetadata?, CommandIntrospectionMetadata?)
public static bool operator ==(CommandIntrospectionMetadata? left, CommandIntrospectionMetadata? right)
Parameters
Returns
operator !=(CommandIntrospectionMetadata?, CommandIntrospectionMetadata?)
public static bool operator !=(CommandIntrospectionMetadata? left, CommandIntrospectionMetadata? right)