Class BulkExportRelationshipsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.authzed.api.v1.BulkExportRelationshipsRequest
All Implemented Interfaces:
BulkExportRelationshipsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class BulkExportRelationshipsRequest extends com.google.protobuf.GeneratedMessage implements BulkExportRelationshipsRequestOrBuilder
 BulkExportRelationshipsRequest represents a resumable request for
 all relationships from the server.
 
Protobuf type authzed.api.v1.BulkExportRelationshipsRequest
See Also:
  • Field Details

    • CONSISTENCY_FIELD_NUMBER

      public static final int CONSISTENCY_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:
    • OPTIONAL_RELATIONSHIP_FILTER_FIELD_NUMBER

      public static final int OPTIONAL_RELATIONSHIP_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
    • hasConsistency

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

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

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

      public int getOptionalLimit()
       optional_limit, if non-zero, specifies the limit on the number of
       relationships the server can return in one page. By default, the server
       will pick a page size, and the server is free to choose a smaller size
       at will.
       
      uint32 optional_limit = 2 [(.validate.rules) = { ... }
      Specified by:
      getOptionalLimit in interface BulkExportRelationshipsRequestOrBuilder
      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
       BulkExportRelationshipsResponse object.
       
      .authzed.api.v1.Cursor optional_cursor = 3;
      Specified by:
      hasOptionalCursor in interface BulkExportRelationshipsRequestOrBuilder
      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
       BulkExportRelationshipsResponse object.
       
      .authzed.api.v1.Cursor optional_cursor = 3;
      Specified by:
      getOptionalCursor in interface BulkExportRelationshipsRequestOrBuilder
      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
       BulkExportRelationshipsResponse object.
       
      .authzed.api.v1.Cursor optional_cursor = 3;
      Specified by:
      getOptionalCursorOrBuilder in interface BulkExportRelationshipsRequestOrBuilder
    • hasOptionalRelationshipFilter

      public boolean hasOptionalRelationshipFilter()
       optional_relationship_filter, if specified, indicates the
       filter to apply to each relationship to be exported.
       
      .authzed.api.v1.RelationshipFilter optional_relationship_filter = 4;
      Specified by:
      hasOptionalRelationshipFilter in interface BulkExportRelationshipsRequestOrBuilder
      Returns:
      Whether the optionalRelationshipFilter field is set.
    • getOptionalRelationshipFilter

      public RelationshipFilter getOptionalRelationshipFilter()
       optional_relationship_filter, if specified, indicates the
       filter to apply to each relationship to be exported.
       
      .authzed.api.v1.RelationshipFilter optional_relationship_filter = 4;
      Specified by:
      getOptionalRelationshipFilter in interface BulkExportRelationshipsRequestOrBuilder
      Returns:
      The optionalRelationshipFilter.
    • getOptionalRelationshipFilterOrBuilder

      public RelationshipFilterOrBuilder getOptionalRelationshipFilterOrBuilder()
       optional_relationship_filter, if specified, indicates the
       filter to apply to each relationship to be exported.
       
      .authzed.api.v1.RelationshipFilter optional_relationship_filter = 4;
      Specified by:
      getOptionalRelationshipFilterOrBuilder in interface BulkExportRelationshipsRequestOrBuilder
    • 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 BulkExportRelationshipsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

      public static BulkExportRelationshipsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

      public static BulkExportRelationshipsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

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

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

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

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

      public static BulkExportRelationshipsRequest.Builder newBuilder()
    • newBuilder

    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

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

      public static BulkExportRelationshipsRequest getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<BulkExportRelationshipsRequest> parser()
    • getParserForType

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