Package com.authzed.api.v1

Class ReadRelationshipsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.authzed.api.v1.ReadRelationshipsRequest
All Implemented Interfaces:
ReadRelationshipsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class ReadRelationshipsRequest extends com.google.protobuf.GeneratedMessage implements ReadRelationshipsRequestOrBuilder
 ReadRelationshipsRequest specifies one or more filters used to read matching
 relationships within the system.
Protobuf type authzed.api.v1.ReadRelationshipsRequest
See Also:

  • Field Details

    • CONSISTENCY_FIELD_NUMBER

      public static final int CONSISTENCY_FIELD_NUMBER
      See Also:

    • RELATIONSHIP_FILTER_FIELD_NUMBER

      public static final int RELATIONSHIP_FILTER_FIELD_NUMBER
      See Also:

    • OPTIONAL_LIMIT_FIELD_NUMBER

      public static final int OPTIONAL_LIMIT_FIELD_NUMBER
      See Also:

    • OPTIONAL_CURSOR_FIELD_NUMBER

      public static final int OPTIONAL_CURSOR_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

    • hasConsistency

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

    • getConsistency

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

    • getConsistencyOrBuilder

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

    • hasRelationshipFilter

      public boolean hasRelationshipFilter()
       relationship_filter defines the filter to be applied to the relationships
 to be returned.
      .authzed.api.v1.RelationshipFilter relationship_filter = 2 [(.validate.rules) = { ... }
      Specified by:
      hasRelationshipFilter in interface ReadRelationshipsRequestOrBuilder
      Returns:
      Whether the relationshipFilter field is set.

    • getRelationshipFilter

      public RelationshipFilter getRelationshipFilter()
       relationship_filter defines the filter to be applied to the relationships
 to be returned.
      .authzed.api.v1.RelationshipFilter relationship_filter = 2 [(.validate.rules) = { ... }
      Specified by:
      getRelationshipFilter in interface ReadRelationshipsRequestOrBuilder
      Returns:
      The relationshipFilter.

    • getRelationshipFilterOrBuilder

      public RelationshipFilterOrBuilder getRelationshipFilterOrBuilder()
       relationship_filter defines the filter to be applied to the relationships
 to be returned.
      .authzed.api.v1.RelationshipFilter relationship_filter = 2 [(.validate.rules) = { ... }
      Specified by:
      getRelationshipFilterOrBuilder in interface ReadRelationshipsRequestOrBuilder

    • getOptionalLimit

      public int getOptionalLimit()
       optional_limit, if non-zero, specifies the limit on the number of relationships to return
 before the stream is closed on the server side. By default, the stream will continue
 resolving relationships until exhausted or the stream is closed due to the client or a
 network issue.
      uint32 optional_limit = 3 [(.validate.rules) = { ... }
      Specified by:
      getOptionalLimit in interface ReadRelationshipsRequestOrBuilder
      Returns:
      The optionalLimit.

    • hasOptionalCursor

      public boolean hasOptionalCursor()
       optional_cursor, if specified, indicates the cursor after which results should resume being returned.
 The cursor can be found on the ReadRelationshipsResponse object.
      .authzed.api.v1.Cursor optional_cursor = 4;
      Specified by:
      hasOptionalCursor in interface ReadRelationshipsRequestOrBuilder
      Returns:
      Whether the optionalCursor field is set.

    • getOptionalCursor

      public Cursor getOptionalCursor()
       optional_cursor, if specified, indicates the cursor after which results should resume being returned.
 The cursor can be found on the ReadRelationshipsResponse object.
      .authzed.api.v1.Cursor optional_cursor = 4;
      Specified by:
      getOptionalCursor in interface ReadRelationshipsRequestOrBuilder
      Returns:
      The optionalCursor.

    • getOptionalCursorOrBuilder

      public CursorOrBuilder getOptionalCursorOrBuilder()
       optional_cursor, if specified, indicates the cursor after which results should resume being returned.
 The cursor can be found on the ReadRelationshipsResponse object.
      .authzed.api.v1.Cursor optional_cursor = 4;
      Specified by:
      getOptionalCursorOrBuilder in interface ReadRelationshipsRequestOrBuilder

    • 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 ReadRelationshipsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ReadRelationshipsRequest.Builder newBuilder()

    • newBuilder

      public static ReadRelationshipsRequest.Builder newBuilder(ReadRelationshipsRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ReadRelationshipsRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ReadRelationshipsRequest> 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 ReadRelationshipsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder