Package com.authzed.api.materialize.v0

Class WatchPermissionSetsResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.authzed.api.materialize.v0.WatchPermissionSetsResponse
All Implemented Interfaces:
WatchPermissionSetsResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class WatchPermissionSetsResponse extends com.google.protobuf.GeneratedMessage implements WatchPermissionSetsResponseOrBuilder
Protobuf type authzed.api.materialize.v0.WatchPermissionSetsResponse
See Also:

  • Field Details

    • CHANGE_FIELD_NUMBER

      public static final int CHANGE_FIELD_NUMBER
      See Also:

    • COMPLETED_REVISION_FIELD_NUMBER

      public static final int COMPLETED_REVISION_FIELD_NUMBER
      See Also:

    • LOOKUP_PERMISSION_SETS_REQUIRED_FIELD_NUMBER

      public static final int LOOKUP_PERMISSION_SETS_REQUIRED_FIELD_NUMBER
      See Also:

    • BREAKING_SCHEMA_CHANGE_FIELD_NUMBER

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

    • getResponseCase

      public WatchPermissionSetsResponse.ResponseCase getResponseCase()
      Specified by:
      getResponseCase in interface WatchPermissionSetsResponseOrBuilder

    • hasChange

      public boolean hasChange()
       change is the permission set delta that has occurred as result of a mutation in origin SpiceDB.
 The consumer should apply this change to the current state of the permission sets in their target system.
 Once an event arrives with completed_revision instead, the consumer shall consider the set of
 changes originating from that revision completed.

 The consumer should keep track of the revision in order to resume streaming in the event of consumer restarts.
      .authzed.api.materialize.v0.PermissionSetChange change = 1;
      Specified by:
      hasChange in interface WatchPermissionSetsResponseOrBuilder
      Returns:
      Whether the change field is set.

    • getChange

      public PermissionSetChange getChange()
       change is the permission set delta that has occurred as result of a mutation in origin SpiceDB.
 The consumer should apply this change to the current state of the permission sets in their target system.
 Once an event arrives with completed_revision instead, the consumer shall consider the set of
 changes originating from that revision completed.

 The consumer should keep track of the revision in order to resume streaming in the event of consumer restarts.
      .authzed.api.materialize.v0.PermissionSetChange change = 1;
      Specified by:
      getChange in interface WatchPermissionSetsResponseOrBuilder
      Returns:
      The change.

    • getChangeOrBuilder

      public PermissionSetChangeOrBuilder getChangeOrBuilder()
       change is the permission set delta that has occurred as result of a mutation in origin SpiceDB.
 The consumer should apply this change to the current state of the permission sets in their target system.
 Once an event arrives with completed_revision instead, the consumer shall consider the set of
 changes originating from that revision completed.

 The consumer should keep track of the revision in order to resume streaming in the event of consumer restarts.
      .authzed.api.materialize.v0.PermissionSetChange change = 1;
      Specified by:
      getChangeOrBuilder in interface WatchPermissionSetsResponseOrBuilder

    • hasCompletedRevision

      public boolean hasCompletedRevision()
       completed_revision is the revision token that indicates the completion of a set of changes. It may also be
 received without accompanying set of changes, indicating that a mutation in the origin SpiceDB cluster did
 not yield any effective changes in the permission sets
      .authzed.api.v1.ZedToken completed_revision = 2;
      Specified by:
      hasCompletedRevision in interface WatchPermissionSetsResponseOrBuilder
      Returns:
      Whether the completedRevision field is set.

    • getCompletedRevision

      public ZedToken getCompletedRevision()
       completed_revision is the revision token that indicates the completion of a set of changes. It may also be
 received without accompanying set of changes, indicating that a mutation in the origin SpiceDB cluster did
 not yield any effective changes in the permission sets
      .authzed.api.v1.ZedToken completed_revision = 2;
      Specified by:
      getCompletedRevision in interface WatchPermissionSetsResponseOrBuilder
      Returns:
      The completedRevision.

    • getCompletedRevisionOrBuilder

      public ZedTokenOrBuilder getCompletedRevisionOrBuilder()
       completed_revision is the revision token that indicates the completion of a set of changes. It may also be
 received without accompanying set of changes, indicating that a mutation in the origin SpiceDB cluster did
 not yield any effective changes in the permission sets
      .authzed.api.v1.ZedToken completed_revision = 2;
      Specified by:
      getCompletedRevisionOrBuilder in interface WatchPermissionSetsResponseOrBuilder

    • hasLookupPermissionSetsRequired

      public boolean hasLookupPermissionSetsRequired()
       lookup_permission_sets_required is a signal that the consumer should perform a LookupPermissionSets call because
 the permission set snapshot needs to be rebuilt from scratch. This typically happens when the origin SpiceDB
 cluster has seen its schema changed.
      .authzed.api.materialize.v0.LookupPermissionSetsRequired lookup_permission_sets_required = 3;
      Specified by:
      hasLookupPermissionSetsRequired in interface WatchPermissionSetsResponseOrBuilder
      Returns:
      Whether the lookupPermissionSetsRequired field is set.

    • getLookupPermissionSetsRequired

      public LookupPermissionSetsRequired getLookupPermissionSetsRequired()
       lookup_permission_sets_required is a signal that the consumer should perform a LookupPermissionSets call because
 the permission set snapshot needs to be rebuilt from scratch. This typically happens when the origin SpiceDB
 cluster has seen its schema changed.
      .authzed.api.materialize.v0.LookupPermissionSetsRequired lookup_permission_sets_required = 3;
      Specified by:
      getLookupPermissionSetsRequired in interface WatchPermissionSetsResponseOrBuilder
      Returns:
      The lookupPermissionSetsRequired.

    • getLookupPermissionSetsRequiredOrBuilder

      public LookupPermissionSetsRequiredOrBuilder getLookupPermissionSetsRequiredOrBuilder()
       lookup_permission_sets_required is a signal that the consumer should perform a LookupPermissionSets call because
 the permission set snapshot needs to be rebuilt from scratch. This typically happens when the origin SpiceDB
 cluster has seen its schema changed.
      .authzed.api.materialize.v0.LookupPermissionSetsRequired lookup_permission_sets_required = 3;
      Specified by:
      getLookupPermissionSetsRequiredOrBuilder in interface WatchPermissionSetsResponseOrBuilder

    • hasBreakingSchemaChange

      public boolean hasBreakingSchemaChange()
       breaking_schema_change is a signal that a breaking schema change has been written to the origin SpiceDB cluster,
 and that the consumer should expect delays in the ingestion of new changes,
 because the permission set snapshot needs to be rebuilt from scratch. Once the snapshot is ready, the consumer
 will receive a LookupPermissionSetsRequired event.
      .authzed.api.materialize.v0.BreakingSchemaChange breaking_schema_change = 4;
      Specified by:
      hasBreakingSchemaChange in interface WatchPermissionSetsResponseOrBuilder
      Returns:
      Whether the breakingSchemaChange field is set.

    • getBreakingSchemaChange

      public BreakingSchemaChange getBreakingSchemaChange()
       breaking_schema_change is a signal that a breaking schema change has been written to the origin SpiceDB cluster,
 and that the consumer should expect delays in the ingestion of new changes,
 because the permission set snapshot needs to be rebuilt from scratch. Once the snapshot is ready, the consumer
 will receive a LookupPermissionSetsRequired event.
      .authzed.api.materialize.v0.BreakingSchemaChange breaking_schema_change = 4;
      Specified by:
      getBreakingSchemaChange in interface WatchPermissionSetsResponseOrBuilder
      Returns:
      The breakingSchemaChange.

    • getBreakingSchemaChangeOrBuilder

      public BreakingSchemaChangeOrBuilder getBreakingSchemaChangeOrBuilder()
       breaking_schema_change is a signal that a breaking schema change has been written to the origin SpiceDB cluster,
 and that the consumer should expect delays in the ingestion of new changes,
 because the permission set snapshot needs to be rebuilt from scratch. Once the snapshot is ready, the consumer
 will receive a LookupPermissionSetsRequired event.
      .authzed.api.materialize.v0.BreakingSchemaChange breaking_schema_change = 4;
      Specified by:
      getBreakingSchemaChangeOrBuilder in interface WatchPermissionSetsResponseOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static WatchPermissionSetsResponse.Builder newBuilder()

    • newBuilder

      public static WatchPermissionSetsResponse.Builder newBuilder(WatchPermissionSetsResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static WatchPermissionSetsResponse getDefaultInstance()

    • parser

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

    • getParserForType

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