Package com.authzed.api.v1

Enum Class ErrorReason

java.lang.Object
java.lang.Enum<ErrorReason>
com.authzed.api.v1.ErrorReason
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<ErrorReason>, Constable
public enum ErrorReason extends Enum<ErrorReason> implements com.google.protobuf.ProtocolMessageEnum
 Defines the supported values for `google.rpc.ErrorInfo.reason` for the
 `authzed.com` error domain.
Protobuf enum authzed.api.v1.ErrorReason

  • Enum Constant Details

    • ERROR_REASON_UNSPECIFIED

      public static final ErrorReason ERROR_REASON_UNSPECIFIED
       Do not use this default value.
      ERROR_REASON_UNSPECIFIED = 0;

    • ERROR_REASON_SCHEMA_PARSE_ERROR

      public static final ErrorReason ERROR_REASON_SCHEMA_PARSE_ERROR
       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.
      ERROR_REASON_SCHEMA_PARSE_ERROR = 1;

    • ERROR_REASON_SCHEMA_TYPE_ERROR

      public static final ErrorReason ERROR_REASON_SCHEMA_TYPE_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 ...
 }
 }
      ERROR_REASON_SCHEMA_TYPE_ERROR = 2;

    • ERROR_REASON_UNKNOWN_DEFINITION

      public static final ErrorReason ERROR_REASON_UNKNOWN_DEFINITION
       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"
 }
 }
      ERROR_REASON_UNKNOWN_DEFINITION = 3;

    • ERROR_REASON_UNKNOWN_RELATION_OR_PERMISSION

      public static final ErrorReason ERROR_REASON_UNKNOWN_RELATION_OR_PERMISSION
       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"
 }
 }
      ERROR_REASON_UNKNOWN_RELATION_OR_PERMISSION = 4;

    • ERROR_REASON_TOO_MANY_UPDATES_IN_REQUEST

      public static final ErrorReason ERROR_REASON_TOO_MANY_UPDATES_IN_REQUEST
       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",
 }
 }
      ERROR_REASON_TOO_MANY_UPDATES_IN_REQUEST = 5;

    • ERROR_REASON_TOO_MANY_PRECONDITIONS_IN_REQUEST

      public static final ErrorReason ERROR_REASON_TOO_MANY_PRECONDITIONS_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",
 }
 }
      ERROR_REASON_TOO_MANY_PRECONDITIONS_IN_REQUEST = 6;

    • ERROR_REASON_WRITE_OR_DELETE_PRECONDITION_FAILURE

      public static final ErrorReason ERROR_REASON_WRITE_OR_DELETE_PRECONDITION_FAILURE
       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",
 }
 }
      ERROR_REASON_WRITE_OR_DELETE_PRECONDITION_FAILURE = 7;

    • ERROR_REASON_SERVICE_READ_ONLY

      public static final ErrorReason ERROR_REASON_SERVICE_READ_ONLY
       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"
 }
      ERROR_REASON_SERVICE_READ_ONLY = 8;

    • ERROR_REASON_UNKNOWN_CAVEAT

      public static final ErrorReason ERROR_REASON_UNKNOWN_CAVEAT
       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"
 }
 }
      ERROR_REASON_UNKNOWN_CAVEAT = 9;

    • ERROR_REASON_INVALID_SUBJECT_TYPE

      public static final ErrorReason ERROR_REASON_INVALID_SUBJECT_TYPE
       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:*"
 }
 }
      ERROR_REASON_INVALID_SUBJECT_TYPE = 10;

    • ERROR_REASON_CAVEAT_PARAMETER_TYPE_ERROR

      public static final ErrorReason ERROR_REASON_CAVEAT_PARAMETER_TYPE_ERROR
       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",
 }
 }
      ERROR_REASON_CAVEAT_PARAMETER_TYPE_ERROR = 11;

    • ERROR_REASON_UPDATES_ON_SAME_RELATIONSHIP

      public static final ErrorReason ERROR_REASON_UPDATES_ON_SAME_RELATIONSHIP
       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",
 }
 }
      ERROR_REASON_UPDATES_ON_SAME_RELATIONSHIP = 12;

    • ERROR_REASON_CANNOT_UPDATE_PERMISSION

      public static final ErrorReason ERROR_REASON_CANNOT_UPDATE_PERMISSION
       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",
 }
 }
      ERROR_REASON_CANNOT_UPDATE_PERMISSION = 13;

    • ERROR_REASON_CAVEAT_EVALUATION_ERROR

      public static final ErrorReason ERROR_REASON_CAVEAT_EVALUATION_ERROR
       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",
 }
 }
      ERROR_REASON_CAVEAT_EVALUATION_ERROR = 14;

    • ERROR_REASON_INVALID_CURSOR

      public static final ErrorReason ERROR_REASON_INVALID_CURSOR
       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 ...
 }
 }
      ERROR_REASON_INVALID_CURSOR = 15;

    • ERROR_REASON_TOO_MANY_RELATIONSHIPS_FOR_TRANSACTIONAL_DELETE

      public static final ErrorReason ERROR_REASON_TOO_MANY_RELATIONSHIPS_FOR_TRANSACTIONAL_DELETE
       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 ...
 }
 }
      ERROR_REASON_TOO_MANY_RELATIONSHIPS_FOR_TRANSACTIONAL_DELETE = 16;

    • ERROR_REASON_MAX_RELATIONSHIP_CONTEXT_SIZE

      public static final ErrorReason ERROR_REASON_MAX_RELATIONSHIP_CONTEXT_SIZE
       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" ,
 }
 }
      ERROR_REASON_MAX_RELATIONSHIP_CONTEXT_SIZE = 17;

    • ERROR_REASON_ATTEMPT_TO_RECREATE_RELATIONSHIP

      public static final ErrorReason ERROR_REASON_ATTEMPT_TO_RECREATE_RELATIONSHIP
       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 ...
 }
 }
      ERROR_REASON_ATTEMPT_TO_RECREATE_RELATIONSHIP = 18;

    • ERROR_REASON_MAXIMUM_DEPTH_EXCEEDED

      public static final ErrorReason ERROR_REASON_MAXIMUM_DEPTH_EXCEEDED
       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 ...
 }
 }
      ERROR_REASON_MAXIMUM_DEPTH_EXCEEDED = 19;

    • ERROR_REASON_SERIALIZATION_FAILURE

      public static final ErrorReason ERROR_REASON_SERIALIZATION_FAILURE
       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": {}
 }
      ERROR_REASON_SERIALIZATION_FAILURE = 20;

    • ERROR_REASON_TOO_MANY_CHECKS_IN_REQUEST

      public static final ErrorReason ERROR_REASON_TOO_MANY_CHECKS_IN_REQUEST
       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",
 }
 }
      ERROR_REASON_TOO_MANY_CHECKS_IN_REQUEST = 21;

    • ERROR_REASON_EXCEEDS_MAXIMUM_ALLOWABLE_LIMIT

      public static final ErrorReason ERROR_REASON_EXCEEDS_MAXIMUM_ALLOWABLE_LIMIT
       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",
 }
 }
      ERROR_REASON_EXCEEDS_MAXIMUM_ALLOWABLE_LIMIT = 22;

    • ERROR_REASON_INVALID_FILTER

      public static final ErrorReason ERROR_REASON_INVALID_FILTER
       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": "...",
 }
 }
      ERROR_REASON_INVALID_FILTER = 23;

    • ERROR_REASON_INMEMORY_TOO_MANY_CONCURRENT_UPDATES

      public static final ErrorReason ERROR_REASON_INMEMORY_TOO_MANY_CONCURRENT_UPDATES
       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": {}
 }
      ERROR_REASON_INMEMORY_TOO_MANY_CONCURRENT_UPDATES = 24;

    • ERROR_REASON_EMPTY_PRECONDITION

      public static final ErrorReason ERROR_REASON_EMPTY_PRECONDITION
       The request failed because the precondition specified is empty.

 Example of an ErrorInfo:

 {  
 "reason": "ERROR_REASON_EMPTY_PRECONDITION",
 "domain": "authzed.com",
 "metadata": {}
 }
      ERROR_REASON_EMPTY_PRECONDITION = 25;

    • ERROR_REASON_COUNTER_ALREADY_REGISTERED

      public static final ErrorReason ERROR_REASON_COUNTER_ALREADY_REGISTERED
       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" }
 }
      ERROR_REASON_COUNTER_ALREADY_REGISTERED = 26;

    • ERROR_REASON_COUNTER_NOT_REGISTERED

      public static final ErrorReason ERROR_REASON_COUNTER_NOT_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"  }
 }
      ERROR_REASON_COUNTER_NOT_REGISTERED = 27;

    • ERROR_REASON_WILDCARD_NOT_ALLOWED

      public static final ErrorReason ERROR_REASON_WILDCARD_NOT_ALLOWED
       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" }
 }
      ERROR_REASON_WILDCARD_NOT_ALLOWED = 28;

    • ERROR_REASON_TRANSACTION_METADATA_TOO_LARGE

      public static final ErrorReason ERROR_REASON_TRANSACTION_METADATA_TOO_LARGE
       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",
 }
 }
      ERROR_REASON_TRANSACTION_METADATA_TOO_LARGE = 29;

    • UNRECOGNIZED

      public static final ErrorReason UNRECOGNIZED

  • Field Details

    • ERROR_REASON_UNSPECIFIED_VALUE

      public static final int ERROR_REASON_UNSPECIFIED_VALUE
       Do not use this default value.
      ERROR_REASON_UNSPECIFIED = 0;
      See Also:

    • ERROR_REASON_SCHEMA_PARSE_ERROR_VALUE

      public static final int ERROR_REASON_SCHEMA_PARSE_ERROR_VALUE
       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.
      ERROR_REASON_SCHEMA_PARSE_ERROR = 1;
      See Also:

    • ERROR_REASON_SCHEMA_TYPE_ERROR_VALUE

      public static final int ERROR_REASON_SCHEMA_TYPE_ERROR_VALUE
       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 ...
 }
 }
      ERROR_REASON_SCHEMA_TYPE_ERROR = 2;
      See Also:

    • ERROR_REASON_UNKNOWN_DEFINITION_VALUE

      public static final int ERROR_REASON_UNKNOWN_DEFINITION_VALUE
       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"
 }
 }
      ERROR_REASON_UNKNOWN_DEFINITION = 3;
      See Also:

    • ERROR_REASON_UNKNOWN_RELATION_OR_PERMISSION_VALUE

      public static final int ERROR_REASON_UNKNOWN_RELATION_OR_PERMISSION_VALUE
       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"
 }
 }
      ERROR_REASON_UNKNOWN_RELATION_OR_PERMISSION = 4;
      See Also:

    • ERROR_REASON_TOO_MANY_UPDATES_IN_REQUEST_VALUE

      public static final int ERROR_REASON_TOO_MANY_UPDATES_IN_REQUEST_VALUE
       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",
 }
 }
      ERROR_REASON_TOO_MANY_UPDATES_IN_REQUEST = 5;
      See Also:

    • ERROR_REASON_TOO_MANY_PRECONDITIONS_IN_REQUEST_VALUE

      public static final int ERROR_REASON_TOO_MANY_PRECONDITIONS_IN_REQUEST_VALUE
       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",
 }
 }
      ERROR_REASON_TOO_MANY_PRECONDITIONS_IN_REQUEST = 6;
      See Also:

    • ERROR_REASON_WRITE_OR_DELETE_PRECONDITION_FAILURE_VALUE

      public static final int ERROR_REASON_WRITE_OR_DELETE_PRECONDITION_FAILURE_VALUE
       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",
 }
 }
      ERROR_REASON_WRITE_OR_DELETE_PRECONDITION_FAILURE = 7;
      See Also:

    • ERROR_REASON_SERVICE_READ_ONLY_VALUE

      public static final int ERROR_REASON_SERVICE_READ_ONLY_VALUE
       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"
 }
      ERROR_REASON_SERVICE_READ_ONLY = 8;
      See Also:

    • ERROR_REASON_UNKNOWN_CAVEAT_VALUE

      public static final int ERROR_REASON_UNKNOWN_CAVEAT_VALUE
       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"
 }
 }
      ERROR_REASON_UNKNOWN_CAVEAT = 9;
      See Also:

    • ERROR_REASON_INVALID_SUBJECT_TYPE_VALUE

      public static final int ERROR_REASON_INVALID_SUBJECT_TYPE_VALUE
       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:*"
 }
 }
      ERROR_REASON_INVALID_SUBJECT_TYPE = 10;
      See Also:

    • ERROR_REASON_CAVEAT_PARAMETER_TYPE_ERROR_VALUE

      public static final int ERROR_REASON_CAVEAT_PARAMETER_TYPE_ERROR_VALUE
       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",
 }
 }
      ERROR_REASON_CAVEAT_PARAMETER_TYPE_ERROR = 11;
      See Also:

    • ERROR_REASON_UPDATES_ON_SAME_RELATIONSHIP_VALUE

      public static final int ERROR_REASON_UPDATES_ON_SAME_RELATIONSHIP_VALUE
       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",
 }
 }
      ERROR_REASON_UPDATES_ON_SAME_RELATIONSHIP = 12;
      See Also:

    • ERROR_REASON_CANNOT_UPDATE_PERMISSION_VALUE

      public static final int ERROR_REASON_CANNOT_UPDATE_PERMISSION_VALUE
       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",
 }
 }
      ERROR_REASON_CANNOT_UPDATE_PERMISSION = 13;
      See Also:

    • ERROR_REASON_CAVEAT_EVALUATION_ERROR_VALUE

      public static final int ERROR_REASON_CAVEAT_EVALUATION_ERROR_VALUE
       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",
 }
 }
      ERROR_REASON_CAVEAT_EVALUATION_ERROR = 14;
      See Also:

    • ERROR_REASON_INVALID_CURSOR_VALUE

      public static final int ERROR_REASON_INVALID_CURSOR_VALUE
       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 ...
 }
 }
      ERROR_REASON_INVALID_CURSOR = 15;
      See Also:

    • ERROR_REASON_TOO_MANY_RELATIONSHIPS_FOR_TRANSACTIONAL_DELETE_VALUE

      public static final int ERROR_REASON_TOO_MANY_RELATIONSHIPS_FOR_TRANSACTIONAL_DELETE_VALUE
       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 ...
 }
 }
      ERROR_REASON_TOO_MANY_RELATIONSHIPS_FOR_TRANSACTIONAL_DELETE = 16;
      See Also:

    • ERROR_REASON_MAX_RELATIONSHIP_CONTEXT_SIZE_VALUE

      public static final int ERROR_REASON_MAX_RELATIONSHIP_CONTEXT_SIZE_VALUE
       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" ,
 }
 }
      ERROR_REASON_MAX_RELATIONSHIP_CONTEXT_SIZE = 17;
      See Also:

    • ERROR_REASON_ATTEMPT_TO_RECREATE_RELATIONSHIP_VALUE

      public static final int ERROR_REASON_ATTEMPT_TO_RECREATE_RELATIONSHIP_VALUE
       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 ...
 }
 }
      ERROR_REASON_ATTEMPT_TO_RECREATE_RELATIONSHIP = 18;
      See Also:

    • ERROR_REASON_MAXIMUM_DEPTH_EXCEEDED_VALUE

      public static final int ERROR_REASON_MAXIMUM_DEPTH_EXCEEDED_VALUE
       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 ...
 }
 }
      ERROR_REASON_MAXIMUM_DEPTH_EXCEEDED = 19;
      See Also:

    • ERROR_REASON_SERIALIZATION_FAILURE_VALUE

      public static final int ERROR_REASON_SERIALIZATION_FAILURE_VALUE
       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": {}
 }
      ERROR_REASON_SERIALIZATION_FAILURE = 20;
      See Also:

    • ERROR_REASON_TOO_MANY_CHECKS_IN_REQUEST_VALUE

      public static final int ERROR_REASON_TOO_MANY_CHECKS_IN_REQUEST_VALUE
       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",
 }
 }
      ERROR_REASON_TOO_MANY_CHECKS_IN_REQUEST = 21;
      See Also:

    • ERROR_REASON_EXCEEDS_MAXIMUM_ALLOWABLE_LIMIT_VALUE

      public static final int ERROR_REASON_EXCEEDS_MAXIMUM_ALLOWABLE_LIMIT_VALUE
       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",
 }
 }
      ERROR_REASON_EXCEEDS_MAXIMUM_ALLOWABLE_LIMIT = 22;
      See Also:

    • ERROR_REASON_INVALID_FILTER_VALUE

      public static final int ERROR_REASON_INVALID_FILTER_VALUE
       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": "...",
 }
 }
      ERROR_REASON_INVALID_FILTER = 23;
      See Also:

    • ERROR_REASON_INMEMORY_TOO_MANY_CONCURRENT_UPDATES_VALUE

      public static final int ERROR_REASON_INMEMORY_TOO_MANY_CONCURRENT_UPDATES_VALUE
       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": {}
 }
      ERROR_REASON_INMEMORY_TOO_MANY_CONCURRENT_UPDATES = 24;
      See Also:

    • ERROR_REASON_EMPTY_PRECONDITION_VALUE

      public static final int ERROR_REASON_EMPTY_PRECONDITION_VALUE
       The request failed because the precondition specified is empty.

 Example of an ErrorInfo:

 {  
 "reason": "ERROR_REASON_EMPTY_PRECONDITION",
 "domain": "authzed.com",
 "metadata": {}
 }
      ERROR_REASON_EMPTY_PRECONDITION = 25;
      See Also:

    • ERROR_REASON_COUNTER_ALREADY_REGISTERED_VALUE

      public static final int ERROR_REASON_COUNTER_ALREADY_REGISTERED_VALUE
       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" }
 }
      ERROR_REASON_COUNTER_ALREADY_REGISTERED = 26;
      See Also:

    • ERROR_REASON_COUNTER_NOT_REGISTERED_VALUE

      public static final int ERROR_REASON_COUNTER_NOT_REGISTERED_VALUE
       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"  }
 }
      ERROR_REASON_COUNTER_NOT_REGISTERED = 27;
      See Also:

    • ERROR_REASON_WILDCARD_NOT_ALLOWED_VALUE

      public static final int ERROR_REASON_WILDCARD_NOT_ALLOWED_VALUE
       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" }
 }
      ERROR_REASON_WILDCARD_NOT_ALLOWED = 28;
      See Also:

    • ERROR_REASON_TRANSACTION_METADATA_TOO_LARGE_VALUE

      public static final int ERROR_REASON_TRANSACTION_METADATA_TOO_LARGE_VALUE
       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",
 }
 }
      ERROR_REASON_TRANSACTION_METADATA_TOO_LARGE = 29;
      See Also:

  • Method Details

    • values

      public static ErrorReason[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ErrorReason valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static ErrorReason valueOf(int value)
      Deprecated.
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static ErrorReason forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<ErrorReason> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static ErrorReason valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null