Package com.authzed.api.v1

Class CheckPermissionRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.authzed.api.v1.CheckPermissionRequest
All Implemented Interfaces:
CheckPermissionRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class CheckPermissionRequest extends com.google.protobuf.GeneratedMessage implements CheckPermissionRequestOrBuilder
 CheckPermissionRequest issues a check on whether a subject has a permission
 or is a member of a relation, on a specific resource.
Protobuf type authzed.api.v1.CheckPermissionRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CheckPermissionRequest.Builder
    CheckPermissionRequest issues a check on whether a subject has a permission or is a member of a relation, on a specific resource.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CONSISTENCY_FIELD_NUMBER
     
    static final int
    CONTEXT_FIELD_NUMBER
     
    static final int
    PERMISSION_FIELD_NUMBER
     
    static final int
    RESOURCE_FIELD_NUMBER
     
    static final int
    SUBJECT_FIELD_NUMBER
     
    static final int
    WITH_TRACING_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    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
    static CheckPermissionRequest
    getDefaultInstance()
     
    CheckPermissionRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<CheckPermissionRequest>
    getParserForType()
     
    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.
    int
    getSerializedSize()
     
    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
    int
    hashCode()
     
    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.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static CheckPermissionRequest.Builder
    newBuilder()
     
    static CheckPermissionRequest.Builder
    newBuilder(CheckPermissionRequest prototype)
     
    CheckPermissionRequest.Builder
    newBuilderForType()
     
    protected CheckPermissionRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static CheckPermissionRequest
    parseDelimitedFrom(InputStream input)
     
    static CheckPermissionRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CheckPermissionRequest
    parseFrom(byte[] data)
     
    static CheckPermissionRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CheckPermissionRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static CheckPermissionRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CheckPermissionRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static CheckPermissionRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CheckPermissionRequest
    parseFrom(InputStream input)
     
    static CheckPermissionRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CheckPermissionRequest
    parseFrom(ByteBuffer data)
     
    static CheckPermissionRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<CheckPermissionRequest>
    parser()
     
    CheckPermissionRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasConsistency

      public boolean hasConsistency()
      .authzed.api.v1.Consistency consistency = 1;
      Specified by:
      hasConsistency in interface CheckPermissionRequestOrBuilder
      Returns:
      Whether the consistency field is set.

    • getConsistency

      public Consistency getConsistency()
      .authzed.api.v1.Consistency consistency = 1;
      Specified by:
      getConsistency in interface CheckPermissionRequestOrBuilder
      Returns:
      The consistency.

    • getConsistencyOrBuilder

      public ConsistencyOrBuilder getConsistencyOrBuilder()
      .authzed.api.v1.Consistency consistency = 1;
      Specified by:
      getConsistencyOrBuilder in interface CheckPermissionRequestOrBuilder

    • hasResource

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

    • getResource

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

    • getResourceOrBuilder

      public ObjectReferenceOrBuilder getResourceOrBuilder()
       resource is the resource on which to check the permission or relation.
      .authzed.api.v1.ObjectReference resource = 2 [(.validate.rules) = { ... }
      Specified by:
      getResourceOrBuilder in interface CheckPermissionRequestOrBuilder

    • getPermission

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

    • getPermissionBytes

      public 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) = { ... }
      Specified by:
      getPermissionBytes in interface CheckPermissionRequestOrBuilder
      Returns:
      The bytes for permission.

    • hasSubject

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

    • getSubject

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

    • getSubjectOrBuilder

      public SubjectReferenceOrBuilder getSubjectOrBuilder()
       subject is the subject that will be checked for the permission or relation.
      .authzed.api.v1.SubjectReference subject = 4 [(.validate.rules) = { ... }
      Specified by:
      getSubjectOrBuilder in interface CheckPermissionRequestOrBuilder

    • hasContext

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

    • getContext

      public 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) = { ... }
      Specified by:
      getContext in interface CheckPermissionRequestOrBuilder
      Returns:
      The context.

    • getContextOrBuilder

      public 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) = { ... }
      Specified by:
      getContextOrBuilder in interface CheckPermissionRequestOrBuilder

    • getWithTracing

      public 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;
      Specified by:
      getWithTracing in interface CheckPermissionRequestOrBuilder
      Returns:
      The withTracing.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static CheckPermissionRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CheckPermissionRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CheckPermissionRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CheckPermissionRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CheckPermissionRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CheckPermissionRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CheckPermissionRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CheckPermissionRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CheckPermissionRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CheckPermissionRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CheckPermissionRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CheckPermissionRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public CheckPermissionRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static CheckPermissionRequest.Builder newBuilder()

    • newBuilder

      public static CheckPermissionRequest.Builder newBuilder(CheckPermissionRequest prototype)

    • toBuilder

      public CheckPermissionRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected CheckPermissionRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static CheckPermissionRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<CheckPermissionRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<CheckPermissionRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public CheckPermissionRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder