@databricks/sdk-core 0.0.0-dev → 0.1.0-dev.1

package/dist/apierror/codes/codes.d.ts

@@ -0,0 +1,140 @@
+/**
+ * Defines error codes for API errors and their retry semantics.
+ *
+ * @packageDocumentation
+ */
+/**
+ * Code is a numeric code for an error.
+ *
+ * The numeric values are stable and can be relied upon across SDK versions.
+ */
+declare enum Code {
+    /**
+     * Unknown indicates an error that cannot be classified.
+     *
+     * This code might be used for malformed error responses or error responses
+     * using an error code that cannot be mapped to a code in this package.
+     */
+    UNKNOWN = 0,
+    /** OK indicates the operation completed successfully. */
+    OK = 1,
+    /** Canceled indicates the operation was canceled (typically by the caller). */
+    CANCELED = 2,
+    /**
+     * InvalidArgument indicates the client specified an invalid argument.
+     *
+     * By contrast with FailedPrecondition, InvalidArgument indicates arguments
+     * that are problematic regardless of the state of the system. For example,
+     * a malformed request parameter.
+     */
+    INVALID_ARGUMENT = 3,
+    /**
+     * DeadlineExceeded means the operation expired before completion.
+     *
+     * For operations that modify the state of the system, this error may be
+     * returned even if the operation has completed successfully. For
+     * example, a successful response from a server could have been delayed
+     * long enough for the deadline to expire.
+     */
+    DEADLINE_EXCEEDED = 4,
+    /**
+     * NotFound means a requested entity (e.g. a resource or a file) was
+     * not found.
+     */
+    NOT_FOUND = 5,
+    /**
+     * AlreadyExists means an attempt to create an entity failed because one
+     * already exists.
+     */
+    ALREADY_EXISTS = 6,
+    /**
+     * PermissionDenied indicates the caller does not have permission to
+     * execute the specified operation.
+     *
+     * This is different from an error returned when the user has exhausted
+     * some resource (e.g. too many requests) which is a ResourceExhausted
+     * error.
+     */
+    PERMISSION_DENIED = 7,
+    /**
+     * ResourceExhausted indicates some resource has been exhausted, perhaps
+     * a per-user quota, or perhaps the entire file system is out of space.
+     */
+    RESOURCE_EXHAUSTED = 8,
+    /**
+     * FailedPrecondition indicates the operation was rejected because the
+     * system is not in a state required for the operation's execution.
+     * For example, directory to be deleted may be non-empty, an rmdir
+     * operation is applied to a non-directory, etc.
+     */
+    FAILED_PRECONDITION = 9,
+    /**
+     * Aborted indicates the operation was aborted, typically due to a
+     * concurrency issue like sequencer check failures, transaction aborts,
+     * etc.
+     */
+    ABORTED = 10,
+    /**
+     * OutOfRange means the operation was attempted past the valid range.
+     * E.g., seeking or reading past end of file.
+     *
+     * Unlike InvalidArgument, this error indicates a problem that may
+     * be fixed if the system state changes. For example, a 32-bit file
+     * system will generate InvalidArgument if asked to read at an
+     * offset that is not in the range [0,2^32-1], but it will generate
+     * OutOfRange if asked to read from an offset past the current
+     * file size.
+     *
+     * There is a fair bit of overlap between FailedPrecondition and
+     * OutOfRange. We recommend using OutOfRange (the more specific
+     * error) when it applies so that callers who are iterating through
+     * a space can easily look for an OutOfRange error to detect when
+     * they are done.
+     */
+    OUT_OF_RANGE = 11,
+    /**
+     * Unimplemented indicates the operation is not implemented or not
+     * supported/enabled in this service.
+     */
+    UNIMPLEMENTED = 12,
+    /**
+     * Internal indicates an internal error. This means some invariants
+     * expected by the underlying system have been broken. If you see
+     * this error, something is very broken.
+     */
+    INTERNAL = 13,
+    /**
+     * Unavailable indicates the service is currently unavailable.
+     *
+     * This is most likely a transient condition and may be corrected by
+     * retrying. Though, this might not always be safe to retry if the
+     * operation is non-idempotent.
+     *
+     * The Databricks SDK will generally automatically retry the request
+     * with a backoff when encountering this error.
+     */
+    UNAVAILABLE = 14,
+    /** DataLoss indicates unrecoverable data loss or corruption. */
+    DATA_LOSS = 15,
+    /**
+     * Unauthenticated indicates the request does not have valid
+     * authentication credentials for the operation.
+     */
+    UNAUTHENTICATED = 16
+}
+/**
+ * Returns the canonical string representation of an error code.
+ *
+ * If the code is not recognized, "UNKNOWN" is returned. Note that
+ * Code.CANCELED maps to "CANCELLED" (British spelling) to match the gRPC
+ * convention.
+ */
+declare function codeToString(code: Code): string;
+/**
+ * Converts a string representation of an error code to its corresponding
+ * Code value. If the string does not match any known code, Code.UNKNOWN is
+ * returned.
+ */
+declare function codeFromString(s: string): Code;
+export { Code, codeToString, codeFromString };
+//# sourceMappingURL=codes.d.ts.map

