Package com.authzed.api.v1

Interface ConsistencyOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    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.
    Consistency.RequirementCase
    getRequirementCase()
     
    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.
    boolean
    hasMinimizeLatency()
    minimize_latency indicates that the latency for the call should be minimized by having the system select the fastest snapshot available.

    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

    • hasMinimizeLatency

      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) = { ... }
      Returns:
      Whether the minimizeLatency field is set.

    • getMinimizeLatency

      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) = { ... }
      Returns:
      The minimizeLatency.

    • hasAtLeastAsFresh

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

    • getAtLeastAsFresh

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

    • getAtLeastAsFreshOrBuilder

      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;

    • hasAtExactSnapshot

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

    • getAtExactSnapshot

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

    • getAtExactSnapshotOrBuilder

      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;

    • hasFullyConsistent

      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) = { ... }
      Returns:
      Whether the fullyConsistent field is set.

    • getFullyConsistent

      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) = { ... }
      Returns:
      The fullyConsistent.

    • getRequirementCase

      Consistency.RequirementCase getRequirementCase()