Package com.authzed.api.v1

Interface WatchRequestOrBuilder

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

  • Method Details

    • getOptionalObjectTypesList

      List<String> getOptionalObjectTypesList()
       optional_object_types is a filter of resource object types to watch for changes.
 If specified, only changes to the specified object types will be returned and
 optional_relationship_filters cannot be used.
      repeated string optional_object_types = 1 [(.validate.rules) = { ... }
      Returns:
      A list containing the optionalObjectTypes.

    • getOptionalObjectTypesCount

      int getOptionalObjectTypesCount()
       optional_object_types is a filter of resource object types to watch for changes.
 If specified, only changes to the specified object types will be returned and
 optional_relationship_filters cannot be used.
      repeated string optional_object_types = 1 [(.validate.rules) = { ... }
      Returns:
      The count of optionalObjectTypes.

    • getOptionalObjectTypes

      String getOptionalObjectTypes(int index)
       optional_object_types is a filter of resource object types to watch for changes.
 If specified, only changes to the specified object types will be returned and
 optional_relationship_filters cannot be used.
      repeated string optional_object_types = 1 [(.validate.rules) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The optionalObjectTypes at the given index.

    • getOptionalObjectTypesBytes

      com.google.protobuf.ByteString getOptionalObjectTypesBytes(int index)
       optional_object_types is a filter of resource object types to watch for changes.
 If specified, only changes to the specified object types will be returned and
 optional_relationship_filters cannot be used.
      repeated string optional_object_types = 1 [(.validate.rules) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the optionalObjectTypes at the given index.

    • hasOptionalStartCursor

      boolean hasOptionalStartCursor()
       optional_start_cursor is the ZedToken holding the point-in-time at
 which to start watching for changes.
 If not specified, the watch will begin at the current head revision
 of the datastore, returning any updates that occur after the caller
 makes the request.
 Note that if this cursor references a point-in-time containing data
 that has been garbage collected, an error will be returned.
      .authzed.api.v1.ZedToken optional_start_cursor = 2;
      Returns:
      Whether the optionalStartCursor field is set.

    • getOptionalStartCursor

      ZedToken getOptionalStartCursor()
       optional_start_cursor is the ZedToken holding the point-in-time at
 which to start watching for changes.
 If not specified, the watch will begin at the current head revision
 of the datastore, returning any updates that occur after the caller
 makes the request.
 Note that if this cursor references a point-in-time containing data
 that has been garbage collected, an error will be returned.
      .authzed.api.v1.ZedToken optional_start_cursor = 2;
      Returns:
      The optionalStartCursor.

    • getOptionalStartCursorOrBuilder

      ZedTokenOrBuilder getOptionalStartCursorOrBuilder()
       optional_start_cursor is the ZedToken holding the point-in-time at
 which to start watching for changes.
 If not specified, the watch will begin at the current head revision
 of the datastore, returning any updates that occur after the caller
 makes the request.
 Note that if this cursor references a point-in-time containing data
 that has been garbage collected, an error will be returned.
      .authzed.api.v1.ZedToken optional_start_cursor = 2;

    • getOptionalRelationshipFiltersList

      List<RelationshipFilter> getOptionalRelationshipFiltersList()
       optional_relationship_filters, if specified, indicates the
 filter(s) to apply to each relationship to be returned by watch.
 The relationship will be returned as long as at least one filter matches,
 this allows clients to match relationships on multiple filters on a single watch call.
 If specified, optional_object_types cannot be used.
      repeated .authzed.api.v1.RelationshipFilter optional_relationship_filters = 3;

    • getOptionalRelationshipFilters

      RelationshipFilter getOptionalRelationshipFilters(int index)
       optional_relationship_filters, if specified, indicates the
 filter(s) to apply to each relationship to be returned by watch.
 The relationship will be returned as long as at least one filter matches,
 this allows clients to match relationships on multiple filters on a single watch call.
 If specified, optional_object_types cannot be used.
      repeated .authzed.api.v1.RelationshipFilter optional_relationship_filters = 3;

    • getOptionalRelationshipFiltersCount

      int getOptionalRelationshipFiltersCount()
       optional_relationship_filters, if specified, indicates the
 filter(s) to apply to each relationship to be returned by watch.
 The relationship will be returned as long as at least one filter matches,
 this allows clients to match relationships on multiple filters on a single watch call.
 If specified, optional_object_types cannot be used.
      repeated .authzed.api.v1.RelationshipFilter optional_relationship_filters = 3;

    • getOptionalRelationshipFiltersOrBuilderList

      List<? extends RelationshipFilterOrBuilder> getOptionalRelationshipFiltersOrBuilderList()
       optional_relationship_filters, if specified, indicates the
 filter(s) to apply to each relationship to be returned by watch.
 The relationship will be returned as long as at least one filter matches,
 this allows clients to match relationships on multiple filters on a single watch call.
 If specified, optional_object_types cannot be used.
      repeated .authzed.api.v1.RelationshipFilter optional_relationship_filters = 3;

    • getOptionalRelationshipFiltersOrBuilder

      RelationshipFilterOrBuilder getOptionalRelationshipFiltersOrBuilder(int index)
       optional_relationship_filters, if specified, indicates the
 filter(s) to apply to each relationship to be returned by watch.
 The relationship will be returned as long as at least one filter matches,
 this allows clients to match relationships on multiple filters on a single watch call.
 If specified, optional_object_types cannot be used.
      repeated .authzed.api.v1.RelationshipFilter optional_relationship_filters = 3;