Package com.authzed.api.v1

Interface LookupSubjectsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
LookupSubjectsRequest, LookupSubjectsRequest.Builder
@Generated public interface LookupSubjectsRequestOrBuilder 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
    int
    getOptionalConcreteLimit()
    optional_concrete_limit is currently unimplemented for LookupSubjects and will return an error as of SpiceDB version 1.40.1.
    Cursor
    getOptionalCursor()
    optional_cursor is currently unimplemented for LookupSubjects and will be ignored as of SpiceDB version 1.40.1.
    CursorOrBuilder
    getOptionalCursorOrBuilder()
    optional_cursor is currently unimplemented for LookupSubjects and will be ignored as of SpiceDB version 1.40.1.
    String
    getOptionalSubjectRelation()
    optional_subject_relation is the optional relation for the subject.
    com.google.protobuf.ByteString
    getOptionalSubjectRelationBytes()
    optional_subject_relation is the optional relation for the subject.
    String
    getPermission()
    permission is the name of the permission (or relation) for which to find the subjects.
    com.google.protobuf.ByteString
    getPermissionBytes()
    permission is the name of the permission (or relation) for which to find the subjects.
    ObjectReference
    getResource()
    resource is the resource for which all matching subjects for the permission or relation will be returned.
    ObjectReferenceOrBuilder
    getResourceOrBuilder()
    resource is the resource for which all matching subjects for the permission or relation will be returned.
    String
    getSubjectObjectType()
    subject_object_type is the type of subject object for which the IDs will be returned.
    com.google.protobuf.ByteString
    getSubjectObjectTypeBytes()
    subject_object_type is the type of subject object for which the IDs will be returned.
    LookupSubjectsRequest.WildcardOption
    getWildcardOption()
    wildcard_option specifies whether wildcards should be returned by LookupSubjects.
    int
    getWildcardOptionValue()
    wildcard_option specifies whether wildcards should be returned by LookupSubjects.
    boolean
    hasConsistency()
    .authzed.api.v1.Consistency consistency = 1;
    boolean
    hasContext()
    context consists of named values that are injected into the caveat evaluation context
    boolean
    hasOptionalCursor()
    optional_cursor is currently unimplemented for LookupSubjects and will be ignored as of SpiceDB version 1.40.1.
    boolean
    hasResource()
    resource is the resource for which all matching subjects for the permission or relation will be returned.

    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 for which all matching subjects for the permission
 or relation will be returned.
      .authzed.api.v1.ObjectReference resource = 2 [(.validate.rules) = { ... }
      Returns:
      Whether the resource field is set.

    • getResource

      ObjectReference getResource()
       resource is the resource for which all matching subjects for the permission
 or relation will be returned.
      .authzed.api.v1.ObjectReference resource = 2 [(.validate.rules) = { ... }
      Returns:
      The resource.

    • getResourceOrBuilder

      ObjectReferenceOrBuilder getResourceOrBuilder()
       resource is the resource for which all matching subjects for the permission
 or relation will be returned.
      .authzed.api.v1.ObjectReference resource = 2 [(.validate.rules) = { ... }

    • getPermission

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

    • getPermissionBytes

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

    • getSubjectObjectType

      String getSubjectObjectType()
       subject_object_type is the type of subject object for which the IDs will
 be returned.
      string subject_object_type = 4 [(.validate.rules) = { ... }
      Returns:
      The subjectObjectType.

    • getSubjectObjectTypeBytes

      com.google.protobuf.ByteString getSubjectObjectTypeBytes()
       subject_object_type is the type of subject object for which the IDs will
 be returned.
      string subject_object_type = 4 [(.validate.rules) = { ... }
      Returns:
      The bytes for subjectObjectType.

    • getOptionalSubjectRelation

      String getOptionalSubjectRelation()
       optional_subject_relation is the optional relation for the subject.
      string optional_subject_relation = 5 [(.validate.rules) = { ... }
      Returns:
      The optionalSubjectRelation.

    • getOptionalSubjectRelationBytes

      com.google.protobuf.ByteString getOptionalSubjectRelationBytes()
       optional_subject_relation is the optional relation for the subject.
      string optional_subject_relation = 5 [(.validate.rules) = { ... }
      Returns:
      The bytes for optionalSubjectRelation.

    • hasContext

      boolean hasContext()
       context consists of named values that are injected into the caveat evaluation context
      .google.protobuf.Struct context = 6 [(.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 = 6 [(.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 = 6 [(.validate.rules) = { ... }

    • getOptionalConcreteLimit

      int getOptionalConcreteLimit()
       optional_concrete_limit is currently unimplemented for LookupSubjects
 and will return an error as of SpiceDB version 1.40.1. This will
 be implemented in a future version of SpiceDB.
      uint32 optional_concrete_limit = 7 [(.validate.rules) = { ... }
      Returns:
      The optionalConcreteLimit.

    • hasOptionalCursor

      boolean hasOptionalCursor()
       optional_cursor is currently unimplemented for LookupSubjects
 and will be ignored as of SpiceDB version 1.40.1. This will
 be implemented in a future version of SpiceDB.
      .authzed.api.v1.Cursor optional_cursor = 8;
      Returns:
      Whether the optionalCursor field is set.

    • getOptionalCursor

      Cursor getOptionalCursor()
       optional_cursor is currently unimplemented for LookupSubjects
 and will be ignored as of SpiceDB version 1.40.1. This will
 be implemented in a future version of SpiceDB.
      .authzed.api.v1.Cursor optional_cursor = 8;
      Returns:
      The optionalCursor.

    • getOptionalCursorOrBuilder

      CursorOrBuilder getOptionalCursorOrBuilder()
       optional_cursor is currently unimplemented for LookupSubjects
 and will be ignored as of SpiceDB version 1.40.1. This will
 be implemented in a future version of SpiceDB.
      .authzed.api.v1.Cursor optional_cursor = 8;

    • getWildcardOptionValue

      int getWildcardOptionValue()
       wildcard_option specifies whether wildcards should be returned by LookupSubjects.
 For backwards compatibility, defaults to WILDCARD_OPTION_INCLUDE_WILDCARDS if unspecified.
      .authzed.api.v1.LookupSubjectsRequest.WildcardOption wildcard_option = 9;
      Returns:
      The enum numeric value on the wire for wildcardOption.

    • getWildcardOption

      LookupSubjectsRequest.WildcardOption getWildcardOption()
       wildcard_option specifies whether wildcards should be returned by LookupSubjects.
 For backwards compatibility, defaults to WILDCARD_OPTION_INCLUDE_WILDCARDS if unspecified.
      .authzed.api.v1.LookupSubjectsRequest.WildcardOption wildcard_option = 9;
      Returns:
      The wildcardOption.