Package com.authzed.api.v1

Interface WatchResponseOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
WatchResponse, WatchResponse.Builder
@Generated public interface WatchResponseOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    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.
    boolean
    getSchemaUpdated()
    schema_updated, if true, indicates that the schema was changed in this revision.
    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.
    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.

    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

    • getUpdatesList

      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;

    • getUpdates

      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;

    • getUpdatesCount

      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;

    • getUpdatesOrBuilderList

      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;

    • getUpdatesOrBuilder

      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;

    • hasChangesThrough

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

    • getChangesThrough

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

    • getChangesThroughOrBuilder

      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;

    • hasOptionalTransactionMetadata

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

    • getOptionalTransactionMetadata

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

    • getOptionalTransactionMetadataOrBuilder

      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;

    • getSchemaUpdated

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

    • getIsCheckpoint

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

    • getFullRevisionMetadataList

      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;

    • getFullRevisionMetadata

      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;

    • getFullRevisionMetadataCount

      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;

    • getFullRevisionMetadataOrBuilderList

      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;

    • getFullRevisionMetadataOrBuilder

      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;