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

original CommandIntrospectionMetadata

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

Name string

The unique name of the command.

Namespace string

The full namespace of the command type.

Route string

The HTTP route path configured for this command.

Type string

The fully qualified type name of the command.

DocumentationSummary string

The XML documentation summary of the command type.

PayloadSchema JsonNode

JSON schema for the command payload type.

Properties

DocumentationSummary

The XML documentation summary of the command type.

public string DocumentationSummary { get; init; }

Property Value

string

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

Name

The unique name of the command.

public string Name { get; init; }

Property Value

string

Namespace

The full namespace of the command type.

public string Namespace { get; init; }

Property Value

string

PayloadSchema

JSON schema for the command payload type.

public JsonNode PayloadSchema { get; init; }

Property Value

JsonNode

Route

The HTTP route path configured for this command.

public string Route { get; init; }

Property Value

string

Type

The fully qualified type name of the command.

public string Type { get; init; }

Property Value

string

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

Name string
Namespace string
Route string
Type string
DocumentationSummary string
PayloadSchema JsonNode

Equals(CommandIntrospectionMetadata?)

public virtual bool Equals(CommandIntrospectionMetadata? other)

Parameters

other CommandIntrospectionMetadata

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 ==(CommandIntrospectionMetadata?, CommandIntrospectionMetadata?)

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

Parameters

left CommandIntrospectionMetadata
right CommandIntrospectionMetadata

Returns

bool

operator !=(CommandIntrospectionMetadata?, CommandIntrospectionMetadata?)

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

Parameters

left CommandIntrospectionMetadata
right CommandIntrospectionMetadata

Returns

bool