package/dist/apierror/codes/codes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"codes.d.ts","sourceRoot":"","sources":["../../../src/apierror/codes/codes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;GAIG;AACH,aAAK,IAAI;IACP;;;;;OAKG;IACH,OAAO,IAAI;IAEX,yDAAyD;IACzD,EAAE,IAAI;IAEN,+EAA+E;IAC/E,QAAQ,IAAI;IAEZ;;;;;;OAMG;IACH,gBAAgB,IAAI;IAEpB;;;;;;;OAOG;IACH,iBAAiB,IAAI;IAErB;;;OAGG;IACH,SAAS,IAAI;IAEb;;;OAGG;IACH,cAAc,IAAI;IAElB;;;;;;;OAOG;IACH,iBAAiB,IAAI;IAErB;;;OAGG;IACH,kBAAkB,IAAI;IAEtB;;;;;OAKG;IACH,mBAAmB,IAAI;IAEvB;;;;OAIG;IACH,OAAO,KAAK;IAEZ;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,KAAK;IAEjB;;;OAGG;IACH,aAAa,KAAK;IAElB;;;;OAIG;IACH,QAAQ,KAAK;IAEb;;;;;;;;;OASG;IACH,WAAW,KAAK;IAEhB,gEAAgE;IAChE,SAAS,KAAK;IAEd;;;OAGG;IACH,eAAe,KAAK;CACrB;AA4BD;;;;;;GAMG;AACH,iBAAS,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAExC;AAED;;;;GAIG;AACH,iBAAS,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,CAEvC;AAED,OAAO,EAAC,IAAI,EAAE,YAAY,EAAE,cAAc,EAAC,CAAC"}

package/dist/apierror/codes/codes.js

