Interface ExecutableFindByIdOperation.FindByIdWithLock<T>

All Superinterfaces:
ExecutableFindByIdOperation.FindByIdInCollection<T>, ExecutableFindByIdOperation.FindByIdInScope<T>, ExecutableFindByIdOperation.FindByIdWithExpiry<T>, ExecutableFindByIdOperation.FindByIdWithOptions<T>, ExecutableFindByIdOperation.FindByIdWithProjection<T>, ExecutableFindByIdOperation.TerminatingFindById<T>, InCollection<T>, InScope<T>, OneAndAllId<T>, WithExpiry<T>, WithGetOptions<T>, WithLock<T>, WithProjectionId<T>
All Known Subinterfaces:
ExecutableFindByIdOperation.ExecutableFindById<T>
Enclosing interface:
ExecutableFindByIdOperation
public static interface ExecutableFindByIdOperation.FindByIdWithLock<T> extends ExecutableFindByIdOperation.FindByIdWithExpiry<T>, WithLock<T>
Since:
2.0
Author:
Christoph Strobl, Tigran Babloyan

  • Method Details

    • withLock

      ExecutableFindByIdOperation.FindByIdWithExpiry<T> withLock(Duration lockDuration)
      Fetches document and write-locks it for the given duration.

      Note that the client does not enforce an upper limit on the Duration lockTime. The maximum lock time by default on the server is 30 seconds. Any value larger than 30 seconds will be capped down by the server to the default lock time, which is 15 seconds unless modified on the server side.

      Specified by:
      withLock in interface WithLock<T>
      Parameters:
      lockDuration - how long to write-lock the document for (any duration > 30s will be capped to server default of 15s).