Interface Options

Top-level Fluvio Client options;

These options are unstable and may be categorized into more specific interfaces; For now, this is the global options used by the entirety of the fluvio client;

It is best practice to use explicit arguments directly with the class methods If an option or argument does not exist that is optional, a default value will be used.

interface Options {
    encryption?: Encryption;
    env?: EnvVar[];
    host?: string;
    id?: number;
    ignoreRackAssignment?: boolean;
    ingress?: IngressAddr[];
    maps?: PartitionMap[];
    minId?: number;
    offsetFrom?: string;
    offsetIndex?: number;
    partition?: number;
    partitions?: number;
    port?: number;
    rack?: string;
    replicas?: number;
    replication?: ReplicationConfig;
    replicationFactor?: number;
    storage?: StorageConfig;
    topic?: string;
}

Properties

encryption? env? host? id? ignoreRackAssignment? ingress? maps? minId? offsetFrom? offsetIndex? partition? partitions? port? rack? replicas? replication? replicationFactor? storage? topic?

Properties

Optionalencryption

encryption?: Encryption

Optionalenv

env?: EnvVar[]

Optionalhost

host?: string

Optionalid

id?: number

OptionalignoreRackAssignment

ignoreRackAssignment?: boolean

Optionalingress

ingress?: IngressAddr[]

Optionalmaps

maps?: PartitionMap[]

OptionalminId

minId?: number

OptionaloffsetFrom

offsetFrom?: string

OptionaloffsetIndex

offsetIndex?: number

Optionalpartition

partition?: number

Optionalpartitions

partitions?: number

Optionalport

port?: number

Optionalrack

rack?: string

Optionalreplicas

replicas?: number

Optionalreplication

replication?: ReplicationConfig

OptionalreplicationFactor

replicationFactor?: number

Optionalstorage

storage?: StorageConfig

Optionaltopic

topic?: string

Settings

Member Visibility

On This Page

encryptionenvhostidignoreRackAssignmentingressmapsminIdoffsetFromoffsetIndexpartitionpartitionsportrackreplicasreplicationreplicationFactorstoragetopic