@@ -0,0 +1,167 @@
+/**
+ * Defines error codes for API errors and their retry semantics.
+ *
+ * @packageDocumentation
+ */
+/**
+ * Code is a numeric code for an error.
+ *
+ * The numeric values are stable and can be relied upon across SDK versions.
+ */
+var Code;
+(function (Code) {
+    /**
+     * Unknown indicates an error that cannot be classified.
+     *
+     * This code might be used for malformed error responses or error responses
+     * using an error code that cannot be mapped to a code in this package.
+     */
+    Code[Code["UNKNOWN"] = 0] = "UNKNOWN";
+    /** OK indicates the operation completed successfully. */
+    Code[Code["OK"] = 1] = "OK";
+    /** Canceled indicates the operation was canceled (typically by the caller). */
+    Code[Code["CANCELED"] = 2] = "CANCELED";
+    /**
+     * InvalidArgument indicates the client specified an invalid argument.
+     *
+     * By contrast with FailedPrecondition, InvalidArgument indicates arguments
+     * that are problematic regardless of the state of the system. For example,
+     * a malformed request parameter.
+     */
+    Code[Code["INVALID_ARGUMENT"] = 3] = "INVALID_ARGUMENT";
+    /**
+     * DeadlineExceeded means the operation expired before completion.
+     *
+     * For operations that modify the state of the system, this error may be
+     * returned even if the operation has completed successfully. For
+     * example, a successful response from a server could have been delayed
+     * long enough for the deadline to expire.
+     */
+    Code[Code["DEADLINE_EXCEEDED"] = 4] = "DEADLINE_EXCEEDED";
+    /**
+     * NotFound means a requested entity (e.g. a resource or a file) was
+     * not found.
+     */
+    Code[Code["NOT_FOUND"] = 5] = "NOT_FOUND";
+    /**
+     * AlreadyExists means an attempt to create an entity failed because one
+     * already exists.
+     */
+    Code[Code["ALREADY_EXISTS"] = 6] = "ALREADY_EXISTS";
+    /**
+     * PermissionDenied indicates the caller does not have permission to
+     * execute the specified operation.
+     *
+     * This is different from an error returned when the user has exhausted
+     * some resource (e.g. too many requests) which is a ResourceExhausted
+     * error.
+     */
+    Code[Code["PERMISSION_DENIED"] = 7] = "PERMISSION_DENIED";
+    /**
+     * ResourceExhausted indicates some resource has been exhausted, perhaps
+     * a per-user quota, or perhaps the entire file system is out of space.
+     */
+    Code[Code["RESOURCE_EXHAUSTED"] = 8] = "RESOURCE_EXHAUSTED";
+    /**
+     * FailedPrecondition indicates the operation was rejected because the
+     * system is not in a state required for the operation's execution.
+     * For example, directory to be deleted may be non-empty, an rmdir
+     * operation is applied to a non-directory, etc.
+     */
+    Code[Code["FAILED_PRECONDITION"] = 9] = "FAILED_PRECONDITION";
+    /**
+     * Aborted indicates the operation was aborted, typically due to a
+     * concurrency issue like sequencer check failures, transaction aborts,
+     * etc.
+     */
+    Code[Code["ABORTED"] = 10] = "ABORTED";
+    /**
+     * OutOfRange means the operation was attempted past the valid range.
+     * E.g., seeking or reading past end of file.
+     *
+     * Unlike InvalidArgument, this error indicates a problem that may
+     * be fixed if the system state changes. For example, a 32-bit file
+     * system will generate InvalidArgument if asked to read at an
+     * offset that is not in the range [0,2^32-1], but it will generate
+     * OutOfRange if asked to read from an offset past the current
+     * file size.
+     *
+     * There is a fair bit of overlap between FailedPrecondition and
+     * OutOfRange. We recommend using OutOfRange (the more specific
+     * error) when it applies so that callers who are iterating through
+     * a space can easily look for an OutOfRange error to detect when
+     * they are done.
+     */
+    Code[Code["OUT_OF_RANGE"] = 11] = "OUT_OF_RANGE";
+    /**
+     * Unimplemented indicates the operation is not implemented or not
+     * supported/enabled in this service.
+     */
+    Code[Code["UNIMPLEMENTED"] = 12] = "UNIMPLEMENTED";
+    /**
+     * Internal indicates an internal error. This means some invariants
+     * expected by the underlying system have been broken. If you see
+     * this error, something is very broken.
+     */
+    Code[Code["INTERNAL"] = 13] = "INTERNAL";
+    /**
+     * Unavailable indicates the service is currently unavailable.
+     *
+     * This is most likely a transient condition and may be corrected by
+     * retrying. Though, this might not always be safe to retry if the
+     * operation is non-idempotent.
+     *
+     * The Databricks SDK will generally automatically retry the request
+     * with a backoff when encountering this error.
+     */
+    Code[Code["UNAVAILABLE"] = 14] = "UNAVAILABLE";
+    /** DataLoss indicates unrecoverable data loss or corruption. */
+    Code[Code["DATA_LOSS"] = 15] = "DATA_LOSS";
+    /**
+     * Unauthenticated indicates the request does not have valid
+     * authentication credentials for the operation.
+     */
+    Code[Code["UNAUTHENTICATED"] = 16] = "UNAUTHENTICATED";
+})(Code || (Code = {}));
+// Maps Code values to their canonical string representation.
+const CODE_TO_STRING = new Map([
+    [Code.UNKNOWN, 'UNKNOWN'],
+    [Code.OK, 'OK'],
+    [Code.CANCELED, 'CANCELLED'],
+    [Code.INVALID_ARGUMENT, 'INVALID_ARGUMENT'],
+    [Code.DEADLINE_EXCEEDED, 'DEADLINE_EXCEEDED'],
+    [Code.NOT_FOUND, 'NOT_FOUND'],
+    [Code.ALREADY_EXISTS, 'ALREADY_EXISTS'],
+    [Code.PERMISSION_DENIED, 'PERMISSION_DENIED'],
+    [Code.RESOURCE_EXHAUSTED, 'RESOURCE_EXHAUSTED'],
+    [Code.FAILED_PRECONDITION, 'FAILED_PRECONDITION'],
+    [Code.ABORTED, 'ABORTED'],
+    [Code.OUT_OF_RANGE, 'OUT_OF_RANGE'],
+    [Code.UNIMPLEMENTED, 'UNIMPLEMENTED'],
+    [Code.INTERNAL, 'INTERNAL'],
+    [Code.UNAVAILABLE, 'UNAVAILABLE'],
+    [Code.DATA_LOSS, 'DATA_LOSS'],
+    [Code.UNAUTHENTICATED, 'UNAUTHENTICATED'],
+]);
+// Maps canonical strings back to Code values.
+const STRING_TO_CODE = new Map([...CODE_TO_STRING.entries()].map(([code, str]) => [str, code]));
+/**
+ * Returns the canonical string representation of an error code.
+ *
+ * If the code is not recognized, "UNKNOWN" is returned. Note that
+ * Code.CANCELED maps to "CANCELLED" (British spelling) to match the gRPC
+ * convention.
+ */
+function codeToString(code) {
+    return CODE_TO_STRING.get(code) ?? 'UNKNOWN';
+}
+/**
+ * Converts a string representation of an error code to its corresponding
+ * Code value. If the string does not match any known code, Code.UNKNOWN is
+ * returned.
+ */
+function codeFromString(s) {
+    return STRING_TO_CODE.get(s) ?? Code.UNKNOWN;
+}
+export { Code, codeToString, codeFromString };
+//# sourceMappingURL=codes.js.map

