Package com.authzed.api.v1

Interface LookupSubjectsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
LookupSubjectsRequest, LookupSubjectsRequest.Builder
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, if non-zero, specifies the limit on the number of *concrete* (non-wildcard) subjects to return before the stream is closed on the server side.
    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.
    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, if specified, indicates the cursor after which results should resume being returned.
    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, if non-zero, specifies the limit on the number of
 *concrete* (non-wildcard) subjects to return before the stream is closed on the
 server side. With the default value of zero, the stream will continue resolving
 concrete subjects until exhausted or the stream is closed due to the client or
 a network issue.

 NOTE: Wildcard subjects ("*") have special treatment when cursors and limits are used. Because
 wildcards can apply to *any* concrete subjects, if a wildcard subject is found within the dataset,
 a wildcard subject can be returned for *all* LookupSubjects calls, regardless of the cursor or
 limit.

 For example, if wildcards are requested, a wildcard subject exists, there is a specified limit
 of 10 concrete subjects, and at least 10 concrete subjects exist, the API will return 11 subjects
 in total: the 10 concrete + the wildcard

 Furthermore, if a wildcard has a set of exclusions generated by the dataset,
 the exclusions *will respect the cursor* and only a *partial* set of exclusions will be returned
 for each invocation of the API.

 ***IT IS UP TO THE CALLER IN THIS CASE TO COMBINE THE EXCLUSIONS IF DESIRED***
      uint32 optional_concrete_limit = 7 [(.validate.rules) = { ... }
      Returns:
      The optionalConcreteLimit.

    • hasOptionalCursor

      boolean hasOptionalCursor()
       optional_cursor, if specified, indicates the cursor after which results should resume being returned.
 The cursor can be found on the LookupSubjectsResponse object.

 NOTE: See above for notes about how cursors interact with wildcard subjects.
      .authzed.api.v1.Cursor optional_cursor = 8;
      Returns:
      Whether the optionalCursor field is set.

    • getOptionalCursor

      Cursor getOptionalCursor()
       optional_cursor, if specified, indicates the cursor after which results should resume being returned.
 The cursor can be found on the LookupSubjectsResponse object.

 NOTE: See above for notes about how cursors interact with wildcard subjects.
      .authzed.api.v1.Cursor optional_cursor = 8;
      Returns:
      The optionalCursor.

    • getOptionalCursorOrBuilder

      CursorOrBuilder getOptionalCursorOrBuilder()
       optional_cursor, if specified, indicates the cursor after which results should resume being returned.
 The cursor can be found on the LookupSubjectsResponse object.

 NOTE: See above for notes about how cursors interact with wildcard subjects.
      .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.