Package com.authzed.api.v1

Class LookupSubjectsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<LookupSubjectsRequest.Builder>
com.authzed.api.v1.LookupSubjectsRequest.Builder
All Implemented Interfaces:
LookupSubjectsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
LookupSubjectsRequest
public static final class LookupSubjectsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<LookupSubjectsRequest.Builder> implements LookupSubjectsRequestOrBuilder
 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.
Protobuf type authzed.api.v1.LookupSubjectsRequest

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<LookupSubjectsRequest.Builder>

    • clear

      public LookupSubjectsRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<LookupSubjectsRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<LookupSubjectsRequest.Builder>

    • getDefaultInstanceForType

      public LookupSubjectsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public LookupSubjectsRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public LookupSubjectsRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public LookupSubjectsRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LookupSubjectsRequest.Builder>

    • mergeFrom

      public LookupSubjectsRequest.Builder mergeFrom(LookupSubjectsRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<LookupSubjectsRequest.Builder>

    • mergeFrom

      public LookupSubjectsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LookupSubjectsRequest.Builder>
      Throws:
      IOException

    • hasConsistency

      public boolean hasConsistency()
      .authzed.api.v1.Consistency consistency = 1;
      Specified by:
      hasConsistency in interface LookupSubjectsRequestOrBuilder
      Returns:
      Whether the consistency field is set.

    • getConsistency

      public Consistency getConsistency()
      .authzed.api.v1.Consistency consistency = 1;
      Specified by:
      getConsistency in interface LookupSubjectsRequestOrBuilder
      Returns:
      The consistency.

    • setConsistency

      public LookupSubjectsRequest.Builder setConsistency(Consistency value)
      .authzed.api.v1.Consistency consistency = 1;

    • setConsistency

      public LookupSubjectsRequest.Builder setConsistency(Consistency.Builder builderForValue)
      .authzed.api.v1.Consistency consistency = 1;

    • mergeConsistency

      public LookupSubjectsRequest.Builder mergeConsistency(Consistency value)
      .authzed.api.v1.Consistency consistency = 1;

    • clearConsistency

      public LookupSubjectsRequest.Builder clearConsistency()
      .authzed.api.v1.Consistency consistency = 1;

    • getConsistencyBuilder

      public Consistency.Builder getConsistencyBuilder()
      .authzed.api.v1.Consistency consistency = 1;

    • getConsistencyOrBuilder

      public ConsistencyOrBuilder getConsistencyOrBuilder()
      .authzed.api.v1.Consistency consistency = 1;
      Specified by:
      getConsistencyOrBuilder in interface LookupSubjectsRequestOrBuilder

    • hasResource

      public 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) = { ... }
      Specified by:
      hasResource in interface LookupSubjectsRequestOrBuilder
      Returns:
      Whether the resource field is set.

    • getResource

      public 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) = { ... }
      Specified by:
      getResource in interface LookupSubjectsRequestOrBuilder
      Returns:
      The resource.

    • setResource

      public LookupSubjectsRequest.Builder setResource(ObjectReference value)
       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) = { ... }

    • setResource

      public LookupSubjectsRequest.Builder setResource(ObjectReference.Builder builderForValue)
       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) = { ... }

    • mergeResource

      public LookupSubjectsRequest.Builder mergeResource(ObjectReference value)
       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) = { ... }

    • clearResource

      public LookupSubjectsRequest.Builder clearResource()
       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) = { ... }

    • getResourceBuilder

      public ObjectReference.Builder getResourceBuilder()
       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) = { ... }

    • getResourceOrBuilder

      public 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) = { ... }
      Specified by:
      getResourceOrBuilder in interface LookupSubjectsRequestOrBuilder

    • getPermission

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

    • getPermissionBytes

      public 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) = { ... }
      Specified by:
      getPermissionBytes in interface LookupSubjectsRequestOrBuilder
      Returns:
      The bytes for permission.

    • setPermission

      public LookupSubjectsRequest.Builder setPermission(String value)
       permission is the name of the permission (or relation) for which to find
 the subjects.
      string permission = 3 [(.validate.rules) = { ... }
      Parameters:
      value - The permission to set.
      Returns:
      This builder for chaining.

    • clearPermission

      public LookupSubjectsRequest.Builder clearPermission()
       permission is the name of the permission (or relation) for which to find
 the subjects.
      string permission = 3 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setPermissionBytes

      public LookupSubjectsRequest.Builder setPermissionBytes(com.google.protobuf.ByteString value)
       permission is the name of the permission (or relation) for which to find
 the subjects.
      string permission = 3 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for permission to set.
      Returns:
      This builder for chaining.

    • getSubjectObjectType

      public 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) = { ... }
      Specified by:
      getSubjectObjectType in interface LookupSubjectsRequestOrBuilder
      Returns:
      The subjectObjectType.

    • getSubjectObjectTypeBytes

      public 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) = { ... }
      Specified by:
      getSubjectObjectTypeBytes in interface LookupSubjectsRequestOrBuilder
      Returns:
      The bytes for subjectObjectType.

    • setSubjectObjectType

      public LookupSubjectsRequest.Builder setSubjectObjectType(String value)
       subject_object_type is the type of subject object for which the IDs will
 be returned.
      string subject_object_type = 4 [(.validate.rules) = { ... }
      Parameters:
      value - The subjectObjectType to set.
      Returns:
      This builder for chaining.

    • clearSubjectObjectType

      public LookupSubjectsRequest.Builder clearSubjectObjectType()
       subject_object_type is the type of subject object for which the IDs will
 be returned.
      string subject_object_type = 4 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setSubjectObjectTypeBytes

      public LookupSubjectsRequest.Builder setSubjectObjectTypeBytes(com.google.protobuf.ByteString value)
       subject_object_type is the type of subject object for which the IDs will
 be returned.
      string subject_object_type = 4 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for subjectObjectType to set.
      Returns:
      This builder for chaining.

    • getOptionalSubjectRelation

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

    • getOptionalSubjectRelationBytes

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

    • setOptionalSubjectRelation

      public LookupSubjectsRequest.Builder setOptionalSubjectRelation(String value)
       optional_subject_relation is the optional relation for the subject.
      string optional_subject_relation = 5 [(.validate.rules) = { ... }
      Parameters:
      value - The optionalSubjectRelation to set.
      Returns:
      This builder for chaining.

    • clearOptionalSubjectRelation

      public LookupSubjectsRequest.Builder clearOptionalSubjectRelation()
       optional_subject_relation is the optional relation for the subject.
      string optional_subject_relation = 5 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setOptionalSubjectRelationBytes

      public LookupSubjectsRequest.Builder setOptionalSubjectRelationBytes(com.google.protobuf.ByteString value)
       optional_subject_relation is the optional relation for the subject.
      string optional_subject_relation = 5 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for optionalSubjectRelation to set.
      Returns:
      This builder for chaining.

    • hasContext

      public boolean hasContext()
       context consists of named values that are injected into the caveat evaluation context
      .google.protobuf.Struct context = 6 [(.validate.rules) = { ... }
      Specified by:
      hasContext in interface LookupSubjectsRequestOrBuilder
      Returns:
      Whether the context field is set.

    • getContext

      public 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) = { ... }
      Specified by:
      getContext in interface LookupSubjectsRequestOrBuilder
      Returns:
      The context.

    • setContext

      public LookupSubjectsRequest.Builder setContext(com.google.protobuf.Struct value)
       context consists of named values that are injected into the caveat evaluation context
      .google.protobuf.Struct context = 6 [(.validate.rules) = { ... }

    • setContext

      public LookupSubjectsRequest.Builder setContext(com.google.protobuf.Struct.Builder builderForValue)
       context consists of named values that are injected into the caveat evaluation context
      .google.protobuf.Struct context = 6 [(.validate.rules) = { ... }

    • mergeContext

      public LookupSubjectsRequest.Builder mergeContext(com.google.protobuf.Struct value)
       context consists of named values that are injected into the caveat evaluation context
      .google.protobuf.Struct context = 6 [(.validate.rules) = { ... }

    • clearContext

      public LookupSubjectsRequest.Builder clearContext()
       context consists of named values that are injected into the caveat evaluation context
      .google.protobuf.Struct context = 6 [(.validate.rules) = { ... }

    • getContextBuilder

      public com.google.protobuf.Struct.Builder getContextBuilder()
       context consists of named values that are injected into the caveat evaluation context
      .google.protobuf.Struct context = 6 [(.validate.rules) = { ... }

    • getContextOrBuilder

      public 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) = { ... }
      Specified by:
      getContextOrBuilder in interface LookupSubjectsRequestOrBuilder

    • getOptionalConcreteLimit

      public 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) = { ... }
      Specified by:
      getOptionalConcreteLimit in interface LookupSubjectsRequestOrBuilder
      Returns:
      The optionalConcreteLimit.

    • setOptionalConcreteLimit

      public LookupSubjectsRequest.Builder setOptionalConcreteLimit(int value)
       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) = { ... }
      Parameters:
      value - The optionalConcreteLimit to set.
      Returns:
      This builder for chaining.

    • clearOptionalConcreteLimit

      public LookupSubjectsRequest.Builder clearOptionalConcreteLimit()
       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:
      This builder for chaining.

    • hasOptionalCursor

      public 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;
      Specified by:
      hasOptionalCursor in interface LookupSubjectsRequestOrBuilder
      Returns:
      Whether the optionalCursor field is set.

    • getOptionalCursor

      public 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;
      Specified by:
      getOptionalCursor in interface LookupSubjectsRequestOrBuilder
      Returns:
      The optionalCursor.

    • setOptionalCursor

      public LookupSubjectsRequest.Builder setOptionalCursor(Cursor value)
       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;

    • setOptionalCursor

      public LookupSubjectsRequest.Builder setOptionalCursor(Cursor.Builder builderForValue)
       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;

    • mergeOptionalCursor

      public LookupSubjectsRequest.Builder mergeOptionalCursor(Cursor value)
       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;

    • clearOptionalCursor

      public LookupSubjectsRequest.Builder clearOptionalCursor()
       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;

    • getOptionalCursorBuilder

      public Cursor.Builder getOptionalCursorBuilder()
       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;

    • getOptionalCursorOrBuilder

      public 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;
      Specified by:
      getOptionalCursorOrBuilder in interface LookupSubjectsRequestOrBuilder

    • getWildcardOptionValue

      public 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;
      Specified by:
      getWildcardOptionValue in interface LookupSubjectsRequestOrBuilder
      Returns:
      The enum numeric value on the wire for wildcardOption.

    • setWildcardOptionValue

      public LookupSubjectsRequest.Builder setWildcardOptionValue(int value)
       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;
      Parameters:
      value - The enum numeric value on the wire for wildcardOption to set.
      Returns:
      This builder for chaining.

    • getWildcardOption

      public 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;
      Specified by:
      getWildcardOption in interface LookupSubjectsRequestOrBuilder
      Returns:
      The wildcardOption.

    • setWildcardOption

      public LookupSubjectsRequest.Builder setWildcardOption(LookupSubjectsRequest.WildcardOption value)
       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;
      Parameters:
      value - The wildcardOption to set.
      Returns:
      This builder for chaining.

    • clearWildcardOption

      public LookupSubjectsRequest.Builder clearWildcardOption()
       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:
      This builder for chaining.