Package com.authzed.api.v1

Interface LookupResourcesRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
LookupResourcesRequest, LookupResourcesRequest.Builder
public interface LookupResourcesRequestOrBuilder 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
    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.
    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.
    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
    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.

    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;

    • getResourceObjectType

      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) = { ... }
      Returns:
      The resourceObjectType.

    • getResourceObjectTypeBytes

      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) = { ... }
      Returns:
      The bytes for resourceObjectType.

    • getPermission

      String getPermission()
       permission is the name of the permission or relation for which the subject
 must Check.
      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 the subject
 must Check.
      string permission = 3 [(.validate.rules) = { ... }
      Returns:
      The bytes for permission.

    • hasSubject

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

    • getSubject

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

    • getSubjectOrBuilder

      SubjectReferenceOrBuilder getSubjectOrBuilder()
       subject is the subject with access to the resources.
      .authzed.api.v1.SubjectReference subject = 4 [(.validate.rules) = { ... }

    • hasContext

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

    • getOptionalLimit

      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) = { ... }
      Returns:
      The optionalLimit.

    • hasOptionalCursor

      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;
      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 LookupResourcesResponse object.
      .authzed.api.v1.Cursor optional_cursor = 7;
      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 LookupResourcesResponse object.
      .authzed.api.v1.Cursor optional_cursor = 7;