Class ServiceUnavailableError

Namespace

Trellis

Assembly

Trellis.Results.dll

Represents a temporary service unavailability error. Use this when the service is temporarily unable to handle the request due to maintenance or overload. Maps to HTTP 503 Service Unavailable.

public sealed class ServiceUnavailableError : Error, IEquatable<Error>

Inheritance

object

Error

ServiceUnavailableError

Implements

IEquatable<Error>

Inherited Members

Error.Code

Error.Detail

Error.Instance

Error.Equals(Error)

Error.Equals(object)

Error.GetHashCode()

Error.ToString()

Error.Validation(string, string, string, string)

Error.Validation(ImmutableArray<ValidationError.FieldError>, string, string)

Error.Validation(ImmutableArray<ValidationError.FieldError>, string, string, string)

Error.BadRequest(string, string)

Error.Conflict(string, string)

Error.PreconditionFailed(string, string)

Error.PreconditionRequired(string, string)

Error.NotFound(string, string)

Error.Unauthorized(string, string)

Error.Forbidden(string, string)

Error.Unexpected(string, string)

Error.Domain(string, string)

Error.RateLimit(string, string)

Error.RateLimit(string, RetryAfterValue, string)

Error.ServiceUnavailable(string, string)

Error.BadRequest<TInstance>(string, TInstance)

Error.Conflict<TInstance>(string, TInstance)

Error.PreconditionFailed<TInstance>(string, TInstance)

Error.PreconditionRequired<TInstance>(string, TInstance)

Error.NotFound<TInstance>(string, TInstance)

Error.Unauthorized<TInstance>(string, TInstance)

Error.Forbidden<TInstance>(string, TInstance)

Error.Unexpected<TInstance>(string, TInstance)

Error.Domain<TInstance>(string, TInstance)

Error.RateLimit<TInstance>(string, TInstance)

Error.ServiceUnavailable<TInstance>(string, TInstance)

Error.Gone<TInstance>(string, TInstance)

Error.NotAcceptable<TInstance>(string, TInstance)

Error.UnsupportedMediaType<TInstance>(string, TInstance)

Error.ServiceUnavailable(string, RetryAfterValue, string)

Error.BadRequest(string, string, string)

Error.Conflict(string, string, string)

Error.PreconditionFailed(string, string, string)

Error.PreconditionRequired(string, string, string)

Error.NotFound(string, string, string)

Error.Unauthorized(string, string, string)

Error.Forbidden(string, string, string)

Error.Unexpected(string, string, string)

Error.Domain(string, string, string)

Error.RateLimit(string, string, string)

Error.ServiceUnavailable(string, string, string)

Error.Gone(string, string)

Error.Gone(string, string, string)

Error.MethodNotAllowed(string, IReadOnlyList<string>, string)

Error.MethodNotAllowed(string, IReadOnlyList<string>, string, string)

Error.NotAcceptable(string, string)

Error.NotAcceptable(string, string, string)

Error.UnsupportedMediaType(string, string)

Error.UnsupportedMediaType(string, string, string)

Error.ContentTooLarge(string, RetryAfterValue, string)

Error.ContentTooLarge(string, string, RetryAfterValue, string)

Error.RangeNotSatisfiable(string, long, string)

Error.RangeNotSatisfiable(string, long, string, string, string)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

CombineErrorExtensions.Combine(Error?, Error)

MaybeExtensions.AsMaybe<T>(T)

MaybeExtensions.ToResult<TValue>(TValue)

NullableExtensions.ToResult<T>(T?, Func<Error>)

NullableExtensions.ToResult<T>(T?, Error)

AggregateTestMutator.ClearMaybeField<TEntity, TValue>(TEntity, Expression<Func<TEntity, Maybe<TValue>>>)

AggregateTestMutator.SetMaybeField<TEntity, TValue>(TEntity, Expression<Func<TEntity, Maybe<TValue>>>, TValue?)

Examples

Error.ServiceUnavailable("Service is under maintenance. Please try again later")
Error.ServiceUnavailable("Database connection pool exhausted. Retry in 30 seconds")
Error.ServiceUnavailable("External payment gateway is temporarily unavailable")

Remarks

This indicates a temporary condition - the service is expected to be available again. Include retry-after information in the detail message when appropriate. For permanent unavailability or deprecated endpoints, consider using other error types.

Constructors

ServiceUnavailableError(string, string, string?)

Initializes a new instance of the ServiceUnavailableError class.

public ServiceUnavailableError(string detail, string code, string? instance = null)

Parameters

detail string

Description of why the service is unavailable.

code string

The error code identifying this type of service unavailable error.

instance string

Optional identifier for the unavailable service or resource.

ServiceUnavailableError(string, string, RetryAfterValue, string?)

Initializes a new instance of the ServiceUnavailableError class with retry-after metadata.

public ServiceUnavailableError(string detail, string code, RetryAfterValue retryAfter, string? instance = null)

Parameters

detail string

Description of why the service is unavailable.

code string

The error code identifying this type of service unavailable error.

retryAfter RetryAfterValue

The retry-after value indicating when the service may resume.

instance string

Optional identifier for the unavailable service or resource.

Properties

RetryAfter

Gets the optional retry-after value indicating when the service may resume. When present, Trellis response mappers emit the Retry-After header.

public RetryAfterValue? RetryAfter { get; }

Property Value

RetryAfterValue