final case class LookupSubjectsRequest(consistency: Option[Consistency] = _root_.scala.None, resource: Option[ObjectReference] = _root_.scala.None, permission: String = "", subjectObjectType: String = "", optionalSubjectRelation: String = "", context: Option[Struct] = _root_.scala.None, optionalConcreteLimit: Int = 0, optionalCursor: Option[Cursor] = _root_.scala.None, wildcardOption: WildcardOption = com.authzed.api.v1.permission_service.LookupSubjectsRequest.WildcardOption.WILDCARD_OPTION_UNSPECIFIED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[LookupSubjectsRequest] with Product with Serializable

LookupSubjectsRequest performs a lookup of all subjects of a particular kind for which the subject has the specified permission or the relation in which the subject exists, streaming back the IDs of those subjects.

resource

resource is the resource for which all matching subjects for the permission or relation will be returned.

permission

permission is the name of the permission (or relation) for which to find the subjects.

subjectObjectType

subject_object_type is the type of subject object for which the IDs will be returned.

optionalSubjectRelation

optional_subject_relation is the optional relation for the subject.

context

context consists of named values that are injected into the caveat evaluation context

optionalConcreteLimit

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***

optionalCursor

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.

wildcardOption

wildcard_option specifies whether wildcards should be returned by LookupSubjects. For backwards compatibility, defaults to WILDCARD_OPTION_INCLUDE_WILDCARDS if unspecified.

Annotations
@SerialVersionUID()
Source
LookupSubjectsRequest.scala
Linear Supertypes
Updatable[LookupSubjectsRequest], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LookupSubjectsRequest
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new LookupSubjectsRequest(consistency: Option[Consistency] = _root_.scala.None, resource: Option[ObjectReference] = _root_.scala.None, permission: String = "", subjectObjectType: String = "", optionalSubjectRelation: String = "", context: Option[Struct] = _root_.scala.None, optionalConcreteLimit: Int = 0, optionalCursor: Option[Cursor] = _root_.scala.None, wildcardOption: WildcardOption = com.authzed.api.v1.permission_service.LookupSubjectsRequest.WildcardOption.WILDCARD_OPTION_UNSPECIFIED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    resource

    resource is the resource for which all matching subjects for the permission or relation will be returned.

    permission

    permission is the name of the permission (or relation) for which to find the subjects.

    subjectObjectType

    subject_object_type is the type of subject object for which the IDs will be returned.

    optionalSubjectRelation

    optional_subject_relation is the optional relation for the subject.

    context

    context consists of named values that are injected into the caveat evaluation context

    optionalConcreteLimit

    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***

    optionalCursor

    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.

    wildcardOption

    wildcard_option specifies whether wildcards should be returned by LookupSubjects. For backwards compatibility, defaults to WILDCARD_OPTION_INCLUDE_WILDCARDS if unspecified.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clearConsistency: LookupSubjectsRequest
  6. def clearContext: LookupSubjectsRequest
  7. def clearOptionalCursor: LookupSubjectsRequest
  8. def clearResource: LookupSubjectsRequest
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def companion: LookupSubjectsRequest.type
    Definition Classes
    LookupSubjectsRequest → GeneratedMessage
  11. val consistency: Option[Consistency]
  12. val context: Option[Struct]
  13. def discardUnknownFields: LookupSubjectsRequest
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getConsistency: Consistency
  18. def getContext: Struct
  19. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    LookupSubjectsRequest → GeneratedMessage
  20. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    LookupSubjectsRequest → GeneratedMessage
  21. def getOptionalCursor: Cursor
  22. def getResource: ObjectReference
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. val optionalConcreteLimit: Int
  28. val optionalCursor: Option[Cursor]
  29. val optionalSubjectRelation: String
  30. val permission: String
  31. def productElementNames: Iterator[String]
    Definition Classes
    Product
  32. val resource: Option[ObjectReference]
  33. def serializedSize: Int
    Definition Classes
    LookupSubjectsRequest → GeneratedMessage
  34. val subjectObjectType: String
  35. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  36. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  37. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  38. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  39. def toProtoString: String
    Definition Classes
    LookupSubjectsRequest → GeneratedMessage
  40. val unknownFields: UnknownFieldSet
  41. def update(ms: (Lens[LookupSubjectsRequest, LookupSubjectsRequest]) => Mutation[LookupSubjectsRequest]*): LookupSubjectsRequest
    Definition Classes
    Updatable
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  45. val wildcardOption: WildcardOption
  46. def withConsistency(__v: Consistency): LookupSubjectsRequest
  47. def withContext(__v: Struct): LookupSubjectsRequest
  48. def withOptionalConcreteLimit(__v: Int): LookupSubjectsRequest
  49. def withOptionalCursor(__v: Cursor): LookupSubjectsRequest
  50. def withOptionalSubjectRelation(__v: String): LookupSubjectsRequest
  51. def withPermission(__v: String): LookupSubjectsRequest
  52. def withResource(__v: ObjectReference): LookupSubjectsRequest
  53. def withSubjectObjectType(__v: String): LookupSubjectsRequest
  54. def withUnknownFields(__v: UnknownFieldSet): LookupSubjectsRequest
  55. def withWildcardOption(__v: WildcardOption): LookupSubjectsRequest
  56. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  57. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    LookupSubjectsRequest → GeneratedMessage
  58. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Updatable[LookupSubjectsRequest]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped