Package com.authzed.api.v1

Class LookupSubjectsResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.authzed.api.v1.LookupSubjectsResponse
All Implemented Interfaces:
LookupSubjectsResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class LookupSubjectsResponse extends com.google.protobuf.GeneratedMessage implements LookupSubjectsResponseOrBuilder
 LookupSubjectsResponse contains a single matching subject object ID for the
 requested subject object type on the permission or relation.
Protobuf type authzed.api.v1.LookupSubjectsResponse
See Also:

  • Field Details

    • LOOKED_UP_AT_FIELD_NUMBER

      public static final int LOOKED_UP_AT_FIELD_NUMBER
      See Also:

    • SUBJECT_OBJECT_ID_FIELD_NUMBER

      public static final int SUBJECT_OBJECT_ID_FIELD_NUMBER
      See Also:

    • EXCLUDED_SUBJECT_IDS_FIELD_NUMBER

      public static final int EXCLUDED_SUBJECT_IDS_FIELD_NUMBER
      See Also:

    • PERMISSIONSHIP_FIELD_NUMBER

      public static final int PERMISSIONSHIP_FIELD_NUMBER
      See Also:

    • PARTIAL_CAVEAT_INFO_FIELD_NUMBER

      public static final int PARTIAL_CAVEAT_INFO_FIELD_NUMBER
      See Also:

    • SUBJECT_FIELD_NUMBER

      public static final int SUBJECT_FIELD_NUMBER
      See Also:

    • EXCLUDED_SUBJECTS_FIELD_NUMBER

      public static final int EXCLUDED_SUBJECTS_FIELD_NUMBER
      See Also:

    • AFTER_RESULT_CURSOR_FIELD_NUMBER

      public static final int AFTER_RESULT_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

    • hasLookedUpAt

      public boolean hasLookedUpAt()
      .authzed.api.v1.ZedToken looked_up_at = 1;
      Specified by:
      hasLookedUpAt in interface LookupSubjectsResponseOrBuilder
      Returns:
      Whether the lookedUpAt field is set.

    • getLookedUpAt

      public ZedToken getLookedUpAt()
      .authzed.api.v1.ZedToken looked_up_at = 1;
      Specified by:
      getLookedUpAt in interface LookupSubjectsResponseOrBuilder
      Returns:
      The lookedUpAt.

    • getLookedUpAtOrBuilder

      public ZedTokenOrBuilder getLookedUpAtOrBuilder()
      .authzed.api.v1.ZedToken looked_up_at = 1;
      Specified by:
      getLookedUpAtOrBuilder in interface LookupSubjectsResponseOrBuilder

    • getSubjectObjectId

      @Deprecated public String getSubjectObjectId()
      Deprecated.
      authzed.api.v1.LookupSubjectsResponse.subject_object_id is deprecated. See authzed/api/v1/permission_service.proto;l=615
       subject_object_id is the Object ID of the subject found. May be a `*` if
 a wildcard was found.
 deprecated: use `subject`
      string subject_object_id = 2 [deprecated = true];
      Specified by:
      getSubjectObjectId in interface LookupSubjectsResponseOrBuilder
      Returns:
      The subjectObjectId.

    • getSubjectObjectIdBytes

      @Deprecated public com.google.protobuf.ByteString getSubjectObjectIdBytes()
      Deprecated.
      authzed.api.v1.LookupSubjectsResponse.subject_object_id is deprecated. See authzed/api/v1/permission_service.proto;l=615
       subject_object_id is the Object ID of the subject found. May be a `*` if
 a wildcard was found.
 deprecated: use `subject`
      string subject_object_id = 2 [deprecated = true];
      Specified by:
      getSubjectObjectIdBytes in interface LookupSubjectsResponseOrBuilder
      Returns:
      The bytes for subjectObjectId.

    • getExcludedSubjectIdsList

      @Deprecated public com.google.protobuf.ProtocolStringList getExcludedSubjectIdsList()
      Deprecated.
      authzed.api.v1.LookupSubjectsResponse.excluded_subject_ids is deprecated. See authzed/api/v1/permission_service.proto;l=621
       excluded_subject_ids are the Object IDs of the subjects excluded. This list
 will only contain object IDs if `subject_object_id` is a wildcard (`*`) and
 will only be populated if exclusions exist from the wildcard.
 deprecated: use `excluded_subjects`
      repeated string excluded_subject_ids = 3 [deprecated = true];
      Specified by:
      getExcludedSubjectIdsList in interface LookupSubjectsResponseOrBuilder
      Returns:
      A list containing the excludedSubjectIds.

    • getExcludedSubjectIdsCount

      @Deprecated public int getExcludedSubjectIdsCount()
      Deprecated.
      authzed.api.v1.LookupSubjectsResponse.excluded_subject_ids is deprecated. See authzed/api/v1/permission_service.proto;l=621
       excluded_subject_ids are the Object IDs of the subjects excluded. This list
 will only contain object IDs if `subject_object_id` is a wildcard (`*`) and
 will only be populated if exclusions exist from the wildcard.
 deprecated: use `excluded_subjects`
      repeated string excluded_subject_ids = 3 [deprecated = true];
      Specified by:
      getExcludedSubjectIdsCount in interface LookupSubjectsResponseOrBuilder
      Returns:
      The count of excludedSubjectIds.

    • getExcludedSubjectIds

      @Deprecated public String getExcludedSubjectIds(int index)
      Deprecated.
      authzed.api.v1.LookupSubjectsResponse.excluded_subject_ids is deprecated. See authzed/api/v1/permission_service.proto;l=621
       excluded_subject_ids are the Object IDs of the subjects excluded. This list
 will only contain object IDs if `subject_object_id` is a wildcard (`*`) and
 will only be populated if exclusions exist from the wildcard.
 deprecated: use `excluded_subjects`
      repeated string excluded_subject_ids = 3 [deprecated = true];
      Specified by:
      getExcludedSubjectIds in interface LookupSubjectsResponseOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The excludedSubjectIds at the given index.

    • getExcludedSubjectIdsBytes

      @Deprecated public com.google.protobuf.ByteString getExcludedSubjectIdsBytes(int index)
      Deprecated.
      authzed.api.v1.LookupSubjectsResponse.excluded_subject_ids is deprecated. See authzed/api/v1/permission_service.proto;l=621
       excluded_subject_ids are the Object IDs of the subjects excluded. This list
 will only contain object IDs if `subject_object_id` is a wildcard (`*`) and
 will only be populated if exclusions exist from the wildcard.
 deprecated: use `excluded_subjects`
      repeated string excluded_subject_ids = 3 [deprecated = true];
      Specified by:
      getExcludedSubjectIdsBytes in interface LookupSubjectsResponseOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the excludedSubjectIds at the given index.

    • getPermissionshipValue

      @Deprecated public int getPermissionshipValue()
      Deprecated.
      authzed.api.v1.LookupSubjectsResponse.permissionship is deprecated. See authzed/api/v1/permission_service.proto;l=625
       permissionship indicates whether the response was partially evaluated or not
 deprecated: use `subject.permissionship`
      .authzed.api.v1.LookupPermissionship permissionship = 4 [deprecated = true, (.validate.rules) = { ... }
      Specified by:
      getPermissionshipValue in interface LookupSubjectsResponseOrBuilder
      Returns:
      The enum numeric value on the wire for permissionship.

    • getPermissionship

      @Deprecated public LookupPermissionship getPermissionship()
      Deprecated.
      authzed.api.v1.LookupSubjectsResponse.permissionship is deprecated. See authzed/api/v1/permission_service.proto;l=625
       permissionship indicates whether the response was partially evaluated or not
 deprecated: use `subject.permissionship`
      .authzed.api.v1.LookupPermissionship permissionship = 4 [deprecated = true, (.validate.rules) = { ... }
      Specified by:
      getPermissionship in interface LookupSubjectsResponseOrBuilder
      Returns:
      The permissionship.

    • hasPartialCaveatInfo

      @Deprecated public boolean hasPartialCaveatInfo()
      Deprecated.
      authzed.api.v1.LookupSubjectsResponse.partial_caveat_info is deprecated. See authzed/api/v1/permission_service.proto;l=629
       partial_caveat_info holds information of a partially-evaluated caveated response
 deprecated: use `subject.partial_caveat_info`
      .authzed.api.v1.PartialCaveatInfo partial_caveat_info = 5 [deprecated = true, (.validate.rules) = { ... }
      Specified by:
      hasPartialCaveatInfo in interface LookupSubjectsResponseOrBuilder
      Returns:
      Whether the partialCaveatInfo field is set.

    • getPartialCaveatInfo

      @Deprecated public PartialCaveatInfo getPartialCaveatInfo()
      Deprecated.
      authzed.api.v1.LookupSubjectsResponse.partial_caveat_info is deprecated. See authzed/api/v1/permission_service.proto;l=629
       partial_caveat_info holds information of a partially-evaluated caveated response
 deprecated: use `subject.partial_caveat_info`
      .authzed.api.v1.PartialCaveatInfo partial_caveat_info = 5 [deprecated = true, (.validate.rules) = { ... }
      Specified by:
      getPartialCaveatInfo in interface LookupSubjectsResponseOrBuilder
      Returns:
      The partialCaveatInfo.

    • getPartialCaveatInfoOrBuilder

      @Deprecated public PartialCaveatInfoOrBuilder getPartialCaveatInfoOrBuilder()
      Deprecated.
       partial_caveat_info holds information of a partially-evaluated caveated response
 deprecated: use `subject.partial_caveat_info`
      .authzed.api.v1.PartialCaveatInfo partial_caveat_info = 5 [deprecated = true, (.validate.rules) = { ... }
      Specified by:
      getPartialCaveatInfoOrBuilder in interface LookupSubjectsResponseOrBuilder

    • hasSubject

      public boolean hasSubject()
       subject is the subject found, along with its permissionship.
      .authzed.api.v1.ResolvedSubject subject = 6;
      Specified by:
      hasSubject in interface LookupSubjectsResponseOrBuilder
      Returns:
      Whether the subject field is set.

    • getSubject

      public ResolvedSubject getSubject()
       subject is the subject found, along with its permissionship.
      .authzed.api.v1.ResolvedSubject subject = 6;
      Specified by:
      getSubject in interface LookupSubjectsResponseOrBuilder
      Returns:
      The subject.

    • getSubjectOrBuilder

      public ResolvedSubjectOrBuilder getSubjectOrBuilder()
       subject is the subject found, along with its permissionship.
      .authzed.api.v1.ResolvedSubject subject = 6;
      Specified by:
      getSubjectOrBuilder in interface LookupSubjectsResponseOrBuilder

    • getExcludedSubjectsList

      public List<ResolvedSubject> getExcludedSubjectsList()
       excluded_subjects are the subjects excluded. This list
 will only contain subjects if `subject.subject_object_id` is a wildcard (`*`) and
 will only be populated if exclusions exist from the wildcard.
      repeated .authzed.api.v1.ResolvedSubject excluded_subjects = 7;
      Specified by:
      getExcludedSubjectsList in interface LookupSubjectsResponseOrBuilder

    • getExcludedSubjectsOrBuilderList

      public List<? extends ResolvedSubjectOrBuilder> getExcludedSubjectsOrBuilderList()
       excluded_subjects are the subjects excluded. This list
 will only contain subjects if `subject.subject_object_id` is a wildcard (`*`) and
 will only be populated if exclusions exist from the wildcard.
      repeated .authzed.api.v1.ResolvedSubject excluded_subjects = 7;
      Specified by:
      getExcludedSubjectsOrBuilderList in interface LookupSubjectsResponseOrBuilder

    • getExcludedSubjectsCount

      public int getExcludedSubjectsCount()
       excluded_subjects are the subjects excluded. This list
 will only contain subjects if `subject.subject_object_id` is a wildcard (`*`) and
 will only be populated if exclusions exist from the wildcard.
      repeated .authzed.api.v1.ResolvedSubject excluded_subjects = 7;
      Specified by:
      getExcludedSubjectsCount in interface LookupSubjectsResponseOrBuilder

    • getExcludedSubjects

      public ResolvedSubject getExcludedSubjects(int index)
       excluded_subjects are the subjects excluded. This list
 will only contain subjects if `subject.subject_object_id` is a wildcard (`*`) and
 will only be populated if exclusions exist from the wildcard.
      repeated .authzed.api.v1.ResolvedSubject excluded_subjects = 7;
      Specified by:
      getExcludedSubjects in interface LookupSubjectsResponseOrBuilder

    • getExcludedSubjectsOrBuilder

      public ResolvedSubjectOrBuilder getExcludedSubjectsOrBuilder(int index)
       excluded_subjects are the subjects excluded. This list
 will only contain subjects if `subject.subject_object_id` is a wildcard (`*`) and
 will only be populated if exclusions exist from the wildcard.
      repeated .authzed.api.v1.ResolvedSubject excluded_subjects = 7;
      Specified by:
      getExcludedSubjectsOrBuilder in interface LookupSubjectsResponseOrBuilder

    • hasAfterResultCursor

      public boolean hasAfterResultCursor()
       after_result_cursor holds a cursor that can be used to resume the LookupSubjects stream after this
 result.
      .authzed.api.v1.Cursor after_result_cursor = 8;
      Specified by:
      hasAfterResultCursor in interface LookupSubjectsResponseOrBuilder
      Returns:
      Whether the afterResultCursor field is set.

    • getAfterResultCursor

      public Cursor getAfterResultCursor()
       after_result_cursor holds a cursor that can be used to resume the LookupSubjects stream after this
 result.
      .authzed.api.v1.Cursor after_result_cursor = 8;
      Specified by:
      getAfterResultCursor in interface LookupSubjectsResponseOrBuilder
      Returns:
      The afterResultCursor.

    • getAfterResultCursorOrBuilder

      public CursorOrBuilder getAfterResultCursorOrBuilder()
       after_result_cursor holds a cursor that can be used to resume the LookupSubjects stream after this
 result.
      .authzed.api.v1.Cursor after_result_cursor = 8;
      Specified by:
      getAfterResultCursorOrBuilder in interface LookupSubjectsResponseOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static LookupSubjectsResponse.Builder newBuilder()

    • newBuilder

      public static LookupSubjectsResponse.Builder newBuilder(LookupSubjectsResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static LookupSubjectsResponse getDefaultInstance()

    • parser

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

    • getParserForType

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