package/dist/apierror/codes/codes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codes.js","sourceRoot":"","sources":["../../../src/apierror/codes/codes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;GAIG;AACH,IAAK,IAiIJ;AAjID,WAAK,IAAI;IACP;;;;;OAKG;IACH,qCAAW,CAAA;IAEX,yDAAyD;IACzD,2BAAM,CAAA;IAEN,+EAA+E;IAC/E,uCAAY,CAAA;IAEZ;;;;;;OAMG;IACH,uDAAoB,CAAA;IAEpB;;;;;;;OAOG;IACH,yDAAqB,CAAA;IAErB;;;OAGG;IACH,yCAAa,CAAA;IAEb;;;OAGG;IACH,mDAAkB,CAAA;IAElB;;;;;;;OAOG;IACH,yDAAqB,CAAA;IAErB;;;OAGG;IACH,2DAAsB,CAAA;IAEtB;;;;;OAKG;IACH,6DAAuB,CAAA;IAEvB;;;;OAIG;IACH,sCAAY,CAAA;IAEZ;;;;;;;;;;;;;;;;OAgBG;IACH,gDAAiB,CAAA;IAEjB;;;OAGG;IACH,kDAAkB,CAAA;IAElB;;;;OAIG;IACH,wCAAa,CAAA;IAEb;;;;;;;;;OASG;IACH,8CAAgB,CAAA;IAEhB,gEAAgE;IAChE,0CAAc,CAAA;IAEd;;;OAGG;IACH,sDAAoB,CAAA;AACtB,CAAC,EAjII,IAAI,KAAJ,IAAI,QAiIR;AAED,6DAA6D;AAC7D,MAAM,cAAc,GAA8B,IAAI,GAAG,CAAC;IACxD,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC;IACzB,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC;IACf,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC;IAC5B,CAAC,IAAI,CAAC,gBAAgB,EAAE,kBAAkB,CAAC;IAC3C,CAAC,IAAI,CAAC,iBAAiB,EAAE,mBAAmB,CAAC;IAC7C,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC;IAC7B,CAAC,IAAI,CAAC,cAAc,EAAE,gBAAgB,CAAC;IACvC,CAAC,IAAI,CAAC,iBAAiB,EAAE,mBAAmB,CAAC;IAC7C,CAAC,IAAI,CAAC,kBAAkB,EAAE,oBAAoB,CAAC;IAC/C,CAAC,IAAI,CAAC,mBAAmB,EAAE,qBAAqB,CAAC;IACjD,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC;IACzB,CAAC,IAAI,CAAC,YAAY,EAAE,cAAc,CAAC;IACnC,CAAC,IAAI,CAAC,aAAa,EAAE,eAAe,CAAC;IACrC,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC;IAC3B,CAAC,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC;IACjC,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC;IAC7B,CAAC,IAAI,CAAC,eAAe,EAAE,iBAAiB,CAAC;CAC1C,CAAC,CAAC;AAEH,8CAA8C;AAC9C,MAAM,cAAc,GAA8B,IAAI,GAAG,CACvD,CAAC,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAChE,CAAC;AAEF;;;;;;GAMG;AACH,SAAS,YAAY,CAAC,IAAU;IAC9B,OAAO,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC;AAC/C,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc,CAAC,CAAS;IAC/B,OAAO,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC;AAC/C,CAAC;AAED,OAAO,EAAC,IAAI,EAAE,YAAY,EAAE,cAAc,EAAC,CAAC"}

