config.go

// Copyright © 2024 Meroxa, 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 pulsar

import (
	"time"
)

//go:generate paramgen -output=paramgen_src.go SourceConfig
//go:generate paramgen -output=paramgen_dest.go DestinationConfig

type Config struct {
	// URL of the Pulsar instance to connect to.
	URL string `json:"url" validate:"required"`

	// Topic specifies the Pulsar topic used by the connector.
	Topic string `json:"topic" validate:"required"`

	// ConnectionTimeout specifies the duration for which the client will
	// attempt to establish a connection before timing out.
	ConnectionTimeout time.Duration `json:"connectionTimeout"`

	// OperationTimeout is the duration after which an operation is considered
	// to have timed out.
	OperationTimeout time.Duration `json:"operationTimeout"`

	// MaxConnectionsPerBroker limits the number of connections to each broker.
	MaxConnectionsPerBroker int `json:"maxConnectionsPerBroker"`

	// MemoryLimitBytes sets the memory limit for the client in bytes.
	// If the limit is exceeded, the client may start to block or fail operations.
	MemoryLimitBytes int64 `json:"memoryLimitBytes"`

	// EnableTransaction determines if the client should support transactions.
	EnableTransaction bool `json:"enableTransaction"`

	// TLSKeyFilePath sets the path to the TLS key file
	TLSKeyFilePath string `json:"tlsKeyFilePath"`

	// TLSCertificateFile sets the path to the TLS certificate file
	TLSCertificateFile string `json:"tlsCertificateFile"`

	// TLSTrustCertsFilePath sets the path to the trusted TLS certificate file
	TLSTrustCertsFilePath string `json:"tlsTrustCertsFilePath"`

	// TLSAllowInsecureConnection configures whether the internal Pulsar client accepts untrusted TLS certificate from broker (default: false)
	TLSAllowInsecureConnection bool `json:"tlsAllowInsecureConnection"`

	// TLSValidateHostname configures whether the Pulsar client verifies the validity of the host name from broker (default: false)
	TLSValidateHostname bool `json:"tlsValidateHostname"`

	// DisableLogging disables pulsar client logs
	DisableLogging bool `json:"disableLogging"`
}

type SourceConfig struct {
	Config

	// SubscriptionName is the name of the subscription to be used for
	// consuming messages.
	SubscriptionName string `json:"subscriptionName"`
}

type DestinationConfig struct {
	Config
}