com.couchbase.client.java.manager.bucket.CompressionMode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation

The official Couchbase Java SDK

There is a newer version: 3.7.6

/*
 * Copyright 2019 Couchbase, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.couchbase.client.java.manager.bucket;

import com.couchbase.client.core.annotation.Stability;
import com.couchbase.client.core.deps.com.fasterxml.jackson.annotation.JsonProperty;

import java.util.Locale;

/**
 * Specifies the compression mode used on the bucket.
 */
@Stability.Volatile
public enum CompressionMode {
  /**
   * Compression mode Off.
   * 
   * Compressed documents are accepted but actively decompressed for storage in memory
   * and for streaming. Not advised!
   */
  OFF,
  /**
   * Compression mode Passive.
   * 

   * Compressed documents can be stored and streamed from the server, but the server does
   * not try to actively compress documents (client-initiated).
   */
  PASSIVE,
  /**
   * Compression mode Active.
   * 
   * The server will try to actively compress documents in memory.
   */
  ACTIVE;

  @Stability.Internal
  public String alias() {
    return name().toLowerCase(Locale.ROOT);
  }

}