@opencensus/web-types
Version:
OpenCensus Web types is a slightly-patched copy of the `types.ts` files from `@opencensus/core` so that they can be easily imported in web-specific packages.
196 lines • 8.56 kB
JavaScript
/**
* Copyright 2019, OpenCensus Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/** An enumeration of canonical status codes. */
export var CanonicalCode;
(function (CanonicalCode) {
/**
* Not an error; returned on success
*/
CanonicalCode[CanonicalCode["OK"] = 0] = "OK";
/**
* The operation was cancelled (typically by the caller).
*/
CanonicalCode[CanonicalCode["CANCELLED"] = 1] = "CANCELLED";
/**
* Unknown error. An example of where this error may be returned is
* if a status value received from another address space belongs to
* an error-space that is not known in this address space. Also
* errors raised by APIs that do not return enough error information
* may be converted to this error.
*/
CanonicalCode[CanonicalCode["UNKNOWN"] = 2] = "UNKNOWN";
/**
* Client specified an invalid argument. Note that this differs
* from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments
* that are problematic regardless of the state of the system
* (e.g., a malformed file name).
*/
CanonicalCode[CanonicalCode["INVALID_ARGUMENT"] = 3] = "INVALID_ARGUMENT";
/**
* Deadline expired before operation could complete. For operations
* that change 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.
*/
CanonicalCode[CanonicalCode["DEADLINE_EXCEEDED"] = 4] = "DEADLINE_EXCEEDED";
/**
* Some requested entity (e.g., file or directory) was not found.
*/
CanonicalCode[CanonicalCode["NOT_FOUND"] = 5] = "NOT_FOUND";
/**
* Some entity that we attempted to create (e.g., file or directory)
* already exists.
*/
CanonicalCode[CanonicalCode["ALREADY_EXISTS"] = 6] = "ALREADY_EXISTS";
/**
* The caller does not have permission to execute the specified
* operation. PERMISSION_DENIED must not be used for rejections
* caused by exhausting some resource (use RESOURCE_EXHAUSTED
* instead for those errors). PERMISSION_DENIED must not be
* used if the caller can not be identified (use UNAUTHENTICATED
* instead for those errors).
*/
CanonicalCode[CanonicalCode["PERMISSION_DENIED"] = 7] = "PERMISSION_DENIED";
/**
* Some resource has been exhausted, perhaps a per-user quota, or
* perhaps the entire file system is out of space.
*/
CanonicalCode[CanonicalCode["RESOURCE_EXHAUSTED"] = 8] = "RESOURCE_EXHAUSTED";
/**
* 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.
*
* A litmus test that may help a service implementor in deciding
* between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE:
*
* - Use UNAVAILABLE if the client can retry just the failing call.
* - Use ABORTED if the client should retry at a higher-level
* (e.g., restarting a read-modify-write sequence).
* - Use FAILED_PRECONDITION if the client should not retry until
* the system state has been explicitly fixed. E.g., if an "rmdir"
* fails because the directory is non-empty, FAILED_PRECONDITION
* should be returned since the client should not retry unless
* they have first fixed up the directory by deleting files from it.
* - Use FAILED_PRECONDITION if the client performs conditional
* REST Get/Update/Delete on a resource and the resource on the
* server does not match the condition. E.g., conflicting
* read-modify-write on the same resource.
*/
CanonicalCode[CanonicalCode["FAILED_PRECONDITION"] = 9] = "FAILED_PRECONDITION";
/**
* The operation was aborted, typically due to a concurrency issue
* like sequencer check failures, transaction aborts, etc.
*
* See litmus test above for deciding between FAILED_PRECONDITION,
* ABORTED, and UNAVAILABLE.
*/
CanonicalCode[CanonicalCode["ABORTED"] = 10] = "ABORTED";
/**
* Operation was attempted past the valid range. E.g., seeking or
* reading past end of file.
*
* Unlike INVALID_ARGUMENT, this error indicates a problem that may
* be fixed if the system state changes. For example, a 32-bit file
* system will generate INVALID_ARGUMENT if asked to read at an
* offset that is not in the range [0,2^32-1], but it will generate
* OUT_OF_RANGE if asked to read from an offset past the current
* file size.
*
* There is a fair bit of overlap between FAILED_PRECONDITION and
* OUT_OF_RANGE. We recommend using OUT_OF_RANGE (the more specific
* error) when it applies so that callers who are iterating through
* a space can easily look for an OUT_OF_RANGE error to detect when
* they are done.
*/
CanonicalCode[CanonicalCode["OUT_OF_RANGE"] = 11] = "OUT_OF_RANGE";
/**
* Operation is not implemented or not supported/enabled in this service.
*/
CanonicalCode[CanonicalCode["UNIMPLEMENTED"] = 12] = "UNIMPLEMENTED";
/**
* Internal errors. Means some invariants expected by underlying
* system has been broken. If you see one of these errors,
* something is very broken.
*/
CanonicalCode[CanonicalCode["INTERNAL"] = 13] = "INTERNAL";
/**
* The service is currently unavailable. This is a most likely a
* transient condition and may be corrected by retrying with
* a backoff.
*
* See litmus test above for deciding between FAILED_PRECONDITION,
* ABORTED, and UNAVAILABLE.
*/
CanonicalCode[CanonicalCode["UNAVAILABLE"] = 14] = "UNAVAILABLE";
/**
* Unrecoverable data loss or corruption.
*/
CanonicalCode[CanonicalCode["DATA_LOSS"] = 15] = "DATA_LOSS";
/**
* The request does not have valid authentication credentials for the
* operation.
*/
CanonicalCode[CanonicalCode["UNAUTHENTICATED"] = 16] = "UNAUTHENTICATED";
})(CanonicalCode || (CanonicalCode = {}));
/** An event describing a message sent/received between Spans. */
export var MessageEventType;
(function (MessageEventType) {
/** Unknown event type. */
MessageEventType[MessageEventType["UNSPECIFIED"] = 0] = "UNSPECIFIED";
/** Indicates a sent message. */
MessageEventType[MessageEventType["SENT"] = 1] = "SENT";
/** Indicates a received message. */
MessageEventType[MessageEventType["RECEIVED"] = 2] = "RECEIVED";
})(MessageEventType || (MessageEventType = {}));
/**
* Type of span. Can be used to specify additional relationships between spans
* in addition to a parent/child relationship.
*/
export var SpanKind;
(function (SpanKind) {
/** Unspecified */
SpanKind[SpanKind["UNSPECIFIED"] = 0] = "UNSPECIFIED";
/**
* Indicates that the span covers server-side handling of an RPC or other
* remote network request.
*/
SpanKind[SpanKind["SERVER"] = 1] = "SERVER";
/**
* Indicates that the span covers the client-side wrapper around an RPC or
* other remote request.
*/
SpanKind[SpanKind["CLIENT"] = 2] = "CLIENT";
})(SpanKind || (SpanKind = {}));
/**
* Type of link. The relationship of the current span relative to the linked
* span.
*/
export var LinkType;
(function (LinkType) {
/**
* The relationship of the two spans is unknown, or known but other
* than parent-child.
*/
LinkType[LinkType["UNSPECIFIED"] = 0] = "UNSPECIFIED";
/** The linked span is a child of the current span. */
LinkType[LinkType["CHILD_LINKED_SPAN"] = 1] = "CHILD_LINKED_SPAN";
/** The linked span is a parent of the current span. */
LinkType[LinkType["PARENT_LINKED_SPAN"] = 2] = "PARENT_LINKED_SPAN";
})(LinkType || (LinkType = {}));
//# sourceMappingURL=types.js.map