NotFoundError

Defined in: packages/aip/src/errors/errors.ts:140

Some requested entity (e.g., file or directory) was not found.

Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, NOT_FOUND may be used. If a request is denied for some users within a class of users, such as user-based access control, PERMISSION_DENIED must be used.

Extends

StatusError

Constructors

Constructor

new NotFoundError(init): NotFoundError

Defined in: packages/aip/src/errors/errors.ts:144

Parameters

init

Omit<StatusInit, "code">

Returns

NotFoundError

Overrides

StatusError.constructor

Properties

cause?

optional cause?: unknown

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

StatusError.cause

code

readonly code: Code

Defined in: packages/aip/src/errors/errors.ts:17

Inherited from

StatusError.code

details

readonly details: ErrorDetails

Defined in: packages/aip/src/errors/errors.ts:18

Inherited from

StatusError.details

httpCode?

readonly optional httpCode?: number

Defined in: packages/aip/src/errors/errors.ts:19

Inherited from

StatusError.httpCode

message

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

StatusError.message

name

name: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

StatusError.name

stack?

optional stack?: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

StatusError.stack

code

static code: Code = Code.NOT_FOUND

Defined in: packages/aip/src/errors/errors.ts:141

httpCode

static httpCode: number = 404

Defined in: packages/aip/src/errors/errors.ts:142

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@25.2.3/node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

StatusError.stackTraceLimit

Methods

toStatus()

toStatus(): Status

Defined in: packages/aip/src/errors/errors.ts:45

Creates a google.rpc.Status message from this StatusError.

Returns

Status

Inherited from

StatusError.toStatus

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@25.2.3/node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();