Struct LookupSubjectsRequest

pub struct LookupSubjectsRequest {
    pub consistency: Option<Consistency>,
    pub resource: Option<ObjectReference>,
    pub permission: String,
    pub subject_object_type: String,
    pub optional_subject_relation: String,
    pub context: Option<Struct>,
    pub optional_concrete_limit: u32,
    pub optional_cursor: Option<Cursor>,
    pub wildcard_option: i32,
}

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.

Fields

consistency: Option<Consistency>

resource: Option<ObjectReference>

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

permission: String

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

subject_object_type: String

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

optional_subject_relation: String

optional_subject_relation is the optional relation for the subject.

context: Option<Struct>

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

optional_concrete_limit: u32

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

optional_cursor: Option<Cursor>

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.

wildcard_option: i32

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

Implementations

impl LookupSubjectsRequest

pub fn wildcard_option(&self) -> WildcardOption

Returns the enum value of wildcard_option, or the default if the field is set to an invalid enum value.

pub fn set_wildcard_option(&mut self, value: WildcardOption)

Sets wildcard_option to the provided enum value.

Trait Implementations

impl Clone for LookupSubjectsRequest

fn clone(&self) -> LookupSubjectsRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LookupSubjectsRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LookupSubjectsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for LookupSubjectsRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for LookupSubjectsRequest

fn eq(&self, other: &LookupSubjectsRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LookupSubjectsRequest