package/dist/apierror/codes/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Canonical error codes for Databricks API errors.
+ *
+ * @packageDocumentation
+ */
+export { Code, codeToString, codeFromString } from './codes';
+//# sourceMappingURL=index.d.ts.map

package/dist/apierror/codes/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/apierror/codes/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAC,IAAI,EAAE,YAAY,EAAE,cAAc,EAAC,MAAM,SAAS,CAAC"}

package/dist/apierror/codes/index.js

@@ -0,0 +1,7 @@
+/**
+ * Canonical error codes for Databricks API errors.
+ *
+ * @packageDocumentation
+ */
+export { Code, codeToString, codeFromString } from './codes';
+//# sourceMappingURL=index.js.map

package/dist/apierror/codes/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/apierror/codes/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAC,IAAI,EAAE,YAAY,EAAE,cAAc,EAAC,MAAM,SAAS,CAAC"}

package/dist/apierror/details.d.ts

@@ -0,0 +1,177 @@
+/**
+ * Defines structured error detail types for API errors.
+ *
+ * @packageDocumentation
+ */
+/**
+ * ErrorDetails contains the error details of an API error. It is the union of
+ * known error details types and unknown details.
+ */
+export interface ErrorDetails {
+    errorInfo?: ErrorInfo;
+    requestInfo?: RequestInfo;
+    retryInfo?: RetryInfo;
+    debugInfo?: DebugInfo;
+    quotaFailure?: QuotaFailure;
+    preconditionFailure?: PreconditionFailure;
+    badRequest?: BadRequest;
+    resourceInfo?: ResourceInfo;
+    help?: Help;
+    /**
+     * UnknownDetails contains error details that cannot be parsed into one of
+     * the known types above.
+     */
+    unknownDetails: unknown[];
+}
+/** ErrorInfo describes the cause of the error with structured details. */
+export interface ErrorInfo {
+    /**
+     * The reason of the error. This is a constant value that identifies the
+     * proximate cause of the error.
+     */
+    reason: string;
+    /** The logical grouping to which the "reason" belongs. */
+    domain: string;
+    /** Additional structured details about this error. */
+    metadata: Record<string, string>;
+}
+/**
+ * RequestInfo contains metadata about the request that clients can attach when
+ * filing a bug or providing other forms of feedback.
+ */
+export interface RequestInfo {
+    /**
+     * An opaque string that should only be interpreted by the service that
+     * generated it. For example, it can be used to identify requests in the
+     * service's logs.
+     */
+    requestId: string;
+    /**
+     * Any data that was used to serve this request. For example, an encrypted
+     * stack trace that can be sent back to the service provider for debugging.
+     */
+    servingData: string;
+}
+/**
+ * RetryInfo describes when the clients can retry a failed request. Clients
+ * could ignore the recommendation here or retry when this information is
+ * missing from error responses.
+ *
+ * It's always recommended that clients should use exponential backoff when
+ * retrying.
+ *
+ * Clients should wait until `retryDelayMs` amount of time has passed since
+ * receiving the error response before retrying. If retrying requests also
+ * fail, clients should use an exponential backoff scheme to gradually increase
+ * the delay between retries based on `retryDelayMs`, until either a maximum
+ * number of retries have been reached or a maximum retry delay cap has been
+ * reached.
+ */
+export interface RetryInfo {
+    /** Clients should wait at least this long between retrying the same request, in milliseconds. */
+    retryDelayMs: number;
+}
+/** Describes additional debugging info. */
+export interface DebugInfo {
+    /** The stack trace entries indicating where the error occurred. */
+    stackEntries: string[];
+    /** Additional debugging information provided by the server. */
+    detail: string;
+}
+/**
+ * Describes how a quota check failed.
+ *
+ * For example if a daily limit was exceeded for the calling project,
+ * a service could respond with a QuotaFailure detail containing the project
+ * id and the description of the quota limit that was exceeded. If the
+ * calling project hasn't enabled the service in the developer console, then
+ * a service could respond with the project id and set `service_disabled`
+ * to true.
+ *
+ * Also see RetryInfo and Help types for other details about handling a
+ * quota failure.
+ */
+export interface QuotaFailure {
+    /** Describes all quota violations. */
+    violations: QuotaFailureViolation[];
+}
+export interface QuotaFailureViolation {
+    /** The subject on which the quota check failed. */
+    subject: string;
+    /**
+     * A description of how the quota check failed. Clients can use this
+     * description to find more about the quota configuration in the service's
+     * public documentation, or find the relevant quota limit to adjust through
+     * developer console.
+     *
+     * For example: "Service disabled" or "Daily Limit for read operations
+     * exceeded".
+     */
+    description: string;
+}
+/** Describes what preconditions have failed. */
+export interface PreconditionFailure {
+    /** Describes all precondition violations. */
+    violations: PreconditionFailureViolation[];
+}
+export interface PreconditionFailureViolation {
+    /** The type of PreconditionFailure. */
+    type: string;
+    /** The subject, relative to the type, that failed. */
+    subject: string;
+    /**
+     * A description of how the precondition failed. Developers can use this
+     * description to understand how to fix the failure.
+     *
+     * For example: "Terms of service not accepted".
+     */
+    description: string;
+}
+/**
+ * Describes violations in a client request. This error type focuses on the
+ * syntactic aspects of the request.
+ */
+export interface BadRequest {
+    fieldViolations: BadRequestFieldViolation[];
+}
+export interface BadRequestFieldViolation {
+    /** A path leading to a field in the request body. */
+    field: string;
+    /** A description of why the request element is bad. */
+    description: string;
+}
+/** Describes the resource that is being accessed. */
+export interface ResourceInfo {
+    /** A name for the type of resource being accessed. */
+    resourceType: string;
+    /** The name of the resource being accessed. */
+    resourceName: string;
+    /** The owner of the resource (optional). */
+    owner: string;
+    /** Describes what error is encountered when accessing this resource. */
+    description: string;
+}
+/**
+ * Provides links to documentation or for performing an out of band action.
+ *
+ * For example, if a quota check failed with an error indicating the calling
+ * project hasn't enabled the accessed service, this can contain a URL pointing
+ * directly to the right place in the developer console to flip the bit.
+ */
+export interface Help {
+    /** URL(s) pointing to additional information on handling the current error. */
+    links: HelpLink[];
+}
+export interface HelpLink {
+    /** Describes what the link offers. */
+    description: string;
+    /** The URL of the link. */
+    url: string;
+}
+/**
+ * Parses an array of raw error detail values into a structured ErrorDetails
+ * object. If multiple details of the same known type are present, the last
+ * one wins.
+ */
+export declare function parseErrorDetails(rawDetails: unknown[]): ErrorDetails;
+//# sourceMappingURL=details.d.ts.map

