EndpointReference Properties
Class Properties 17 members
Represents an endpoint reference for a resource with endpoints.
The ID of the network that serves as the context for the EndpointReference. The reference will be resolved in the context of this network, which may be different from the network associated with the default network of the referenced Endpoint.
public NetworkIdentifier? ContextNetworkID { get; } Gets the endpoint annotation associated with the endpoint reference.
public EndpointAnnotation EndpointAnnotation { get; } Gets the name of the endpoint associated with the endpoint reference.
public string EndpointName { get; } Gets or sets a custom error message to be thrown when the endpoint annotation is not found.
public string? ErrorMessage { get; init; } Gets a value indicating whether this endpoint is excluded from the default set when referencing the resource's endpoints.
public bool ExcludeReferenceEndpoint { get; }Remarks
Returns
false if the endpoint annotation has not been added to the resource yet. Once the annotation exists, this property delegates to EndpointAnnotation.ExcludeReferenceEndpoint. Gets a value indicating whether the endpoint exists.
public bool Exists { get; } Gets a value indicating whether the endpoint is allocated.
public bool IsAllocated { get; } Gets a value indicating whether the endpoint uses HTTP scheme.
public bool IsHttp { get; } Gets a value indicating whether the endpoint uses HTTPS scheme.
public bool IsHttps { get; } Gets a value indicating whether the endpoint name is "http" or "https", ignoring case. This is a convention used to identify endpoints that will be resolved based on the scheme of the endpoint in service discovery rather than by the specific endpoint name. This is done to allow http endpoints that are dynamically updated to https to be mapped correctly despite the endpoint name no longer matching the scheme.
public bool IsHttpSchemeNamedEndpoint { get; } Gets the resource owner of the endpoint reference.
public IResourceWithEndpoints Resource { get; } Gets the scheme for this endpoint.
public string Scheme { get; } Gets the target port for this endpoint. If the port is dynamically allocated, this will return
null. public int? TargetPort { get; } Gets a value indicating whether TLS is enabled for this endpoint.
public bool TlsEnabled { get; }Remarks
Returns
false if the endpoint annotation has not been added to the resource yet. Once the annotation exists, this property delegates to EndpointAnnotation.TlsEnabled.