Package com.authzed.api.v1

Class WatchRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.authzed.api.v1.WatchRequest
All Implemented Interfaces:
WatchRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class WatchRequest extends com.google.protobuf.GeneratedMessage implements WatchRequestOrBuilder
 WatchRequest specifies the object definitions for which we want to start
 watching mutations, and an optional start snapshot for when to start
 watching.
Protobuf type authzed.api.v1.WatchRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    WatchRequest.Builder
    WatchRequest specifies the object definitions for which we want to start watching mutations, and an optional start snapshot for when to start watching.

    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
    OPTIONAL_OBJECT_TYPES_FIELD_NUMBER
     
    static final int
    OPTIONAL_RELATIONSHIP_FILTERS_FIELD_NUMBER
     
    static final int
    OPTIONAL_START_CURSOR_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, 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)
     
    static WatchRequest
    getDefaultInstance()
     
    WatchRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getOptionalObjectTypes(int index)
    optional_object_types is a filter of resource object types to watch for changes.
    com.google.protobuf.ByteString
    getOptionalObjectTypesBytes(int index)
    optional_object_types is a filter of resource object types to watch for changes.
    int
    getOptionalObjectTypesCount()
    optional_object_types is a filter of resource object types to watch for changes.
    com.google.protobuf.ProtocolStringList
    getOptionalObjectTypesList()
    optional_object_types is a filter of resource object types to watch for changes.
    RelationshipFilter
    getOptionalRelationshipFilters(int index)
    optional_relationship_filters, if specified, indicates the filter(s) to apply to each relationship to be returned by watch.
    int
    getOptionalRelationshipFiltersCount()
    optional_relationship_filters, if specified, indicates the filter(s) to apply to each relationship to be returned by watch.
    List<RelationshipFilter>
    getOptionalRelationshipFiltersList()
    optional_relationship_filters, if specified, indicates the filter(s) to apply to each relationship to be returned by watch.
    RelationshipFilterOrBuilder
    getOptionalRelationshipFiltersOrBuilder(int index)
    optional_relationship_filters, if specified, indicates the filter(s) to apply to each relationship to be returned by watch.
    List<? extends RelationshipFilterOrBuilder>
    getOptionalRelationshipFiltersOrBuilderList()
    optional_relationship_filters, if specified, indicates the filter(s) to apply to each relationship to be returned by watch.
    ZedToken
    getOptionalStartCursor()
    optional_start_cursor is the ZedToken holding the point-in-time at which to start watching for changes.
    ZedTokenOrBuilder
    getOptionalStartCursorOrBuilder()
    optional_start_cursor is the ZedToken holding the point-in-time at which to start watching for changes.
    com.google.protobuf.Parser<WatchRequest>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasOptionalStartCursor()
    optional_start_cursor is the ZedToken holding the point-in-time at which to start watching for changes.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static WatchRequest.Builder
    newBuilder()
     
    static WatchRequest.Builder
    newBuilder(WatchRequest prototype)
     
    WatchRequest.Builder
    newBuilderForType()
     
    protected WatchRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static WatchRequest
    parseDelimitedFrom(InputStream input)
     
    static WatchRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WatchRequest
    parseFrom(byte[] data)
     
    static WatchRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WatchRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static WatchRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WatchRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static WatchRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WatchRequest
    parseFrom(InputStream input)
     
    static WatchRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WatchRequest
    parseFrom(ByteBuffer data)
     
    static WatchRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<WatchRequest>
    parser()
     
    WatchRequest.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, 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

    • OPTIONAL_OBJECT_TYPES_FIELD_NUMBER

      public static final int OPTIONAL_OBJECT_TYPES_FIELD_NUMBER
      See Also:

    • OPTIONAL_START_CURSOR_FIELD_NUMBER

      public static final int OPTIONAL_START_CURSOR_FIELD_NUMBER
      See Also:

    • OPTIONAL_RELATIONSHIP_FILTERS_FIELD_NUMBER

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

    • getOptionalObjectTypesList

      public com.google.protobuf.ProtocolStringList 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) = { ... }
      Specified by:
      getOptionalObjectTypesList in interface WatchRequestOrBuilder
      Returns:
      A list containing the optionalObjectTypes.

    • getOptionalObjectTypesCount

      public 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) = { ... }
      Specified by:
      getOptionalObjectTypesCount in interface WatchRequestOrBuilder
      Returns:
      The count of optionalObjectTypes.

    • getOptionalObjectTypes

      public 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) = { ... }
      Specified by:
      getOptionalObjectTypes in interface WatchRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The optionalObjectTypes at the given index.

    • getOptionalObjectTypesBytes

      public 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) = { ... }
      Specified by:
      getOptionalObjectTypesBytes in interface WatchRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the optionalObjectTypes at the given index.

    • hasOptionalStartCursor

      public 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;
      Specified by:
      hasOptionalStartCursor in interface WatchRequestOrBuilder
      Returns:
      Whether the optionalStartCursor field is set.

    • getOptionalStartCursor

      public 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;
      Specified by:
      getOptionalStartCursor in interface WatchRequestOrBuilder
      Returns:
      The optionalStartCursor.

    • getOptionalStartCursorOrBuilder

      public 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;
      Specified by:
      getOptionalStartCursorOrBuilder in interface WatchRequestOrBuilder

    • getOptionalRelationshipFiltersList

      public 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;
      Specified by:
      getOptionalRelationshipFiltersList in interface WatchRequestOrBuilder

    • getOptionalRelationshipFiltersOrBuilderList

      public 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;
      Specified by:
      getOptionalRelationshipFiltersOrBuilderList in interface WatchRequestOrBuilder

    • getOptionalRelationshipFiltersCount

      public 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;
      Specified by:
      getOptionalRelationshipFiltersCount in interface WatchRequestOrBuilder

    • getOptionalRelationshipFilters

      public 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;
      Specified by:
      getOptionalRelationshipFilters in interface WatchRequestOrBuilder

    • getOptionalRelationshipFiltersOrBuilder

      public 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;
      Specified by:
      getOptionalRelationshipFiltersOrBuilder in interface WatchRequestOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static WatchRequest.Builder newBuilder()

    • newBuilder

      public static WatchRequest.Builder newBuilder(WatchRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static WatchRequest getDefaultInstance()

    • parser

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

    • getParserForType

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