Package com.authzed.api.v1

Class Consistency

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.authzed.api.v1.Consistency
All Implemented Interfaces:
ConsistencyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class Consistency extends com.google.protobuf.GeneratedMessage implements ConsistencyOrBuilder
 Consistency will define how a request is handled by the backend.
 By defining a consistency requirement, and a token at which those
 requirements should be applied, where applicable.
Protobuf type authzed.api.v1.Consistency
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Consistency.Builder
    Consistency will define how a request is handled by the backend.
    static enum 
    Consistency.RequirementCase
     

    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
    AT_EXACT_SNAPSHOT_FIELD_NUMBER
     
    static final int
    AT_LEAST_AS_FRESH_FIELD_NUMBER
     
    static final int
    FULLY_CONSISTENT_FIELD_NUMBER
     
    static final int
    MINIMIZE_LATENCY_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)
     
    ZedToken
    getAtExactSnapshot()
    at_exact_snapshot indicates that all data used in the API call must be *at the given* snapshot in time; if the snapshot is no longer available, an error will be returned to the caller.
    ZedTokenOrBuilder
    getAtExactSnapshotOrBuilder()
    at_exact_snapshot indicates that all data used in the API call must be *at the given* snapshot in time; if the snapshot is no longer available, an error will be returned to the caller.
    ZedToken
    getAtLeastAsFresh()
    at_least_as_fresh indicates that all data used in the API call must be *at least as fresh* as that found in the ZedToken; more recent data might be used if available or faster.
    ZedTokenOrBuilder
    getAtLeastAsFreshOrBuilder()
    at_least_as_fresh indicates that all data used in the API call must be *at least as fresh* as that found in the ZedToken; more recent data might be used if available or faster.
    static Consistency
    getDefaultInstance()
     
    Consistency
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    boolean
    getFullyConsistent()
    fully_consistent indicates that all data used in the API call *must* be at the most recent snapshot found.
    boolean
    getMinimizeLatency()
    minimize_latency indicates that the latency for the call should be minimized by having the system select the fastest snapshot available.
    com.google.protobuf.Parser<Consistency>
    getParserForType()
     
    Consistency.RequirementCase
    getRequirementCase()
     
    int
    getSerializedSize()
     
    boolean
    hasAtExactSnapshot()
    at_exact_snapshot indicates that all data used in the API call must be *at the given* snapshot in time; if the snapshot is no longer available, an error will be returned to the caller.
    boolean
    hasAtLeastAsFresh()
    at_least_as_fresh indicates that all data used in the API call must be *at least as fresh* as that found in the ZedToken; more recent data might be used if available or faster.
    boolean
    hasFullyConsistent()
    fully_consistent indicates that all data used in the API call *must* be at the most recent snapshot found.
    int
    hashCode()
     
    boolean
    hasMinimizeLatency()
    minimize_latency indicates that the latency for the call should be minimized by having the system select the fastest snapshot available.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Consistency.Builder
    newBuilder()
     
    static Consistency.Builder
    newBuilder(Consistency prototype)
     
    Consistency.Builder
    newBuilderForType()
     
    protected Consistency.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Consistency
    parseDelimitedFrom(InputStream input)
     
    static Consistency
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Consistency
    parseFrom(byte[] data)
     
    static Consistency
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Consistency
    parseFrom(com.google.protobuf.ByteString data)
     
    static Consistency
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Consistency
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Consistency
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Consistency
    parseFrom(InputStream input)
     
    static Consistency
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Consistency
    parseFrom(ByteBuffer data)
     
    static Consistency
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Consistency>
    parser()
     
    Consistency.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

    • MINIMIZE_LATENCY_FIELD_NUMBER

      public static final int MINIMIZE_LATENCY_FIELD_NUMBER
      See Also:

    • AT_LEAST_AS_FRESH_FIELD_NUMBER

      public static final int AT_LEAST_AS_FRESH_FIELD_NUMBER
      See Also:

    • AT_EXACT_SNAPSHOT_FIELD_NUMBER

      public static final int AT_EXACT_SNAPSHOT_FIELD_NUMBER
      See Also:

    • FULLY_CONSISTENT_FIELD_NUMBER

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

    • getRequirementCase

      public Consistency.RequirementCase getRequirementCase()
      Specified by:
      getRequirementCase in interface ConsistencyOrBuilder

    • hasMinimizeLatency

      public boolean hasMinimizeLatency()
       minimize_latency indicates that the latency for the call should be
 minimized by having the system select the fastest snapshot available.
      bool minimize_latency = 1 [(.validate.rules) = { ... }
      Specified by:
      hasMinimizeLatency in interface ConsistencyOrBuilder
      Returns:
      Whether the minimizeLatency field is set.

    • getMinimizeLatency

      public boolean getMinimizeLatency()
       minimize_latency indicates that the latency for the call should be
 minimized by having the system select the fastest snapshot available.
      bool minimize_latency = 1 [(.validate.rules) = { ... }
      Specified by:
      getMinimizeLatency in interface ConsistencyOrBuilder
      Returns:
      The minimizeLatency.

    • hasAtLeastAsFresh

      public boolean hasAtLeastAsFresh()
       at_least_as_fresh indicates that all data used in the API call must be
 *at least as fresh* as that found in the ZedToken; more recent data might
 be used if available or faster.
      .authzed.api.v1.ZedToken at_least_as_fresh = 2;
      Specified by:
      hasAtLeastAsFresh in interface ConsistencyOrBuilder
      Returns:
      Whether the atLeastAsFresh field is set.

    • getAtLeastAsFresh

      public ZedToken getAtLeastAsFresh()
       at_least_as_fresh indicates that all data used in the API call must be
 *at least as fresh* as that found in the ZedToken; more recent data might
 be used if available or faster.
      .authzed.api.v1.ZedToken at_least_as_fresh = 2;
      Specified by:
      getAtLeastAsFresh in interface ConsistencyOrBuilder
      Returns:
      The atLeastAsFresh.

    • getAtLeastAsFreshOrBuilder

      public ZedTokenOrBuilder getAtLeastAsFreshOrBuilder()
       at_least_as_fresh indicates that all data used in the API call must be
 *at least as fresh* as that found in the ZedToken; more recent data might
 be used if available or faster.
      .authzed.api.v1.ZedToken at_least_as_fresh = 2;
      Specified by:
      getAtLeastAsFreshOrBuilder in interface ConsistencyOrBuilder

    • hasAtExactSnapshot

      public boolean hasAtExactSnapshot()
       at_exact_snapshot indicates that all data used in the API call must be
 *at the given* snapshot in time; if the snapshot is no longer available,
 an error will be returned to the caller.
      .authzed.api.v1.ZedToken at_exact_snapshot = 3;
      Specified by:
      hasAtExactSnapshot in interface ConsistencyOrBuilder
      Returns:
      Whether the atExactSnapshot field is set.

    • getAtExactSnapshot

      public ZedToken getAtExactSnapshot()
       at_exact_snapshot indicates that all data used in the API call must be
 *at the given* snapshot in time; if the snapshot is no longer available,
 an error will be returned to the caller.
      .authzed.api.v1.ZedToken at_exact_snapshot = 3;
      Specified by:
      getAtExactSnapshot in interface ConsistencyOrBuilder
      Returns:
      The atExactSnapshot.

    • getAtExactSnapshotOrBuilder

      public ZedTokenOrBuilder getAtExactSnapshotOrBuilder()
       at_exact_snapshot indicates that all data used in the API call must be
 *at the given* snapshot in time; if the snapshot is no longer available,
 an error will be returned to the caller.
      .authzed.api.v1.ZedToken at_exact_snapshot = 3;
      Specified by:
      getAtExactSnapshotOrBuilder in interface ConsistencyOrBuilder

    • hasFullyConsistent

      public boolean hasFullyConsistent()
       fully_consistent indicates that all data used in the API call *must* be
 at the most recent snapshot found.

 NOTE: using this method can be *quite slow*, so unless there is a need to
 do so, it is recommended to use `at_least_as_fresh` with a stored
 ZedToken.
      bool fully_consistent = 4 [(.validate.rules) = { ... }
      Specified by:
      hasFullyConsistent in interface ConsistencyOrBuilder
      Returns:
      Whether the fullyConsistent field is set.

    • getFullyConsistent

      public boolean getFullyConsistent()
       fully_consistent indicates that all data used in the API call *must* be
 at the most recent snapshot found.

 NOTE: using this method can be *quite slow*, so unless there is a need to
 do so, it is recommended to use `at_least_as_fresh` with a stored
 ZedToken.
      bool fully_consistent = 4 [(.validate.rules) = { ... }
      Specified by:
      getFullyConsistent in interface ConsistencyOrBuilder
      Returns:
      The fullyConsistent.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Consistency.Builder newBuilder()

    • newBuilder

      public static Consistency.Builder newBuilder(Consistency prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Consistency getDefaultInstance()

    • parser

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

    • getParserForType

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