Package com.authzed.api.v1

Interface CheckDebugTraceOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CheckDebugTrace, CheckDebugTrace.Builder
public interface CheckDebugTraceOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    CaveatEvalInfo
    getCaveatEvaluationInfo()
    caveat_evaluation_info holds information about the caveat evaluated for this step of the trace.
    CaveatEvalInfoOrBuilder
    getCaveatEvaluationInfoOrBuilder()
    caveat_evaluation_info holds information about the caveat evaluated for this step of the trace.
    com.google.protobuf.Duration
    getDuration()
    duration holds the time spent executing this Check operation.
    com.google.protobuf.DurationOrBuilder
    getDurationOrBuilder()
    duration holds the time spent executing this Check operation.
    com.google.protobuf.Timestamp
    getOptionalExpiresAt()
    optional_expires_at is the time at which at least one of the relationships used to compute this result, expires (if any).
    com.google.protobuf.TimestampOrBuilder
    getOptionalExpiresAtOrBuilder()
    optional_expires_at is the time at which at least one of the relationships used to compute this result, expires (if any).
    String
    getPermission()
    permission holds the name of the permission or relation on which the Check was performed.
    com.google.protobuf.ByteString
    getPermissionBytes()
    permission holds the name of the permission or relation on which the Check was performed.
    CheckDebugTrace.PermissionType
    getPermissionType()
    permission_type holds information indicating whether it was a permission or relation.
    int
    getPermissionTypeValue()
    permission_type holds information indicating whether it was a permission or relation.
    CheckDebugTrace.ResolutionCase
    getResolutionCase()
     
    ObjectReference
    getResource()
    resource holds the resource on which the Check was performed.
    ObjectReferenceOrBuilder
    getResourceOrBuilder()
    resource holds the resource on which the Check was performed.
    CheckDebugTrace.Permissionship
    getResult()
    result holds the result of the Check call.
    int
    getResultValue()
    result holds the result of the Check call.
    String
    getSource()
    source holds the source of the result.
    com.google.protobuf.ByteString
    getSourceBytes()
    source holds the source of the result.
    SubjectReference
    getSubject()
    subject holds the subject on which the Check was performed.
    SubjectReferenceOrBuilder
    getSubjectOrBuilder()
    subject holds the subject on which the Check was performed.
    CheckDebugTrace.SubProblems
    getSubProblems()
    sub_problems holds the sub problems that were executed to resolve the answer to this Check.
    CheckDebugTrace.SubProblemsOrBuilder
    getSubProblemsOrBuilder()
    sub_problems holds the sub problems that were executed to resolve the answer to this Check.
    String
    getTraceOperationId()
    trace_operation_id is a unique identifier for this trace's operation, that will be shared for all traces created for the same check operation in SpiceDB.
    com.google.protobuf.ByteString
    getTraceOperationIdBytes()
    trace_operation_id is a unique identifier for this trace's operation, that will be shared for all traces created for the same check operation in SpiceDB.
    boolean
    getWasCachedResult()
    was_cached_result, if true, indicates that the result was found in the cache and returned directly.
    boolean
    hasCaveatEvaluationInfo()
    caveat_evaluation_info holds information about the caveat evaluated for this step of the trace.
    boolean
    hasDuration()
    duration holds the time spent executing this Check operation.
    boolean
    hasOptionalExpiresAt()
    optional_expires_at is the time at which at least one of the relationships used to compute this result, expires (if any).
    boolean
    hasResource()
    resource holds the resource on which the Check was performed.
    boolean
    hasSubject()
    subject holds the subject on which the Check was performed.
    boolean
    hasSubProblems()
    sub_problems holds the sub problems that were executed to resolve the answer to this Check.
    boolean
    hasWasCachedResult()
    was_cached_result, if true, indicates that the result was found in the cache and returned directly.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasResource

      boolean hasResource()
       resource holds the resource on which the Check was performed.
 for batched calls, the object_id field contains a comma-separated list of object IDs
 for all the resources checked in the batch.
      .authzed.api.v1.ObjectReference resource = 1 [(.validate.rules) = { ... }
      Returns:
      Whether the resource field is set.

    • getResource

      ObjectReference getResource()
       resource holds the resource on which the Check was performed.
 for batched calls, the object_id field contains a comma-separated list of object IDs
 for all the resources checked in the batch.
      .authzed.api.v1.ObjectReference resource = 1 [(.validate.rules) = { ... }
      Returns:
      The resource.

    • getResourceOrBuilder

      ObjectReferenceOrBuilder getResourceOrBuilder()
       resource holds the resource on which the Check was performed.
 for batched calls, the object_id field contains a comma-separated list of object IDs
 for all the resources checked in the batch.
      .authzed.api.v1.ObjectReference resource = 1 [(.validate.rules) = { ... }

    • getPermission

      String getPermission()
       permission holds the name of the permission or relation on which the Check was performed.
      string permission = 2;
      Returns:
      The permission.

    • getPermissionBytes

      com.google.protobuf.ByteString getPermissionBytes()
       permission holds the name of the permission or relation on which the Check was performed.
      string permission = 2;
      Returns:
      The bytes for permission.

    • getPermissionTypeValue

      int getPermissionTypeValue()
       permission_type holds information indicating whether it was a permission or relation.
      .authzed.api.v1.CheckDebugTrace.PermissionType permission_type = 3 [(.validate.rules) = { ... }
      Returns:
      The enum numeric value on the wire for permissionType.

    • getPermissionType

      CheckDebugTrace.PermissionType getPermissionType()
       permission_type holds information indicating whether it was a permission or relation.
      .authzed.api.v1.CheckDebugTrace.PermissionType permission_type = 3 [(.validate.rules) = { ... }
      Returns:
      The permissionType.

    • hasSubject

      boolean hasSubject()
       subject holds the subject on which the Check was performed. This will be static across all calls within
 the same Check tree.
      .authzed.api.v1.SubjectReference subject = 4 [(.validate.rules) = { ... }
      Returns:
      Whether the subject field is set.

    • getSubject

      SubjectReference getSubject()
       subject holds the subject on which the Check was performed. This will be static across all calls within
 the same Check tree.
      .authzed.api.v1.SubjectReference subject = 4 [(.validate.rules) = { ... }
      Returns:
      The subject.

    • getSubjectOrBuilder

      SubjectReferenceOrBuilder getSubjectOrBuilder()
       subject holds the subject on which the Check was performed. This will be static across all calls within
 the same Check tree.
      .authzed.api.v1.SubjectReference subject = 4 [(.validate.rules) = { ... }

    • getResultValue

      int getResultValue()
       result holds the result of the Check call.
      .authzed.api.v1.CheckDebugTrace.Permissionship result = 5 [(.validate.rules) = { ... }
      Returns:
      The enum numeric value on the wire for result.

    • getResult

      CheckDebugTrace.Permissionship getResult()
       result holds the result of the Check call.
      .authzed.api.v1.CheckDebugTrace.Permissionship result = 5 [(.validate.rules) = { ... }
      Returns:
      The result.

    • hasCaveatEvaluationInfo

      boolean hasCaveatEvaluationInfo()
       caveat_evaluation_info holds information about the caveat evaluated for this step of the trace.
      .authzed.api.v1.CaveatEvalInfo caveat_evaluation_info = 8;
      Returns:
      Whether the caveatEvaluationInfo field is set.

    • getCaveatEvaluationInfo

      CaveatEvalInfo getCaveatEvaluationInfo()
       caveat_evaluation_info holds information about the caveat evaluated for this step of the trace.
      .authzed.api.v1.CaveatEvalInfo caveat_evaluation_info = 8;
      Returns:
      The caveatEvaluationInfo.

    • getCaveatEvaluationInfoOrBuilder

      CaveatEvalInfoOrBuilder getCaveatEvaluationInfoOrBuilder()
       caveat_evaluation_info holds information about the caveat evaluated for this step of the trace.
      .authzed.api.v1.CaveatEvalInfo caveat_evaluation_info = 8;

    • hasDuration

      boolean hasDuration()
       duration holds the time spent executing this Check operation.
      .google.protobuf.Duration duration = 9;
      Returns:
      Whether the duration field is set.

    • getDuration

      com.google.protobuf.Duration getDuration()
       duration holds the time spent executing this Check operation.
      .google.protobuf.Duration duration = 9;
      Returns:
      The duration.

    • getDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getDurationOrBuilder()
       duration holds the time spent executing this Check operation.
      .google.protobuf.Duration duration = 9;

    • hasWasCachedResult

      boolean hasWasCachedResult()
       was_cached_result, if true, indicates that the result was found in the cache and returned directly.
      bool was_cached_result = 6;
      Returns:
      Whether the wasCachedResult field is set.

    • getWasCachedResult

      boolean getWasCachedResult()
       was_cached_result, if true, indicates that the result was found in the cache and returned directly.
      bool was_cached_result = 6;
      Returns:
      The wasCachedResult.

    • hasSubProblems

      boolean hasSubProblems()
       sub_problems holds the sub problems that were executed to resolve the answer to this Check. An empty list
 and a permissionship of PERMISSIONSHIP_HAS_PERMISSION indicates the subject was found within this relation.
      .authzed.api.v1.CheckDebugTrace.SubProblems sub_problems = 7;
      Returns:
      Whether the subProblems field is set.

    • getSubProblems

      CheckDebugTrace.SubProblems getSubProblems()
       sub_problems holds the sub problems that were executed to resolve the answer to this Check. An empty list
 and a permissionship of PERMISSIONSHIP_HAS_PERMISSION indicates the subject was found within this relation.
      .authzed.api.v1.CheckDebugTrace.SubProblems sub_problems = 7;
      Returns:
      The subProblems.

    • getSubProblemsOrBuilder

      CheckDebugTrace.SubProblemsOrBuilder getSubProblemsOrBuilder()
       sub_problems holds the sub problems that were executed to resolve the answer to this Check. An empty list
 and a permissionship of PERMISSIONSHIP_HAS_PERMISSION indicates the subject was found within this relation.
      .authzed.api.v1.CheckDebugTrace.SubProblems sub_problems = 7;

    • hasOptionalExpiresAt

      boolean hasOptionalExpiresAt()
       optional_expires_at is the time at which at least one of the relationships used to
 compute this result, expires (if any). This is *not* related to the caching window.
      .google.protobuf.Timestamp optional_expires_at = 10;
      Returns:
      Whether the optionalExpiresAt field is set.

    • getOptionalExpiresAt

      com.google.protobuf.Timestamp getOptionalExpiresAt()
       optional_expires_at is the time at which at least one of the relationships used to
 compute this result, expires (if any). This is *not* related to the caching window.
      .google.protobuf.Timestamp optional_expires_at = 10;
      Returns:
      The optionalExpiresAt.

    • getOptionalExpiresAtOrBuilder

      com.google.protobuf.TimestampOrBuilder getOptionalExpiresAtOrBuilder()
       optional_expires_at is the time at which at least one of the relationships used to
 compute this result, expires (if any). This is *not* related to the caching window.
      .google.protobuf.Timestamp optional_expires_at = 10;

    • getTraceOperationId

      String getTraceOperationId()
       trace_operation_id is a unique identifier for this trace's operation, that will
 be shared for all traces created for the same check operation in SpiceDB.

 In cases where SpiceDB performs automatic batching of subproblems, this ID can be used
 to correlate work that was shared across multiple traces.

 This identifier is generated by SpiceDB, is to be considered opaque to the caller
 and only guaranteed to be unique within the same overall Check or CheckBulk operation.
      string trace_operation_id = 11;
      Returns:
      The traceOperationId.

    • getTraceOperationIdBytes

      com.google.protobuf.ByteString getTraceOperationIdBytes()
       trace_operation_id is a unique identifier for this trace's operation, that will
 be shared for all traces created for the same check operation in SpiceDB.

 In cases where SpiceDB performs automatic batching of subproblems, this ID can be used
 to correlate work that was shared across multiple traces.

 This identifier is generated by SpiceDB, is to be considered opaque to the caller
 and only guaranteed to be unique within the same overall Check or CheckBulk operation.
      string trace_operation_id = 11;
      Returns:
      The bytes for traceOperationId.

    • getSource

      String getSource()
       source holds the source of the result. It is of the form:
 `<sourcetype>:<sourceid>`, where sourcetype can be, among others:
 `spicedb`, `materialize`, etc.
      string source = 12;
      Returns:
      The source.

    • getSourceBytes

      com.google.protobuf.ByteString getSourceBytes()
       source holds the source of the result. It is of the form:
 `<sourcetype>:<sourceid>`, where sourcetype can be, among others:
 `spicedb`, `materialize`, etc.
      string source = 12;
      Returns:
      The bytes for source.

    • getResolutionCase

      CheckDebugTrace.ResolutionCase getResolutionCase()