apache/pulsar · error · IllegalArgumentException

description should be at most 64 characters

Error message

description should be at most 64 characters

What it means

Builder validation in ClientBuilderImpl.description: the free-form client description string exceeds the 64-character limit imposed because it is carried in the protocol (client_VERSION connection metadata), so longer values would break the wire format; the description argument is the faulty input.

Source

Thrown at pulsar-client/src/main/java/org/apache/pulsar/client/impl/ClientBuilderImpl.java:513

        return this;
    }

    @Override
    public ClientBuilder tlsFactoryConfig(String tlsFactoryConfig) {
        conf.setTlsFactoryConfig(StringUtils.isBlank(tlsFactoryConfig) ? "" : tlsFactoryConfig);
        return this;
    }

    @Override
    public ClientBuilder autoCertRefreshSeconds(int autoCertRefreshSeconds) {
        conf.setAutoCertRefreshSeconds(autoCertRefreshSeconds);
        return this;
    }

    @Override
    public ClientBuilder description(String description) {
        if (description != null && description.length() > 64) {
            throw new IllegalArgumentException("description should be at most 64 characters");
        }
        conf.setDescription(description);
        return this;
    }

    @Override
    public ClientBuilder sharedResources(PulsarClientSharedResources sharedResources) {
        this.sharedResources = (PulsarClientSharedResourcesImpl) sharedResources;
        return this;
    }

    @Override
    public ClientBuilder lookupProperties(Map<String, String> properties) {
        conf.setLookupProperties(properties);
        return this;
    }
}

View on GitHub (pinned to 820761864e)

Solutions

  1. Shorten the description to at most 64 characters
Defensive patterns

Strategy: validation

When it happens

Trigger: Thrown at pulsar-client/src/main/java/org/apache/pulsar/client/impl/ClientBuilderImpl.java:513 when the library encounters an invalid state.

Common situations: See trigger scenarios.


AI-assisted analysis of apache/pulsar@820761864e (2026-09-06). Data as JSON: /api/errors/8b1a35abb38d2c67. Report an issue: GitHub.