c

com.couchbase.client.scala.env

CompressionConfig

case class CompressionConfig(enabled: Boolean = core.env.CompressionConfig.DEFAULT_ENABLED, minSize: Int = core.env.CompressionConfig.DEFAULT_MIN_SIZE, minRatio: Double = core.env.CompressionConfig.DEFAULT_MIN_RATIO) extends Product with Serializable

Allows configuring and customizing the compression configuration.

enabled

If compression is enabled or not.

minSize

The minimum size when compression should be performed.

minRatio

The minimum ratio of when a compressed doc should be sent.

Since

1.0.0

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CompressionConfig
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CompressionConfig(enabled: Boolean = core.env.CompressionConfig.DEFAULT_ENABLED, minSize: Int = core.env.CompressionConfig.DEFAULT_MIN_SIZE, minRatio: Double = core.env.CompressionConfig.DEFAULT_MIN_RATIO)

    enabled

    If compression is enabled or not.

    minSize

    The minimum size when compression should be performed.

    minRatio

    The minimum ratio of when a compressed doc should be sent.

Value Members

  1. def enable(enabled: Boolean): CompressionConfig

    If set to false, disabled compression.

    If set to false, disabled compression.

    enabled

    true to enable, false otherwise.

    returns

    this for chaining purposes.

  2. def minRatio(minRatio: Double): CompressionConfig

    The minimum ratio after which a compressed doc is sent compressed versus the uncompressed version is sent for efficiency.

    The minimum ratio after which a compressed doc is sent compressed versus the uncompressed version is sent for efficiency.

    The default is 0.83.

    minRatio

    the minimum ratio.

    returns

    this for chaining purposes.

  3. def minSize(minSize: Int): CompressionConfig

    The minimum size after which compression is performed.

    The minimum size after which compression is performed.

    The default is 32 bytes.

    minSize

    minimum size in bytes.

    returns

    this for chaining purposes.

  4. def productElementNames: Iterator[String]
    Definition Classes
    Product