@authzed/authzed-js-node
Version:
authzed js client for nodejs
509 lines • 18.6 kB
JavaScript
// @generated by protobuf-ts 2.9.1 with parameter generate_dependencies,long_type_string,client_grpc1
// @generated from protobuf file "authzed/api/v1/error_reason.proto" (package "authzed.api.v1", syntax proto3)
// tslint:disable
/**
* Defines the supported values for `google.rpc.ErrorInfo.reason` for the
* `authzed.com` error domain.
*
* @generated from protobuf enum authzed.api.v1.ErrorReason
*/
export var ErrorReason;
(function (ErrorReason) {
/**
* Do not use this default value.
*
* @generated from protobuf enum value: ERROR_REASON_UNSPECIFIED = 0;
*/
ErrorReason[ErrorReason["UNSPECIFIED"] = 0] = "UNSPECIFIED";
/**
* The request gave a schema that could not be parsed.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_SCHEMA_PARSE_ERROR",
* "domain": "authzed.com",
* "metadata": {
* "start_line_number": "1",
* "start_column_position": "19",
* "end_line_number": "1",
* "end_column_position": "19",
* "source_code": "somedefinition",
* }
* }
*
* The line numbers and column positions are 0-indexed and may not be present.
*
* @generated from protobuf enum value: ERROR_REASON_SCHEMA_PARSE_ERROR = 1;
*/
ErrorReason[ErrorReason["SCHEMA_PARSE_ERROR"] = 1] = "SCHEMA_PARSE_ERROR";
/**
* The request contains a schema with a type error.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_SCHEMA_TYPE_ERROR",
* "domain": "authzed.com",
* "metadata": {
* "definition_name": "somedefinition",
* ... additional keys based on the kind of type error ...
* }
* }
*
* @generated from protobuf enum value: ERROR_REASON_SCHEMA_TYPE_ERROR = 2;
*/
ErrorReason[ErrorReason["SCHEMA_TYPE_ERROR"] = 2] = "SCHEMA_TYPE_ERROR";
/**
* The request referenced an unknown object definition in the schema.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_UNKNOWN_DEFINITION",
* "domain": "authzed.com",
* "metadata": {
* "definition_name": "somedefinition"
* }
* }
*
* @generated from protobuf enum value: ERROR_REASON_UNKNOWN_DEFINITION = 3;
*/
ErrorReason[ErrorReason["UNKNOWN_DEFINITION"] = 3] = "UNKNOWN_DEFINITION";
/**
* The request referenced an unknown relation or permission under a definition in the schema.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_UNKNOWN_RELATION_OR_PERMISSION",
* "domain": "authzed.com",
* "metadata": {
* "definition_name": "somedefinition",
* "relation_or_permission_name": "somepermission"
* }
* }
*
* @generated from protobuf enum value: ERROR_REASON_UNKNOWN_RELATION_OR_PERMISSION = 4;
*/
ErrorReason[ErrorReason["UNKNOWN_RELATION_OR_PERMISSION"] = 4] = "UNKNOWN_RELATION_OR_PERMISSION";
/**
* The WriteRelationships request contained more updates than the maximum configured.
*
* Example of an ErrorInfo:
*
* { "reason": "ERROR_REASON_TOO_MANY_UPDATES_IN_REQUEST",
* "domain": "authzed.com",
* "metadata": {
* "update_count": "525",
* "maximum_updates_allowed": "500",
* }
* }
*
* @generated from protobuf enum value: ERROR_REASON_TOO_MANY_UPDATES_IN_REQUEST = 5;
*/
ErrorReason[ErrorReason["TOO_MANY_UPDATES_IN_REQUEST"] = 5] = "TOO_MANY_UPDATES_IN_REQUEST";
/**
* The request contained more preconditions than the maximum configured.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_TOO_MANY_PRECONDITIONS_IN_REQUEST",
* "domain": "authzed.com",
* "metadata": {
* "precondition_count": "525",
* "maximum_preconditions_allowed": "500",
* }
* }
*
* @generated from protobuf enum value: ERROR_REASON_TOO_MANY_PRECONDITIONS_IN_REQUEST = 6;
*/
ErrorReason[ErrorReason["TOO_MANY_PRECONDITIONS_IN_REQUEST"] = 6] = "TOO_MANY_PRECONDITIONS_IN_REQUEST";
/**
* The request contained a precondition that failed.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_WRITE_OR_DELETE_PRECONDITION_FAILURE",
* "domain": "authzed.com",
* "metadata": {
* "precondition_resource_type": "document",
* ... other fields for the filter ...
* "precondition_operation": "MUST_EXIST",
* }
* }
*
* @generated from protobuf enum value: ERROR_REASON_WRITE_OR_DELETE_PRECONDITION_FAILURE = 7;
*/
ErrorReason[ErrorReason["WRITE_OR_DELETE_PRECONDITION_FAILURE"] = 7] = "WRITE_OR_DELETE_PRECONDITION_FAILURE";
/**
* A write or delete request was made to an instance that is deployed in read-only mode.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_SERVICE_READ_ONLY",
* "domain": "authzed.com"
* }
*
* @generated from protobuf enum value: ERROR_REASON_SERVICE_READ_ONLY = 8;
*/
ErrorReason[ErrorReason["SERVICE_READ_ONLY"] = 8] = "SERVICE_READ_ONLY";
/**
* The request referenced an unknown caveat in the schema.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_UNKNOWN_CAVEAT",
* "domain": "authzed.com",
* "metadata": {
* "caveat_name": "somecaveat"
* }
* }
*
* @generated from protobuf enum value: ERROR_REASON_UNKNOWN_CAVEAT = 9;
*/
ErrorReason[ErrorReason["UNKNOWN_CAVEAT"] = 9] = "UNKNOWN_CAVEAT";
/**
* The request tries to use a subject type that was not valid for a relation.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_INVALID_SUBJECT_TYPE",
* "domain": "authzed.com",
* "metadata": {
* "definition_name": "somedefinition",
* "relation_name": "somerelation",
* "subject_type": "user:*"
* }
* }
*
* @generated from protobuf enum value: ERROR_REASON_INVALID_SUBJECT_TYPE = 10;
*/
ErrorReason[ErrorReason["INVALID_SUBJECT_TYPE"] = 10] = "INVALID_SUBJECT_TYPE";
/**
* The request tries to specify a caveat parameter value with the wrong type.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_CAVEAT_PARAMETER_TYPE_ERROR",
* "domain": "authzed.com",
* "metadata": {
* "definition_name": "somedefinition",
* "relation_name": "somerelation",
* "caveat_name": "somecaveat",
* "parameter_name": "someparameter",
* "expected_type": "int",
* }
* }
*
* @generated from protobuf enum value: ERROR_REASON_CAVEAT_PARAMETER_TYPE_ERROR = 11;
*/
ErrorReason[ErrorReason["CAVEAT_PARAMETER_TYPE_ERROR"] = 11] = "CAVEAT_PARAMETER_TYPE_ERROR";
/**
* The request tries to perform two or more updates on the same relationship in the same WriteRelationships call.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_UPDATES_ON_SAME_RELATIONSHIP",
* "domain": "authzed.com",
* "metadata": {
* "definition_name": "somedefinition",
* "relationship": "somerelationship",
* }
* }
*
* @generated from protobuf enum value: ERROR_REASON_UPDATES_ON_SAME_RELATIONSHIP = 12;
*/
ErrorReason[ErrorReason["UPDATES_ON_SAME_RELATIONSHIP"] = 12] = "UPDATES_ON_SAME_RELATIONSHIP";
/**
* The request tries to write a relationship on a permission instead of a relation.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_CANNOT_UPDATE_PERMISSION",
* "domain": "authzed.com",
* "metadata": {
* "definition_name": "somedefinition",
* "permission_name": "somerelation",
* }
* }
*
* @generated from protobuf enum value: ERROR_REASON_CANNOT_UPDATE_PERMISSION = 13;
*/
ErrorReason[ErrorReason["CANNOT_UPDATE_PERMISSION"] = 13] = "CANNOT_UPDATE_PERMISSION";
/**
* The request failed to evaluate a caveat expression due to an error.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_CAVEAT_EVALUATION_ERROR",
* "domain": "authzed.com",
* "metadata": {
* "caveat_name": "somecaveat",
* }
* }
*
* @generated from protobuf enum value: ERROR_REASON_CAVEAT_EVALUATION_ERROR = 14;
*/
ErrorReason[ErrorReason["CAVEAT_EVALUATION_ERROR"] = 14] = "CAVEAT_EVALUATION_ERROR";
/**
* The request failed because the provided cursor was invalid in some way.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_INVALID_CURSOR",
* "domain": "authzed.com",
* "metadata": {
* ... additional keys based on the kind of cursor error ...
* }
* }
*
* @generated from protobuf enum value: ERROR_REASON_INVALID_CURSOR = 15;
*/
ErrorReason[ErrorReason["INVALID_CURSOR"] = 15] = "INVALID_CURSOR";
/**
* The request failed because there are too many matching relationships to be
* deleted within a single transactional deletion call. To avoid, set
* `optional_allow_partial_deletions` to true on the DeleteRelationships call.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_TOO_MANY_RELATIONSHIPS_FOR_TRANSACTIONAL_DELETE",
* "domain": "authzed.com",
* "metadata": {
* ... fields for the filter ...
* }
* }
*
* @generated from protobuf enum value: ERROR_REASON_TOO_MANY_RELATIONSHIPS_FOR_TRANSACTIONAL_DELETE = 16;
*/
ErrorReason[ErrorReason["TOO_MANY_RELATIONSHIPS_FOR_TRANSACTIONAL_DELETE"] = 16] = "TOO_MANY_RELATIONSHIPS_FOR_TRANSACTIONAL_DELETE";
/**
* The request failed because the client attempted to write a relationship
* with a context that exceeded the configured server limit.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_MAX_RELATIONSHIP_CONTEXT_SIZE",
* "domain": "authzed.com",
* "metadata": {
* "relationship": "relationship_exceeding_the_limit",
* "max_allowed_size": "server_max_allowed_context_size",
* "context_size": "actual_relationship_context_size" ,
* }
* }
*
* @generated from protobuf enum value: ERROR_REASON_MAX_RELATIONSHIP_CONTEXT_SIZE = 17;
*/
ErrorReason[ErrorReason["MAX_RELATIONSHIP_CONTEXT_SIZE"] = 17] = "MAX_RELATIONSHIP_CONTEXT_SIZE";
/**
* The request failed because a relationship marked to be CREATEd
* was already present within the datastore.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_ATTEMPT_TO_RECREATE_RELATIONSHIP",
* "domain": "authzed.com",
* "metadata": {
* "relationship": "relationship_that_already_existed",
* "resource_type": "resource type",
* "resource_object_id": "resource object id",
* ... additional decomposed relationship fields ...
* }
* }
*
* @generated from protobuf enum value: ERROR_REASON_ATTEMPT_TO_RECREATE_RELATIONSHIP = 18;
*/
ErrorReason[ErrorReason["ATTEMPT_TO_RECREATE_RELATIONSHIP"] = 18] = "ATTEMPT_TO_RECREATE_RELATIONSHIP";
/**
* The request failed because it caused the maximum depth allowed to be
* exceeded. This typically indicates that there is a circular data traversal
* somewhere in the schema, but can also be raised if the data traversal is simply
* too deep.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_MAXIMUM_DEPTH_EXCEEDED",
* "domain": "authzed.com",
* "metadata": {
* "maximum_depth_allowed": "50",
* ... additional fields based on request type ...
* }
* }
*
* @generated from protobuf enum value: ERROR_REASON_MAXIMUM_DEPTH_EXCEEDED = 19;
*/
ErrorReason[ErrorReason["MAXIMUM_DEPTH_EXCEEDED"] = 19] = "MAXIMUM_DEPTH_EXCEEDED";
/**
* The request failed due to a serialization error in the backend database.
* This typically indicates that various in flight transactions conflicted with each other
* and the database had to abort one or more of them. SpiceDB will retry a few times before returning
* the error to the client.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_SERIALIZATION_FAILURE",
* "domain": "authzed.com",
* "metadata": {}
* }
*
* @generated from protobuf enum value: ERROR_REASON_SERIALIZATION_FAILURE = 20;
*/
ErrorReason[ErrorReason["SERIALIZATION_FAILURE"] = 20] = "SERIALIZATION_FAILURE";
/**
* The request contained more check items than the maximum configured.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_TOO_MANY_CHECKS_IN_REQUEST",
* "domain": "authzed.com",
* "metadata": {
* "check_count": "525",
* "maximum_checks_allowed": "500",
* }
* }
*
* @generated from protobuf enum value: ERROR_REASON_TOO_MANY_CHECKS_IN_REQUEST = 21;
*/
ErrorReason[ErrorReason["TOO_MANY_CHECKS_IN_REQUEST"] = 21] = "TOO_MANY_CHECKS_IN_REQUEST";
/**
* The request's specified limit is too large.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_EXCEEDS_MAXIMUM_ALLOWABLE_LIMIT",
* "domain": "authzed.com",
* "metadata": {
* "limit_provided": "525",
* "maximum_limit_allowed": "500",
* }
* }
*
* @generated from protobuf enum value: ERROR_REASON_EXCEEDS_MAXIMUM_ALLOWABLE_LIMIT = 22;
*/
ErrorReason[ErrorReason["EXCEEDS_MAXIMUM_ALLOWABLE_LIMIT"] = 22] = "EXCEEDS_MAXIMUM_ALLOWABLE_LIMIT";
/**
* The request failed because the provided filter was invalid in some way.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_INVALID_FILTER",
* "domain": "authzed.com",
* "metadata": {
* "filter": "...",
* }
* }
*
* @generated from protobuf enum value: ERROR_REASON_INVALID_FILTER = 23;
*/
ErrorReason[ErrorReason["INVALID_FILTER"] = 23] = "INVALID_FILTER";
/**
* The request failed because too many concurrent updates were attempted
* against the in-memory datastore.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_INMEMORY_TOO_MANY_CONCURRENT_UPDATES",
* "domain": "authzed.com",
* "metadata": {}
* }
*
* @generated from protobuf enum value: ERROR_REASON_INMEMORY_TOO_MANY_CONCURRENT_UPDATES = 24;
*/
ErrorReason[ErrorReason["INMEMORY_TOO_MANY_CONCURRENT_UPDATES"] = 24] = "INMEMORY_TOO_MANY_CONCURRENT_UPDATES";
/**
* The request failed because the precondition specified is empty.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_EMPTY_PRECONDITION",
* "domain": "authzed.com",
* "metadata": {}
* }
*
* @generated from protobuf enum value: ERROR_REASON_EMPTY_PRECONDITION = 25;
*/
ErrorReason[ErrorReason["EMPTY_PRECONDITION"] = 25] = "EMPTY_PRECONDITION";
/**
* The request failed because the counter was already registered.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_COUNTER_ALREADY_REGISTERED",
* "domain": "authzed.com",
* "metadata": { "counter_name": "name" }
* }
*
* @generated from protobuf enum value: ERROR_REASON_COUNTER_ALREADY_REGISTERED = 26;
*/
ErrorReason[ErrorReason["COUNTER_ALREADY_REGISTERED"] = 26] = "COUNTER_ALREADY_REGISTERED";
/**
* The request failed because the counter was not registered.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_COUNTER_NOT_REGISTERED",
* "domain": "authzed.com",
* "metadata": { "counter_name": "name" }
* }
*
* @generated from protobuf enum value: ERROR_REASON_COUNTER_NOT_REGISTERED = 27;
*/
ErrorReason[ErrorReason["COUNTER_NOT_REGISTERED"] = 27] = "COUNTER_NOT_REGISTERED";
/**
* The request failed because a wildcard was not allowed. For CheckPermission,
* this means that the subject or resource ID was a wildcard. For LookupResources,
* this means that the subject ID was a wildcard.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_WILDCARD_NOT_ALLOWED",
* "domain": "authzed.com",
* "metadata": { "disallowed_field": "subject_id" }
* }
*
* @generated from protobuf enum value: ERROR_REASON_WILDCARD_NOT_ALLOWED = 28;
*/
ErrorReason[ErrorReason["WILDCARD_NOT_ALLOWED"] = 28] = "WILDCARD_NOT_ALLOWED";
/**
* The request failed because the transaction metadata was too large.
*
* Example of an ErrorInfo:
*
* {
* "reason": "ERROR_REASON_TRANSACTION_METADATA_TOO_LARGE",
* "domain": "authzed.com",
* "metadata": {
* "metadata_byte_size": "1024",
* "maximum_allowed_metadata_byte_size": "512",
* }
* }
*
* @generated from protobuf enum value: ERROR_REASON_TRANSACTION_METADATA_TOO_LARGE = 29;
*/
ErrorReason[ErrorReason["TRANSACTION_METADATA_TOO_LARGE"] = 29] = "TRANSACTION_METADATA_TOO_LARGE";
})(ErrorReason || (ErrorReason = {}));
//# sourceMappingURL=error_reason.js.map