Package com.couchbase.client.java.kv

Class ReplaceOptions

java.lang.Object
com.couchbase.client.java.CommonOptions<SELF>
com.couchbase.client.java.kv.CommonDurabilityOptions<ReplaceOptions>
com.couchbase.client.java.kv.ReplaceOptions
public class ReplaceOptions
extends CommonDurabilityOptions<ReplaceOptions>

  • Method Details

    • replaceOptions

      public static ReplaceOptions replaceOptions()

    • expiry

      public ReplaceOptions expiry​(Duration expiry)
      Sets the expiry time for the document as a relative duration.

      IMPORTANT: we recommend using a relative duration only if the provided value is less than 30 days. The reason is that the server will assume any value larger than that to be an absolute unix timestamp. The SDK tries its best to coerce it into sane values, but to avoid any unexpected behavior please stick to the less than 30 days as a relative duration. For every expiry > 30 days, please provide it as an absolute instant through the expiry(Instant) overload.

      Parameters:
      expiry - the expiry time as a relative duration.
      Returns:
      this ReplaceOptions for chaining purposes.

    • expiry

      public ReplaceOptions expiry​(Instant expiry)
      Sets the expiry time for the document as a absolute duration.

      Note that the absolute instant will be converted into a unix timestamp in seconds before sending it over the wire to the server. If you need to provide a relative duration you can use expiry(Duration) but please see its javadoc for common pitfalls and edge cases. If in doubt, please provide it as an absolute instant on this overload.

      Parameters:
      expiry - the expiry time as an absolute instant.
      Returns:
      this ReplaceOptions for chaining purposes.

    • transcoder

      public ReplaceOptions transcoder​(Transcoder transcoder)
      Allows to specify a custom transcoder that is used to encode the content of the request.
      Parameters:
      transcoder - the custom transcoder that should be used for encoding.
      Returns:
      the ReplaceOptions to allow method chaining.

    • cas

      public ReplaceOptions cas​(long cas)
      Specifies a CAS value that will be taken into account on the server side for optimistic concurrency.

      The CAS value is an opaque identifier which is associated with a specific state of the document on the server. The CAS value is received on read operations (or after mutations) and can be used during a subsequent mutation to make sure that the document has not been modified in the meantime.

      If document on the server has been modified in the meantime the SDK will raise a CasMismatchException. In this case the caller is expected to re-do the whole "fetch-modify-update" cycle again. Please refer to the SDK documentation for more information on CAS mismatches and subsequent retries.

      Parameters:
      cas - the opaque CAS identifier to use for this operation.
      Returns:
      the ReplaceOptions for chaining purposes.

    • build

      @Internal public ReplaceOptions.Built build()