Package com.authzed.api.v1

Interface ReadRelationshipsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ReadRelationshipsRequest, ReadRelationshipsRequest.Builder
public interface ReadRelationshipsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    Consistency
    getConsistency()
    .authzed.api.v1.Consistency consistency = 1;
    ConsistencyOrBuilder
    getConsistencyOrBuilder()
    .authzed.api.v1.Consistency consistency = 1;
    Cursor
    getOptionalCursor()
    optional_cursor, if specified, indicates the cursor after which results should resume being returned.
    CursorOrBuilder
    getOptionalCursorOrBuilder()
    optional_cursor, if specified, indicates the cursor after which results should resume being returned.
    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.
    RelationshipFilter
    getRelationshipFilter()
    relationship_filter defines the filter to be applied to the relationships to be returned.
    RelationshipFilterOrBuilder
    getRelationshipFilterOrBuilder()
    relationship_filter defines the filter to be applied to the relationships to be returned.
    boolean
    hasConsistency()
    .authzed.api.v1.Consistency consistency = 1;
    boolean
    hasOptionalCursor()
    optional_cursor, if specified, indicates the cursor after which results should resume being returned.
    boolean
    hasRelationshipFilter()
    relationship_filter defines the filter to be applied to the relationships to be returned.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • hasConsistency

      boolean hasConsistency()
      .authzed.api.v1.Consistency consistency = 1;
      Returns:
      Whether the consistency field is set.

    • getConsistency

      Consistency getConsistency()
      .authzed.api.v1.Consistency consistency = 1;
      Returns:
      The consistency.

    • getConsistencyOrBuilder

      ConsistencyOrBuilder getConsistencyOrBuilder()
      .authzed.api.v1.Consistency consistency = 1;

    • hasRelationshipFilter

      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) = { ... }
      Returns:
      Whether the relationshipFilter field is set.

    • getRelationshipFilter

      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) = { ... }
      Returns:
      The relationshipFilter.

    • getRelationshipFilterOrBuilder

      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) = { ... }

    • getOptionalLimit

      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) = { ... }
      Returns:
      The optionalLimit.

    • hasOptionalCursor

      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;
      Returns:
      Whether the optionalCursor field is set.

    • getOptionalCursor

      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;
      Returns:
      The optionalCursor.

    • getOptionalCursorOrBuilder

      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;