Package com.authzed.api.v1

Class WatchResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.authzed.api.v1.WatchResponse
All Implemented Interfaces:
WatchResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class WatchResponse extends com.google.protobuf.GeneratedMessage implements WatchResponseOrBuilder
 WatchResponse contains all mutation events in ascending timestamp order.
 This excludes relationships that were deleted because they expired.
 The response includes a field that can be used to resume
 watching from that point.
Protobuf type authzed.api.v1.WatchResponse
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    WatchResponse.Builder
    WatchResponse contains all mutation events in ascending timestamp order.

    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
    CHANGES_THROUGH_FIELD_NUMBER
     
    static final int
    FULL_REVISION_METADATA_FIELD_NUMBER
     
    static final int
    IS_CHECKPOINT_FIELD_NUMBER
     
    static final int
    OPTIONAL_TRANSACTION_METADATA_FIELD_NUMBER
     
    static final int
    SCHEMA_UPDATED_FIELD_NUMBER
     
    static final int
    UPDATES_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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)
     
    ZedToken
    getChangesThrough()
    changes_through is the ZedToken that represents the point in time that the watch response is current through.
    ZedTokenOrBuilder
    getChangesThroughOrBuilder()
    changes_through is the ZedToken that represents the point in time that the watch response is current through.
    static WatchResponse
    getDefaultInstance()
     
    WatchResponse
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Struct
    getFullRevisionMetadata(int index)
    full_revision_metadata contains all transaction metadata given to SpiceDB during the revision that produced the changes in this response.
    int
    getFullRevisionMetadataCount()
    full_revision_metadata contains all transaction metadata given to SpiceDB during the revision that produced the changes in this response.
    List<com.google.protobuf.Struct>
    getFullRevisionMetadataList()
    full_revision_metadata contains all transaction metadata given to SpiceDB during the revision that produced the changes in this response.
    com.google.protobuf.StructOrBuilder
    getFullRevisionMetadataOrBuilder(int index)
    full_revision_metadata contains all transaction metadata given to SpiceDB during the revision that produced the changes in this response.
    List<? extends com.google.protobuf.StructOrBuilder>
    getFullRevisionMetadataOrBuilderList()
    full_revision_metadata contains all transaction metadata given to SpiceDB during the revision that produced the changes in this response.
    boolean
    getIsCheckpoint()
    is_checkpoint, if true, indicates that a checkpoint was reached.
    com.google.protobuf.Struct
    getOptionalTransactionMetadata()
    optional_transaction_metadata is an optional field that returns the transaction metadata given to SpiceDB during the transaction that produced the changes in this response.
    com.google.protobuf.StructOrBuilder
    getOptionalTransactionMetadataOrBuilder()
    optional_transaction_metadata is an optional field that returns the transaction metadata given to SpiceDB during the transaction that produced the changes in this response.
    com.google.protobuf.Parser<WatchResponse>
    getParserForType()
     
    boolean
    getSchemaUpdated()
    schema_updated, if true, indicates that the schema was changed in this revision.
    int
    getSerializedSize()
     
    RelationshipUpdate
    getUpdates(int index)
    updates are the RelationshipUpdate events that have occurred since the call was made, or since the point in time specified by changes_through.
    int
    getUpdatesCount()
    updates are the RelationshipUpdate events that have occurred since the call was made, or since the point in time specified by changes_through.
    List<RelationshipUpdate>
    getUpdatesList()
    updates are the RelationshipUpdate events that have occurred since the call was made, or since the point in time specified by changes_through.
    RelationshipUpdateOrBuilder
    getUpdatesOrBuilder(int index)
    updates are the RelationshipUpdate events that have occurred since the call was made, or since the point in time specified by changes_through.
    List<? extends RelationshipUpdateOrBuilder>
    getUpdatesOrBuilderList()
    updates are the RelationshipUpdate events that have occurred since the call was made, or since the point in time specified by changes_through.
    boolean
    hasChangesThrough()
    changes_through is the ZedToken that represents the point in time that the watch response is current through.
    int
    hashCode()
     
    boolean
    hasOptionalTransactionMetadata()
    optional_transaction_metadata is an optional field that returns the transaction metadata given to SpiceDB during the transaction that produced the changes in this response.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static WatchResponse.Builder
    newBuilder()
     
    static WatchResponse.Builder
    newBuilder(WatchResponse prototype)
     
    WatchResponse.Builder
    newBuilderForType()
     
    protected WatchResponse.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static WatchResponse
    parseDelimitedFrom(InputStream input)
     
    static WatchResponse
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WatchResponse
    parseFrom(byte[] data)
     
    static WatchResponse
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WatchResponse
    parseFrom(com.google.protobuf.ByteString data)
     
    static WatchResponse
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WatchResponse
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static WatchResponse
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WatchResponse
    parseFrom(InputStream input)
     
    static WatchResponse
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WatchResponse
    parseFrom(ByteBuffer data)
     
    static WatchResponse
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<WatchResponse>
    parser()
     
    WatchResponse.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, makeExtensionsImmutable, 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

    • UPDATES_FIELD_NUMBER

      public static final int UPDATES_FIELD_NUMBER
      See Also:

    • CHANGES_THROUGH_FIELD_NUMBER

      public static final int CHANGES_THROUGH_FIELD_NUMBER
      See Also:

    • OPTIONAL_TRANSACTION_METADATA_FIELD_NUMBER

      public static final int OPTIONAL_TRANSACTION_METADATA_FIELD_NUMBER
      See Also:

    • SCHEMA_UPDATED_FIELD_NUMBER

      public static final int SCHEMA_UPDATED_FIELD_NUMBER
      See Also:

    • IS_CHECKPOINT_FIELD_NUMBER

      public static final int IS_CHECKPOINT_FIELD_NUMBER
      See Also:

    • FULL_REVISION_METADATA_FIELD_NUMBER

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

    • getUpdatesList

      public List<RelationshipUpdate> getUpdatesList()
       updates are the RelationshipUpdate events that have occurred since the
 call was made, or since the point in time specified by changes_through.
      repeated .authzed.api.v1.RelationshipUpdate updates = 1;
      Specified by:
      getUpdatesList in interface WatchResponseOrBuilder

    • getUpdatesOrBuilderList

      public List<? extends RelationshipUpdateOrBuilder> getUpdatesOrBuilderList()
       updates are the RelationshipUpdate events that have occurred since the
 call was made, or since the point in time specified by changes_through.
      repeated .authzed.api.v1.RelationshipUpdate updates = 1;
      Specified by:
      getUpdatesOrBuilderList in interface WatchResponseOrBuilder

    • getUpdatesCount

      public int getUpdatesCount()
       updates are the RelationshipUpdate events that have occurred since the
 call was made, or since the point in time specified by changes_through.
      repeated .authzed.api.v1.RelationshipUpdate updates = 1;
      Specified by:
      getUpdatesCount in interface WatchResponseOrBuilder

    • getUpdates

      public RelationshipUpdate getUpdates(int index)
       updates are the RelationshipUpdate events that have occurred since the
 call was made, or since the point in time specified by changes_through.
      repeated .authzed.api.v1.RelationshipUpdate updates = 1;
      Specified by:
      getUpdates in interface WatchResponseOrBuilder

    • getUpdatesOrBuilder

      public RelationshipUpdateOrBuilder getUpdatesOrBuilder(int index)
       updates are the RelationshipUpdate events that have occurred since the
 call was made, or since the point in time specified by changes_through.
      repeated .authzed.api.v1.RelationshipUpdate updates = 1;
      Specified by:
      getUpdatesOrBuilder in interface WatchResponseOrBuilder

    • hasChangesThrough

      public boolean hasChangesThrough()
       changes_through is the ZedToken that represents the point in time
 that the watch response is current through. This token can be used
 in a subsequent WatchRequest to resume watching from this point.
      .authzed.api.v1.ZedToken changes_through = 2;
      Specified by:
      hasChangesThrough in interface WatchResponseOrBuilder
      Returns:
      Whether the changesThrough field is set.

    • getChangesThrough

      public ZedToken getChangesThrough()
       changes_through is the ZedToken that represents the point in time
 that the watch response is current through. This token can be used
 in a subsequent WatchRequest to resume watching from this point.
      .authzed.api.v1.ZedToken changes_through = 2;
      Specified by:
      getChangesThrough in interface WatchResponseOrBuilder
      Returns:
      The changesThrough.

    • getChangesThroughOrBuilder

      public ZedTokenOrBuilder getChangesThroughOrBuilder()
       changes_through is the ZedToken that represents the point in time
 that the watch response is current through. This token can be used
 in a subsequent WatchRequest to resume watching from this point.
      .authzed.api.v1.ZedToken changes_through = 2;
      Specified by:
      getChangesThroughOrBuilder in interface WatchResponseOrBuilder

    • hasOptionalTransactionMetadata

      public boolean hasOptionalTransactionMetadata()
       optional_transaction_metadata is an optional field that returns the transaction metadata
 given to SpiceDB during the transaction that produced the changes in this response.
 This field may not exist if no transaction metadata was provided, or if multiple pieces
 of metadata were found during the transaction (in which case it is ambiguous which to return).
      .google.protobuf.Struct optional_transaction_metadata = 3;
      Specified by:
      hasOptionalTransactionMetadata in interface WatchResponseOrBuilder
      Returns:
      Whether the optionalTransactionMetadata field is set.

    • getOptionalTransactionMetadata

      public com.google.protobuf.Struct getOptionalTransactionMetadata()
       optional_transaction_metadata is an optional field that returns the transaction metadata
 given to SpiceDB during the transaction that produced the changes in this response.
 This field may not exist if no transaction metadata was provided, or if multiple pieces
 of metadata were found during the transaction (in which case it is ambiguous which to return).
      .google.protobuf.Struct optional_transaction_metadata = 3;
      Specified by:
      getOptionalTransactionMetadata in interface WatchResponseOrBuilder
      Returns:
      The optionalTransactionMetadata.

    • getOptionalTransactionMetadataOrBuilder

      public com.google.protobuf.StructOrBuilder getOptionalTransactionMetadataOrBuilder()
       optional_transaction_metadata is an optional field that returns the transaction metadata
 given to SpiceDB during the transaction that produced the changes in this response.
 This field may not exist if no transaction metadata was provided, or if multiple pieces
 of metadata were found during the transaction (in which case it is ambiguous which to return).
      .google.protobuf.Struct optional_transaction_metadata = 3;
      Specified by:
      getOptionalTransactionMetadataOrBuilder in interface WatchResponseOrBuilder

    • getSchemaUpdated

      public boolean getSchemaUpdated()
       schema_updated, if true, indicates that the schema was changed in this revision.
      bool schema_updated = 4;
      Specified by:
      getSchemaUpdated in interface WatchResponseOrBuilder
      Returns:
      The schemaUpdated.

    • getIsCheckpoint

      public boolean getIsCheckpoint()
       is_checkpoint, if true, indicates that a checkpoint was reached.
 A checkpoint indicates that the server guarantees that the client
 will not observe any changes at a revision below or equal to the revision in this response.
      bool is_checkpoint = 5;
      Specified by:
      getIsCheckpoint in interface WatchResponseOrBuilder
      Returns:
      The isCheckpoint.

    • getFullRevisionMetadataList

      public List<com.google.protobuf.Struct> getFullRevisionMetadataList()
       full_revision_metadata contains all transaction metadata given to SpiceDB during the
 revision that produced the changes in this response. Some datastores (such as CockroachDB)
 can "merge" multiple transactions into a single revision (if the changes occurred concurrently),
 so this field is a list of all transaction metadata seen during the revision.
      repeated .google.protobuf.Struct full_revision_metadata = 6;
      Specified by:
      getFullRevisionMetadataList in interface WatchResponseOrBuilder

    • getFullRevisionMetadataOrBuilderList

      public List<? extends com.google.protobuf.StructOrBuilder> getFullRevisionMetadataOrBuilderList()
       full_revision_metadata contains all transaction metadata given to SpiceDB during the
 revision that produced the changes in this response. Some datastores (such as CockroachDB)
 can "merge" multiple transactions into a single revision (if the changes occurred concurrently),
 so this field is a list of all transaction metadata seen during the revision.
      repeated .google.protobuf.Struct full_revision_metadata = 6;
      Specified by:
      getFullRevisionMetadataOrBuilderList in interface WatchResponseOrBuilder

    • getFullRevisionMetadataCount

      public int getFullRevisionMetadataCount()
       full_revision_metadata contains all transaction metadata given to SpiceDB during the
 revision that produced the changes in this response. Some datastores (such as CockroachDB)
 can "merge" multiple transactions into a single revision (if the changes occurred concurrently),
 so this field is a list of all transaction metadata seen during the revision.
      repeated .google.protobuf.Struct full_revision_metadata = 6;
      Specified by:
      getFullRevisionMetadataCount in interface WatchResponseOrBuilder

    • getFullRevisionMetadata

      public com.google.protobuf.Struct getFullRevisionMetadata(int index)
       full_revision_metadata contains all transaction metadata given to SpiceDB during the
 revision that produced the changes in this response. Some datastores (such as CockroachDB)
 can "merge" multiple transactions into a single revision (if the changes occurred concurrently),
 so this field is a list of all transaction metadata seen during the revision.
      repeated .google.protobuf.Struct full_revision_metadata = 6;
      Specified by:
      getFullRevisionMetadata in interface WatchResponseOrBuilder

    • getFullRevisionMetadataOrBuilder

      public com.google.protobuf.StructOrBuilder getFullRevisionMetadataOrBuilder(int index)
       full_revision_metadata contains all transaction metadata given to SpiceDB during the
 revision that produced the changes in this response. Some datastores (such as CockroachDB)
 can "merge" multiple transactions into a single revision (if the changes occurred concurrently),
 so this field is a list of all transaction metadata seen during the revision.
      repeated .google.protobuf.Struct full_revision_metadata = 6;
      Specified by:
      getFullRevisionMetadataOrBuilder in interface WatchResponseOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static WatchResponse.Builder newBuilder()

    • newBuilder

      public static WatchResponse.Builder newBuilder(WatchResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static WatchResponse getDefaultInstance()

    • parser

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

    • getParserForType

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