Package com.authzed.api.v1

Interface CheckPermissionRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    Consistency
    getConsistency()
    .authzed.api.v1.Consistency consistency = 1;
    ConsistencyOrBuilder
    getConsistencyOrBuilder()
    .authzed.api.v1.Consistency consistency = 1;
    com.google.protobuf.Struct
    getContext()
    context consists of named values that are injected into the caveat evaluation context
    com.google.protobuf.StructOrBuilder
    getContextOrBuilder()
    context consists of named values that are injected into the caveat evaluation context
    String
    getPermission()
    permission is the name of the permission (or relation) on which to execute the check.
    com.google.protobuf.ByteString
    getPermissionBytes()
    permission is the name of the permission (or relation) on which to execute the check.
    ObjectReference
    getResource()
    resource is the resource on which to check the permission or relation.
    ObjectReferenceOrBuilder
    getResourceOrBuilder()
    resource is the resource on which to check the permission or relation.
    SubjectReference
    getSubject()
    subject is the subject that will be checked for the permission or relation.
    SubjectReferenceOrBuilder
    getSubjectOrBuilder()
    subject is the subject that will be checked for the permission or relation.
    boolean
    getWithTracing()
    with_tracing, if true, indicates that the response should include a debug trace.
    boolean
    hasConsistency()
    .authzed.api.v1.Consistency consistency = 1;
    boolean
    hasContext()
    context consists of named values that are injected into the caveat evaluation context
    boolean
    hasResource()
    resource is the resource on which to check the permission or relation.
    boolean
    hasSubject()
    subject is the subject that will be checked for the permission or relation.

    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

    • hasConsistency

      boolean hasConsistency()
      .authzed.api.v1.Consistency consistency = 1;
      Returns:
      Whether the consistency field is set.

    • getConsistency

      Consistency getConsistency()
      .authzed.api.v1.Consistency consistency = 1;
      Returns:
      The consistency.

    • getConsistencyOrBuilder

      ConsistencyOrBuilder getConsistencyOrBuilder()
      .authzed.api.v1.Consistency consistency = 1;

    • hasResource

      boolean hasResource()
       resource is the resource on which to check the permission or relation.
      .authzed.api.v1.ObjectReference resource = 2 [(.validate.rules) = { ... }
      Returns:
      Whether the resource field is set.

    • getResource

      ObjectReference getResource()
       resource is the resource on which to check the permission or relation.
      .authzed.api.v1.ObjectReference resource = 2 [(.validate.rules) = { ... }
      Returns:
      The resource.

    • getResourceOrBuilder

      ObjectReferenceOrBuilder getResourceOrBuilder()
       resource is the resource on which to check the permission or relation.
      .authzed.api.v1.ObjectReference resource = 2 [(.validate.rules) = { ... }

    • getPermission

      String getPermission()
       permission is the name of the permission (or relation) on which to execute
 the check.
      string permission = 3 [(.validate.rules) = { ... }
      Returns:
      The permission.

    • getPermissionBytes

      com.google.protobuf.ByteString getPermissionBytes()
       permission is the name of the permission (or relation) on which to execute
 the check.
      string permission = 3 [(.validate.rules) = { ... }
      Returns:
      The bytes for permission.

    • hasSubject

      boolean hasSubject()
       subject is the subject that will be checked for the permission or relation.
      .authzed.api.v1.SubjectReference subject = 4 [(.validate.rules) = { ... }
      Returns:
      Whether the subject field is set.

    • getSubject

      SubjectReference getSubject()
       subject is the subject that will be checked for the permission or relation.
      .authzed.api.v1.SubjectReference subject = 4 [(.validate.rules) = { ... }
      Returns:
      The subject.

    • getSubjectOrBuilder

      SubjectReferenceOrBuilder getSubjectOrBuilder()
       subject is the subject that will be checked for the permission or relation.
      .authzed.api.v1.SubjectReference subject = 4 [(.validate.rules) = { ... }

    • hasContext

      boolean hasContext()
       context consists of named values that are injected into the caveat evaluation context
      .google.protobuf.Struct context = 5 [(.validate.rules) = { ... }
      Returns:
      Whether the context field is set.

    • getContext

      com.google.protobuf.Struct getContext()
       context consists of named values that are injected into the caveat evaluation context
      .google.protobuf.Struct context = 5 [(.validate.rules) = { ... }
      Returns:
      The context.

    • getContextOrBuilder

      com.google.protobuf.StructOrBuilder getContextOrBuilder()
       context consists of named values that are injected into the caveat evaluation context
      .google.protobuf.Struct context = 5 [(.validate.rules) = { ... }

    • getWithTracing

      boolean getWithTracing()
       with_tracing, if true, indicates that the response should include a debug trace.
 This can be useful for debugging and performance analysis, but adds a small amount
 of compute overhead to the request.
      bool with_tracing = 6;
      Returns:
      The withTracing.