Package com.authzed.api.v1

Class LookupResourcesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.authzed.api.v1.LookupResourcesRequest
All Implemented Interfaces:
LookupResourcesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class LookupResourcesRequest extends com.google.protobuf.GeneratedMessage implements LookupResourcesRequestOrBuilder
 LookupResourcesRequest performs a lookup of all resources of a particular
 kind on which the subject has the specified permission or the relation in
 which the subject exists, streaming back the IDs of those resources.
Protobuf type authzed.api.v1.LookupResourcesRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    LookupResourcesRequest.Builder
    LookupResourcesRequest performs a lookup of all resources of a particular kind on which the subject has the specified permission or the relation in which the subject exists, streaming back the IDs of those resources.

    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
    OPTIONAL_CURSOR_FIELD_NUMBER
     
    static final int
    OPTIONAL_LIMIT_FIELD_NUMBER
     
    static final int
    PERMISSION_FIELD_NUMBER
     
    static final int
    RESOURCE_OBJECT_TYPE_FIELD_NUMBER
     
    static final int
    SUBJECT_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 LookupResourcesRequest
    getDefaultInstance()
     
    LookupResourcesRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Cursor
    getOptionalCursor()
    optional_cursor, if specified, indicates the cursor after which results should resume being returned.
    CursorOrBuilder
    getOptionalCursorOrBuilder()
    optional_cursor, if specified, indicates the cursor after which results should resume being returned.
    int
    getOptionalLimit()
    optional_limit, if non-zero, specifies the limit on the number of resources to return before the stream is closed on the server side.
    com.google.protobuf.Parser<LookupResourcesRequest>
    getParserForType()
     
    String
    getPermission()
    permission is the name of the permission or relation for which the subject must Check.
    com.google.protobuf.ByteString
    getPermissionBytes()
    permission is the name of the permission or relation for which the subject must Check.
    String
    getResourceObjectType()
    resource_object_type is the type of resource object for which the IDs will be returned.
    com.google.protobuf.ByteString
    getResourceObjectTypeBytes()
    resource_object_type is the type of resource object for which the IDs will be returned.
    int
    getSerializedSize()
     
    SubjectReference
    getSubject()
    subject is the subject with access to the resources.
    SubjectReferenceOrBuilder
    getSubjectOrBuilder()
    subject is the subject with access to the resources.
    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
    hasOptionalCursor()
    optional_cursor, if specified, indicates the cursor after which results should resume being returned.
    boolean
    hasSubject()
    subject is the subject with access to the resources.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static LookupResourcesRequest.Builder
    newBuilder()
     
    static LookupResourcesRequest.Builder
    newBuilder(LookupResourcesRequest prototype)
     
    LookupResourcesRequest.Builder
    newBuilderForType()
     
    protected LookupResourcesRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static LookupResourcesRequest
    parseDelimitedFrom(InputStream input)
     
    static LookupResourcesRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LookupResourcesRequest
    parseFrom(byte[] data)
     
    static LookupResourcesRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LookupResourcesRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static LookupResourcesRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LookupResourcesRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static LookupResourcesRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LookupResourcesRequest
    parseFrom(InputStream input)
     
    static LookupResourcesRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LookupResourcesRequest
    parseFrom(ByteBuffer data)
     
    static LookupResourcesRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<LookupResourcesRequest>
    parser()
     
    LookupResourcesRequest.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

    • CONSISTENCY_FIELD_NUMBER

      public static final int CONSISTENCY_FIELD_NUMBER
      See Also:

    • RESOURCE_OBJECT_TYPE_FIELD_NUMBER

      public static final int RESOURCE_OBJECT_TYPE_FIELD_NUMBER
      See Also:

    • PERMISSION_FIELD_NUMBER

      public static final int PERMISSION_FIELD_NUMBER
      See Also:

    • SUBJECT_FIELD_NUMBER

      public static final int SUBJECT_FIELD_NUMBER
      See Also:

    • CONTEXT_FIELD_NUMBER

      public static final int CONTEXT_FIELD_NUMBER
      See Also:

    • OPTIONAL_LIMIT_FIELD_NUMBER

      public static final int OPTIONAL_LIMIT_FIELD_NUMBER
      See Also:

    • OPTIONAL_CURSOR_FIELD_NUMBER

      public static final int OPTIONAL_CURSOR_FIELD_NUMBER
      See Also:

  • 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 LookupResourcesRequestOrBuilder
      Returns:
      Whether the consistency field is set.

    • getConsistency

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

    • getConsistencyOrBuilder

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

    • getResourceObjectType

      public String getResourceObjectType()
       resource_object_type is the type of resource object for which the IDs will
 be returned.
      string resource_object_type = 2 [(.validate.rules) = { ... }
      Specified by:
      getResourceObjectType in interface LookupResourcesRequestOrBuilder
      Returns:
      The resourceObjectType.

    • getResourceObjectTypeBytes

      public com.google.protobuf.ByteString getResourceObjectTypeBytes()
       resource_object_type is the type of resource object for which the IDs will
 be returned.
      string resource_object_type = 2 [(.validate.rules) = { ... }
      Specified by:
      getResourceObjectTypeBytes in interface LookupResourcesRequestOrBuilder
      Returns:
      The bytes for resourceObjectType.

    • getPermission

      public String getPermission()
       permission is the name of the permission or relation for which the subject
 must Check.
      string permission = 3 [(.validate.rules) = { ... }
      Specified by:
      getPermission in interface LookupResourcesRequestOrBuilder
      Returns:
      The permission.

    • getPermissionBytes

      public com.google.protobuf.ByteString getPermissionBytes()
       permission is the name of the permission or relation for which the subject
 must Check.
      string permission = 3 [(.validate.rules) = { ... }
      Specified by:
      getPermissionBytes in interface LookupResourcesRequestOrBuilder
      Returns:
      The bytes for permission.

    • hasSubject

      public boolean hasSubject()
       subject is the subject with access to the resources.
      .authzed.api.v1.SubjectReference subject = 4 [(.validate.rules) = { ... }
      Specified by:
      hasSubject in interface LookupResourcesRequestOrBuilder
      Returns:
      Whether the subject field is set.

    • getSubject

      public SubjectReference getSubject()
       subject is the subject with access to the resources.
      .authzed.api.v1.SubjectReference subject = 4 [(.validate.rules) = { ... }
      Specified by:
      getSubject in interface LookupResourcesRequestOrBuilder
      Returns:
      The subject.

    • getSubjectOrBuilder

      public SubjectReferenceOrBuilder getSubjectOrBuilder()
       subject is the subject with access to the resources.
      .authzed.api.v1.SubjectReference subject = 4 [(.validate.rules) = { ... }
      Specified by:
      getSubjectOrBuilder in interface LookupResourcesRequestOrBuilder

    • 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 LookupResourcesRequestOrBuilder
      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 LookupResourcesRequestOrBuilder
      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 LookupResourcesRequestOrBuilder

    • getOptionalLimit

      public int getOptionalLimit()
       optional_limit, if non-zero, specifies the limit on the number of resources to return
 before the stream is closed on the server side. By default, the stream will continue
 resolving resources until exhausted or the stream is closed due to the client or a
 network issue.
      uint32 optional_limit = 6 [(.validate.rules) = { ... }
      Specified by:
      getOptionalLimit in interface LookupResourcesRequestOrBuilder
      Returns:
      The optionalLimit.

    • hasOptionalCursor

      public boolean hasOptionalCursor()
       optional_cursor, if specified, indicates the cursor after which results should resume being returned.
 The cursor can be found on the LookupResourcesResponse object.
      .authzed.api.v1.Cursor optional_cursor = 7;
      Specified by:
      hasOptionalCursor in interface LookupResourcesRequestOrBuilder
      Returns:
      Whether the optionalCursor field is set.

    • getOptionalCursor

      public Cursor getOptionalCursor()
       optional_cursor, if specified, indicates the cursor after which results should resume being returned.
 The cursor can be found on the LookupResourcesResponse object.
      .authzed.api.v1.Cursor optional_cursor = 7;
      Specified by:
      getOptionalCursor in interface LookupResourcesRequestOrBuilder
      Returns:
      The optionalCursor.

    • getOptionalCursorOrBuilder

      public CursorOrBuilder getOptionalCursorOrBuilder()
       optional_cursor, if specified, indicates the cursor after which results should resume being returned.
 The cursor can be found on the LookupResourcesResponse object.
      .authzed.api.v1.Cursor optional_cursor = 7;
      Specified by:
      getOptionalCursorOrBuilder in interface LookupResourcesRequestOrBuilder

    • 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 LookupResourcesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static LookupResourcesRequest.Builder newBuilder()

    • newBuilder

      public static LookupResourcesRequest.Builder newBuilder(LookupResourcesRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static LookupResourcesRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<LookupResourcesRequest> 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 LookupResourcesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder