@nebius/js-sdk - v0.2.54
    Preparing search index...

    Interface ServiceError

    Deprecated: migrate to common/v1.

    interface ServiceError {
        "[customJson]"?: () => unknown;
        "[unknownFieldsSymbol]"?: Uint8Array<ArrayBufferLike>;
        $type: "nebius.common.error.v1alpha1.ServiceError";
        code: string;
        details?:
            | { $case: "badRequest"; badRequest: BadRequest }
            | { $case: "badResourceState"; badResourceState: BadResourceState }
            | { $case: "resourceNotFound"; resourceNotFound: ResourceNotFound }
            | {
                $case: "resourceAlreadyExists";
                resourceAlreadyExists: ResourceAlreadyExists;
            }
            | { $case: "outOfRange"; outOfRange: OutOfRange }
            | { $case: "permissionDenied"; permissionDenied: PermissionDenied }
            | { $case: "resourceConflict"; resourceConflict: ResourceConflict }
            | { $case: "operationAborted"; operationAborted: OperationAborted }
            | { $case: "tooManyRequests"; tooManyRequests: TooManyRequests }
            | { $case: "quotaFailure"; quotaFailure: QuotaFailure }
            | { $case: "internalError"; internalError: InternalError };
        retryType: ServiceError_RetryType;
        service: string;
        [key: symbol]: Uint8Array<ArrayBufferLike> | (() => unknown) | undefined;
    }

    Indexable

    • [key: symbol]: Uint8Array<ArrayBufferLike> | (() => unknown) | undefined
    Index
    [customJson]? [unknownFieldsSymbol]? $type code details? retryType service
    "[customJson]"?: () => unknown

    Returns a safe value for JSON logs.

    Type Declaration

      • (): unknown

      • Returns a safe value for JSON logs.

        Returns unknown

    "[unknownFieldsSymbol]"?: Uint8Array<ArrayBufferLike>

    Preserves protobuf fields that this SDK version does not recognize.

    $type: "nebius.common.error.v1alpha1.ServiceError"

    Contains the fully qualified protobuf type name.

    code: string

    Detailed error code, service-specific. E.g. "DnsZoneNotEmpty". Name of the exception, without Exception suffix if not set Example: for PermissionDeniedException -> code == PermissionDenied

    details?:
        | { $case: "badRequest"; badRequest: BadRequest }
        | { $case: "badResourceState"; badResourceState: BadResourceState }
        | { $case: "resourceNotFound"; resourceNotFound: ResourceNotFound }
        | {
            $case: "resourceAlreadyExists";
            resourceAlreadyExists: ResourceAlreadyExists;
        }
        | { $case: "outOfRange"; outOfRange: OutOfRange }
        | { $case: "permissionDenied"; permissionDenied: PermissionDenied }
        | { $case: "resourceConflict"; resourceConflict: ResourceConflict }
        | { $case: "operationAborted"; operationAborted: OperationAborted }
        | { $case: "tooManyRequests"; tooManyRequests: TooManyRequests }
        | { $case: "quotaFailure"; quotaFailure: QuotaFailure }
        | { $case: "internalError"; internalError: InternalError }

    Additional message describing the error, if any.

    Type Declaration

    • { $case: "badRequest"; badRequest: BadRequest }
      • $case: "badRequest"

        Contains the case.

      • badRequest: BadRequest

        Contains the bad request.

    • { $case: "badResourceState"; badResourceState: BadResourceState }
      • $case: "badResourceState"

        Contains the case.

      • badResourceState: BadResourceState

        Contains the bad resource state.

    • { $case: "resourceNotFound"; resourceNotFound: ResourceNotFound }
      • $case: "resourceNotFound"

        Contains the case.

      • resourceNotFound: ResourceNotFound

        Contains the resource not found.

    • { $case: "resourceAlreadyExists"; resourceAlreadyExists: ResourceAlreadyExists }
      • $case: "resourceAlreadyExists"

        Contains the case.

      • resourceAlreadyExists: ResourceAlreadyExists

        Contains the resource already exists.

    • { $case: "outOfRange"; outOfRange: OutOfRange }
      • $case: "outOfRange"

        Contains the case.

      • outOfRange: OutOfRange

        Contains the out of range.

    • { $case: "permissionDenied"; permissionDenied: PermissionDenied }
      • $case: "permissionDenied"

        Contains the case.

      • permissionDenied: PermissionDenied

        Contains the permission denied.

    • { $case: "resourceConflict"; resourceConflict: ResourceConflict }
      • $case: "resourceConflict"

        Contains the case.

      • resourceConflict: ResourceConflict

        Contains the resource conflict.

    • { $case: "operationAborted"; operationAborted: OperationAborted }
      • $case: "operationAborted"

        Contains the case.

      • operationAborted: OperationAborted

        Contains the operation aborted.

    • { $case: "tooManyRequests"; tooManyRequests: TooManyRequests }
      • $case: "tooManyRequests"

        Contains the case.

      • tooManyRequests: TooManyRequests

        Contains the too many requests.

    • { $case: "quotaFailure"; quotaFailure: QuotaFailure }
      • $case: "quotaFailure"

        Contains the case.

      • quotaFailure: QuotaFailure

        Contains the quota failure.

    • { $case: "internalError"; internalError: InternalError }
      • $case: "internalError"

        Contains the case.

      • internalError: InternalError

        Contains the internal error.

    retryType: ServiceError_RetryType

    Retry type tells how to provide retry, e.g.: just a single call or the whole logic before it.

    service: string

    ID of Service which the error originated in. E.g. "dns".

    Settings
    Member Visibility

    On This Page
    Properties