package/dist/apierror/details.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"details.d.ts","sourceRoot":"","sources":["../../src/apierror/details.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,IAAI,CAAC,EAAE,IAAI,CAAC;IAEZ;;;OAGG;IACH,cAAc,EAAE,OAAO,EAAE,CAAC;CAC3B;AAED,0EAA0E;AAC1E,MAAM,WAAW,SAAS;IACxB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf,0DAA0D;IAC1D,MAAM,EAAE,MAAM,CAAC;IAEf,sDAAsD;IACtD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,SAAS;IACxB,iGAAiG;IACjG,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,2CAA2C;AAC3C,MAAM,WAAW,SAAS;IACxB,mEAAmE;IACnE,YAAY,EAAE,MAAM,EAAE,CAAC;IAEvB,+DAA+D;IAC/D,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,YAAY;IAC3B,sCAAsC;IACtC,UAAU,EAAE,qBAAqB,EAAE,CAAC;CACrC;AAED,MAAM,WAAW,qBAAqB;IACpC,mDAAmD;IACnD,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;;OAQG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,gDAAgD;AAChD,MAAM,WAAW,mBAAmB;IAClC,6CAA6C;IAC7C,UAAU,EAAE,4BAA4B,EAAE,CAAC;CAC5C;AAED,MAAM,WAAW,4BAA4B;IAC3C,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IAEb,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,eAAe,EAAE,wBAAwB,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,wBAAwB;IACvC,qDAAqD;IACrD,KAAK,EAAE,MAAM,CAAC;IAEd,uDAAuD;IACvD,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,qDAAqD;AACrD,MAAM,WAAW,YAAY;IAC3B,sDAAsD;IACtD,YAAY,EAAE,MAAM,CAAC;IAErB,+CAA+C;IAC/C,YAAY,EAAE,MAAM,CAAC;IAErB,4CAA4C;IAC5C,KAAK,EAAE,MAAM,CAAC;IAEd,wEAAwE;IACxE,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,IAAI;IACnB,+EAA+E;IAC/E,KAAK,EAAE,QAAQ,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,QAAQ;IACvB,sCAAsC;IACtC,WAAW,EAAE,MAAM,CAAC;IAEpB,2BAA2B;IAC3B,GAAG,EAAE,MAAM,CAAC;CACb;AA8OD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,OAAO,EAAE,GAAG,YAAY,CAiBrE"}