Package com.authzed.api.v1

Class RelationshipFilter

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.authzed.api.v1.RelationshipFilter
All Implemented Interfaces:
RelationshipFilterOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class RelationshipFilter extends com.google.protobuf.GeneratedMessage implements RelationshipFilterOrBuilder
 RelationshipFilter is a collection of filters which when applied to a
 relationship will return relationships that have exactly matching fields.

 All fields are optional and if left unspecified will not filter relationships,
 but at least one field must be specified.

 NOTE: The performance of the API will be affected by the selection of fields
 on which to filter. If a field is not indexed, the performance of the API
 can be significantly slower.
Protobuf type authzed.api.v1.RelationshipFilter
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    RelationshipFilter.Builder
    RelationshipFilter is a collection of filters which when applied to a relationship will return relationships that have exactly matching fields.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    OPTIONAL_RELATION_FIELD_NUMBER
     
    static final int
    OPTIONAL_RESOURCE_ID_FIELD_NUMBER
     
    static final int
    OPTIONAL_RESOURCE_ID_PREFIX_FIELD_NUMBER
     
    static final int
    OPTIONAL_SUBJECT_FILTER_FIELD_NUMBER
     
    static final int
    RESOURCE_TYPE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static RelationshipFilter
    getDefaultInstance()
     
    RelationshipFilter
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getOptionalRelation()
    relation is the *optional* relation of the relationship.
    com.google.protobuf.ByteString
    getOptionalRelationBytes()
    relation is the *optional* relation of the relationship.
    String
    getOptionalResourceId()
    optional_resource_id is the *optional* resource ID of the relationship.
    com.google.protobuf.ByteString
    getOptionalResourceIdBytes()
    optional_resource_id is the *optional* resource ID of the relationship.
    String
    getOptionalResourceIdPrefix()
    optional_resource_id_prefix is the *optional* prefix for the resource ID of the relationship.
    com.google.protobuf.ByteString
    getOptionalResourceIdPrefixBytes()
    optional_resource_id_prefix is the *optional* prefix for the resource ID of the relationship.
    SubjectFilter
    getOptionalSubjectFilter()
    optional_subject_filter is the optional filter for the subjects of the relationships.
    SubjectFilterOrBuilder
    getOptionalSubjectFilterOrBuilder()
    optional_subject_filter is the optional filter for the subjects of the relationships.
    com.google.protobuf.Parser<RelationshipFilter>
    getParserForType()
     
    String
    getResourceType()
    resource_type is the *optional* resource type of the relationship.
    com.google.protobuf.ByteString
    getResourceTypeBytes()
    resource_type is the *optional* resource type of the relationship.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasOptionalSubjectFilter()
    optional_subject_filter is the optional filter for the subjects of the relationships.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static RelationshipFilter.Builder
    newBuilder()
     
    static RelationshipFilter.Builder
    newBuilder(RelationshipFilter prototype)
     
    RelationshipFilter.Builder
    newBuilderForType()
     
    protected RelationshipFilter.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static RelationshipFilter
    parseDelimitedFrom(InputStream input)
     
    static RelationshipFilter
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RelationshipFilter
    parseFrom(byte[] data)
     
    static RelationshipFilter
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RelationshipFilter
    parseFrom(com.google.protobuf.ByteString data)
     
    static RelationshipFilter
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RelationshipFilter
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static RelationshipFilter
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RelationshipFilter
    parseFrom(InputStream input)
     
    static RelationshipFilter
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RelationshipFilter
    parseFrom(ByteBuffer data)
     
    static RelationshipFilter
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<RelationshipFilter>
    parser()
     
    RelationshipFilter.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • RESOURCE_TYPE_FIELD_NUMBER

      public static final int RESOURCE_TYPE_FIELD_NUMBER
      See Also:

    • OPTIONAL_RESOURCE_ID_FIELD_NUMBER

      public static final int OPTIONAL_RESOURCE_ID_FIELD_NUMBER
      See Also:

    • OPTIONAL_RESOURCE_ID_PREFIX_FIELD_NUMBER

      public static final int OPTIONAL_RESOURCE_ID_PREFIX_FIELD_NUMBER
      See Also:

    • OPTIONAL_RELATION_FIELD_NUMBER

      public static final int OPTIONAL_RELATION_FIELD_NUMBER
      See Also:

    • OPTIONAL_SUBJECT_FILTER_FIELD_NUMBER

      public static final int OPTIONAL_SUBJECT_FILTER_FIELD_NUMBER
      See Also:

  • 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

    • getResourceType

      public String getResourceType()
       resource_type is the *optional* resource type of the relationship.
 NOTE: It is not prefixed with "optional_" for legacy compatibility.
      string resource_type = 1 [(.validate.rules) = { ... }
      Specified by:
      getResourceType in interface RelationshipFilterOrBuilder
      Returns:
      The resourceType.

    • getResourceTypeBytes

      public com.google.protobuf.ByteString getResourceTypeBytes()
       resource_type is the *optional* resource type of the relationship.
 NOTE: It is not prefixed with "optional_" for legacy compatibility.
      string resource_type = 1 [(.validate.rules) = { ... }
      Specified by:
      getResourceTypeBytes in interface RelationshipFilterOrBuilder
      Returns:
      The bytes for resourceType.

    • getOptionalResourceId

      public String getOptionalResourceId()
       optional_resource_id is the *optional* resource ID of the relationship.
 If specified, optional_resource_id_prefix cannot be specified.
      string optional_resource_id = 2 [(.validate.rules) = { ... }
      Specified by:
      getOptionalResourceId in interface RelationshipFilterOrBuilder
      Returns:
      The optionalResourceId.

    • getOptionalResourceIdBytes

      public com.google.protobuf.ByteString getOptionalResourceIdBytes()
       optional_resource_id is the *optional* resource ID of the relationship.
 If specified, optional_resource_id_prefix cannot be specified.
      string optional_resource_id = 2 [(.validate.rules) = { ... }
      Specified by:
      getOptionalResourceIdBytes in interface RelationshipFilterOrBuilder
      Returns:
      The bytes for optionalResourceId.

    • getOptionalResourceIdPrefix

      public String getOptionalResourceIdPrefix()
       optional_resource_id_prefix is the *optional* prefix for the resource ID of the relationship.
 If specified, optional_resource_id cannot be specified.
      string optional_resource_id_prefix = 5 [(.validate.rules) = { ... }
      Specified by:
      getOptionalResourceIdPrefix in interface RelationshipFilterOrBuilder
      Returns:
      The optionalResourceIdPrefix.

    • getOptionalResourceIdPrefixBytes

      public com.google.protobuf.ByteString getOptionalResourceIdPrefixBytes()
       optional_resource_id_prefix is the *optional* prefix for the resource ID of the relationship.
 If specified, optional_resource_id cannot be specified.
      string optional_resource_id_prefix = 5 [(.validate.rules) = { ... }
      Specified by:
      getOptionalResourceIdPrefixBytes in interface RelationshipFilterOrBuilder
      Returns:
      The bytes for optionalResourceIdPrefix.

    • getOptionalRelation

      public String getOptionalRelation()
       relation is the *optional* relation of the relationship.
      string optional_relation = 3 [(.validate.rules) = { ... }
      Specified by:
      getOptionalRelation in interface RelationshipFilterOrBuilder
      Returns:
      The optionalRelation.

    • getOptionalRelationBytes

      public com.google.protobuf.ByteString getOptionalRelationBytes()
       relation is the *optional* relation of the relationship.
      string optional_relation = 3 [(.validate.rules) = { ... }
      Specified by:
      getOptionalRelationBytes in interface RelationshipFilterOrBuilder
      Returns:
      The bytes for optionalRelation.

    • hasOptionalSubjectFilter

      public boolean hasOptionalSubjectFilter()
       optional_subject_filter is the optional filter for the subjects of the relationships.
      .authzed.api.v1.SubjectFilter optional_subject_filter = 4;
      Specified by:
      hasOptionalSubjectFilter in interface RelationshipFilterOrBuilder
      Returns:
      Whether the optionalSubjectFilter field is set.

    • getOptionalSubjectFilter

      public SubjectFilter getOptionalSubjectFilter()
       optional_subject_filter is the optional filter for the subjects of the relationships.
      .authzed.api.v1.SubjectFilter optional_subject_filter = 4;
      Specified by:
      getOptionalSubjectFilter in interface RelationshipFilterOrBuilder
      Returns:
      The optionalSubjectFilter.

    • getOptionalSubjectFilterOrBuilder

      public SubjectFilterOrBuilder getOptionalSubjectFilterOrBuilder()
       optional_subject_filter is the optional filter for the subjects of the relationships.
      .authzed.api.v1.SubjectFilter optional_subject_filter = 4;
      Specified by:
      getOptionalSubjectFilterOrBuilder in interface RelationshipFilterOrBuilder

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RelationshipFilter parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RelationshipFilter parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RelationshipFilter parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RelationshipFilter parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RelationshipFilter parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RelationshipFilter parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RelationshipFilter parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RelationshipFilter parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RelationshipFilter parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RelationshipFilter parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RelationshipFilter parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RelationshipFilter parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public RelationshipFilter.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static RelationshipFilter.Builder newBuilder()

    • newBuilder

      public static RelationshipFilter.Builder newBuilder(RelationshipFilter prototype)

    • toBuilder

      public RelationshipFilter.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RelationshipFilter.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static RelationshipFilter getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RelationshipFilter> parser()

    • getParserForType

      public com.google.protobuf.Parser<RelationshipFilter> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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