Class CompressionPolicy

java.lang.Object

org.apache.pulsar.client.api.v5.config.CompressionPolicy

public final class CompressionPolicy
extends Object

Compression configuration for producer message payloads.

The dominant configuration is the codec, so of(CompressionType) is the primary entry point. Use builder() if you need to set additional knobs in the future.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CompressionPolicy.Builder	Builder for CompressionPolicy.

Method Summary

Modifier and Type	Method	Description
static CompressionPolicy.Builder	builder()
static CompressionPolicy	disabled()	No compression.
static CompressionPolicy	of(CompressionType type)	Create a compression policy with the given codec.
CompressionType	type()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

type

public CompressionType type()

Returns:

the compression codec

disabled

public static CompressionPolicy disabled()

No compression.

Returns:

a CompressionPolicy with compression disabled

of

public static CompressionPolicy of(CompressionType type)

Create a compression policy with the given codec.

Parameters:

type - the compression codec to use for message payloads

Returns:

a CompressionPolicy configured with the specified codec

builder

public static CompressionPolicy.Builder builder()

Returns:

a new builder for constructing a CompressionPolicy