Versions in this module Expand all Collapse all v1 v1.0.0 Jun 1, 2024 Changes in this version + const BatchHeader + const DefaultHTTPTimeOutDuration + const DefaultWebServiceURL + const PropertyPrefix + const PublishTimeHeader + const ReleaseVersion + type BrokerStats interface + GetAllocatorStats func(allocatorName string) (*utils.AllocatorStats, error) + GetLoadReport func() (*utils.LocalBrokerData, error) + GetMBeans func() ([]utils.Metrics, error) + GetMetrics func() ([]utils.Metrics, error) + GetTopics func() (string, error) + type Brokers interface + DeleteDynamicConfiguration func(configName string) error + GetActiveBrokers func(cluster string) ([]string, error) + GetAllDynamicConfigurations func() (map[string]string, error) + GetDynamicConfigurationNames func() ([]string, error) + GetInternalConfigurationData func() (*utils.InternalConfigurationData, error) + GetLeaderBroker func() (utils.BrokerInfo, error) + GetListActiveBrokers func() ([]string, error) + GetOwnedNamespaces func(cluster, brokerURL string) (map[string]utils.NamespaceOwnershipStatus, error) + GetRuntimeConfigurations func() (map[string]string, error) + HealthCheck func() error + HealthCheckWithTopicVersion func(utils.TopicVersion) error + UpdateDynamicConfiguration func(configName, configValue string) error + type Client interface + BrokerStats func() BrokerStats + Brokers func() Brokers + Clusters func() Clusters + Functions func() Functions + FunctionsWorker func() FunctionsWorker + Namespaces func() Namespaces + NsIsolationPolicy func() NsIsolationPolicy + Packages func() Packages + ResourceQuotas func() ResourceQuotas + Schemas func() Schema + Sinks func() Sinks + Sources func() Sources + Subscriptions func() Subscriptions + Tenants func() Tenants + Topics func() Topics + func New(config *config.Config) (Client, error) + func NewPulsarClientWithAuthProvider(config *config.Config, authProvider auth.Provider) (Client, error) + func NewWithAuthProvider(config *config.Config, authProvider auth.Provider) Client + type Clusters interface + Create func(utils.ClusterData) error + CreateFailureDomain func(utils.FailureDomainData) error + Delete func(string) error + DeleteFailureDomain func(utils.FailureDomainData) error + Get func(string) (utils.ClusterData, error) + GetFailureDomain func(clusterName, domainName string) (utils.FailureDomainData, error) + GetPeerClusters func(string) ([]string, error) + List func() ([]string, error) + ListFailureDomains func(string) (utils.FailureDomainMap, error) + Update func(utils.ClusterData) error + UpdateFailureDomain func(utils.FailureDomainData) error + UpdatePeerClusters func(string, []string) error + type Functions interface + CreateFunc func(data *utils.FunctionConfig, fileName string) error + CreateFuncWithURL func(data *utils.FunctionConfig, pkgURL string) error + DeleteFunction func(tenant, namespace, name string) error + DownloadFunction func(path, destinationFile string) error + DownloadFunctionByNs func(destinationFile, tenant, namespace, function string) error + GetFunction func(tenant, namespace, name string) (utils.FunctionConfig, error) + GetFunctionState func(tenant, namespace, name, key string) (utils.FunctionState, error) + GetFunctionStats func(tenant, namespace, name string) (utils.FunctionStats, error) + GetFunctionStatsWithInstanceID func(tenant, namespace, name string, instanceID int) (utils.FunctionInstanceStatsData, error) + GetFunctionStatus func(tenant, namespace, name string) (utils.FunctionStatus, error) + GetFunctionStatusWithInstanceID func(tenant, namespace, name string, instanceID int) (utils.FunctionInstanceStatusData, error) + GetFunctions func(tenant, namespace string) ([]string, error) + PutFunctionState func(tenant, namespace, name string, state utils.FunctionState) error + RestartFunction func(tenant, namespace, name string) error + RestartFunctionWithID func(tenant, namespace, name string, instanceID int) error + StartFunction func(tenant, namespace, name string) error + StartFunctionWithID func(tenant, namespace, name string, instanceID int) error + StopFunction func(tenant, namespace, name string) error + StopFunctionWithID func(tenant, namespace, name string, instanceID int) error + TriggerFunction func(tenant, namespace, name, topic, triggerValue, triggerFile string) (string, error) + UpdateFunction func(functionConfig *utils.FunctionConfig, fileName string, ...) error + UpdateFunctionWithURL func(functionConfig *utils.FunctionConfig, pkgURL string, ...) error + Upload func(sourceFile, path string) error + type FunctionsWorker interface + GetAssignments func() (map[string][]string, error) + GetCluster func() ([]*utils.WorkerInfo, error) + GetClusterLeader func() (*utils.WorkerInfo, error) + GetFunctionsStats func() ([]*utils.WorkerFunctionInstanceStats, error) + GetMetrics func() ([]*utils.Metrics, error) + type Namespaces interface + ClearNamespaceBacklog func(namespace utils.NameSpaceName) error + ClearNamespaceBacklogForSubscription func(namespace utils.NameSpaceName, sName string) error + ClearNamespaceBundleBacklog func(namespace utils.NameSpaceName, bundle string) error + ClearNamespaceBundleBacklogForSubscription func(namespace utils.NameSpaceName, bundle, sName string) error + ClearOffloadDeleteLag func(namespace utils.NameSpaceName) error + CreateNamespace func(namespace string) error + CreateNsWithBundlesData func(namespace string, bundleData *utils.BundlesData) error + CreateNsWithNumBundles func(namespace string, numBundles int) error + CreateNsWithPolices func(namespace string, polices utils.Policies) error + DeleteBookieAffinityGroup func(namespace string) error + DeleteNamespace func(namespace string) error + DeleteNamespaceAntiAffinityGroup func(namespace string) error + DeleteNamespaceBundle func(namespace string, bundleRange string) error + GetAntiAffinityNamespaces func(tenant, cluster, namespaceAntiAffinityGroup string) ([]string, error) + GetBacklogQuotaMap func(namespace string) (map[utils.BacklogQuotaType]utils.BacklogQuota, error) + GetBookieAffinityGroup func(namespace string) (*utils.BookieAffinityGroupData, error) + GetCompactionThreshold func(namespace utils.NameSpaceName) (int64, error) + GetDispatchRate func(namespace utils.NameSpaceName) (utils.DispatchRate, error) + GetInactiveTopicPolicies func(namespace utils.NameSpaceName) (utils.InactiveTopicPolicies, error) + GetIsAllowAutoUpdateSchema func(namespace utils.NameSpaceName) (bool, error) + GetMaxConsumersPerSubscription func(namespace utils.NameSpaceName) (int, error) + GetMaxConsumersPerTopic func(namespace utils.NameSpaceName) (int, error) + GetMaxProducersPerTopic func(namespace utils.NameSpaceName) (int, error) + GetNamespaceAntiAffinityGroup func(namespace string) (string, error) + GetNamespaceMessageTTL func(namespace string) (int, error) + GetNamespacePermissions func(namespace utils.NameSpaceName) (map[string][]utils.AuthAction, error) + GetNamespaceReplicationClusters func(namespace string) ([]string, error) + GetNamespaces func(tenant string) ([]string, error) + GetOffloadDeleteLag func(namespace utils.NameSpaceName) (int64, error) + GetOffloadThreshold func(namespace utils.NameSpaceName) (int64, error) + GetPersistence func(namespace string) (*utils.PersistencePolicies, error) + GetPolicies func(namespace string) (*utils.Policies, error) + GetPublishRate func(namespace utils.NameSpaceName) (utils.PublishRate, error) + GetReplicatorDispatchRate func(namespace utils.NameSpaceName) (utils.DispatchRate, error) + GetRetention func(namespace string) (*utils.RetentionPolicies, error) + GetSchemaAutoUpdateCompatibilityStrategy func(namespace utils.NameSpaceName) (utils.SchemaCompatibilityStrategy, error) + GetSchemaValidationEnforced func(namespace utils.NameSpaceName) (bool, error) + GetSubscribeRate func(namespace utils.NameSpaceName) (utils.SubscribeRate, error) + GetSubscriptionDispatchRate func(namespace utils.NameSpaceName) (utils.DispatchRate, error) + GetTopicAutoCreation func(namespace utils.NameSpaceName) (*utils.TopicAutoCreationConfig, error) + GetTopics func(namespace string) ([]string, error) + GrantNamespacePermission func(namespace utils.NameSpaceName, role string, action []utils.AuthAction) error + GrantSubPermission func(namespace utils.NameSpaceName, sName string, roles []string) error + RemoveBacklogQuota func(namespace string) error + RemoveInactiveTopicPolicies func(namespace utils.NameSpaceName) error + RemoveTopicAutoCreation func(namespace utils.NameSpaceName) error + RevokeNamespacePermission func(namespace utils.NameSpaceName, role string) error + RevokeSubPermission func(namespace utils.NameSpaceName, sName, role string) error + SetBacklogQuota func(namespace string, backlogQuota utils.BacklogQuota, ...) error + SetBookieAffinityGroup func(namespace string, bookieAffinityGroup utils.BookieAffinityGroupData) error + SetCompactionThreshold func(namespace utils.NameSpaceName, threshold int64) error + SetDeduplicationStatus func(namespace string, enableDeduplication bool) error + SetDispatchRate func(namespace utils.NameSpaceName, rate utils.DispatchRate) error + SetEncryptionRequiredStatus func(namespace utils.NameSpaceName, encrypt bool) error + SetInactiveTopicPolicies func(namespace utils.NameSpaceName, data utils.InactiveTopicPolicies) error + SetIsAllowAutoUpdateSchema func(namespace utils.NameSpaceName, isAllowAutoUpdateSchema bool) error + SetMaxConsumersPerSubscription func(namespace utils.NameSpaceName, max int) error + SetMaxConsumersPerTopic func(namespace utils.NameSpaceName, max int) error + SetMaxProducersPerTopic func(namespace utils.NameSpaceName, max int) error + SetNamespaceAntiAffinityGroup func(namespace string, namespaceAntiAffinityGroup string) error + SetNamespaceMessageTTL func(namespace string, ttlInSeconds int) error + SetNamespaceReplicationClusters func(namespace string, clusterIds []string) error + SetOffloadDeleteLag func(namespace utils.NameSpaceName, timeMs int64) error + SetOffloadThreshold func(namespace utils.NameSpaceName, threshold int64) error + SetPersistence func(namespace string, persistence utils.PersistencePolicies) error + SetPublishRate func(namespace utils.NameSpaceName, pubRate utils.PublishRate) error + SetReplicatorDispatchRate func(namespace utils.NameSpaceName, rate utils.DispatchRate) error + SetRetention func(namespace string, policy utils.RetentionPolicies) error + SetSchemaAutoUpdateCompatibilityStrategy func(namespace utils.NameSpaceName, strategy utils.SchemaCompatibilityStrategy) error + SetSchemaValidationEnforced func(namespace utils.NameSpaceName, schemaValidationEnforced bool) error + SetSubscribeRate func(namespace utils.NameSpaceName, rate utils.SubscribeRate) error + SetSubscriptionAuthMode func(namespace utils.NameSpaceName, mode utils.SubscriptionAuthMode) error + SetSubscriptionDispatchRate func(namespace utils.NameSpaceName, rate utils.DispatchRate) error + SetTopicAutoCreation func(namespace utils.NameSpaceName, config utils.TopicAutoCreationConfig) error + SplitNamespaceBundle func(namespace, bundle string, unloadSplitBundles bool) error + Unload func(namespace string) error + UnloadNamespaceBundle func(namespace, bundle string) error + UnsubscribeNamespace func(namespace utils.NameSpaceName, sName string) error + UnsubscribeNamespaceBundle func(namespace utils.NameSpaceName, bundle, sName string) error + type NsIsolationPolicy interface + CreateNamespaceIsolationPolicy func(cluster, policyName string, ...) error + DeleteNamespaceIsolationPolicy func(cluster, policyName string) error + GetBrokerWithNamespaceIsolationPolicy func(cluster, broker string) (*utils.BrokerNamespaceIsolationData, error) + GetBrokersWithNamespaceIsolationPolicy func(cluster string) ([]utils.BrokerNamespaceIsolationData, error) + GetNamespaceIsolationPolicies func(cluster string) (map[string]utils.NamespaceIsolationData, error) + GetNamespaceIsolationPolicy func(cluster, policyName string) (*utils.NamespaceIsolationData, error) + type Packages interface + Delete func(packageURL string) error + Download func(packageURL, destinationFile string) error + GetMetadata func(packageURL string) (utils.PackageMetadata, error) + List func(typeName, namespace string) ([]string, error) + ListVersions func(packageURL string) ([]string, error) + UpdateMetadata func(packageURL, description, contact string, properties map[string]string) error + Upload func(packageURL, filePath, description, contact string, ...) error + type ResourceQuotas interface + GetDefaultResourceQuota func() (*utils.ResourceQuota, error) + GetNamespaceBundleResourceQuota func(namespace, bundle string) (*utils.ResourceQuota, error) + ResetNamespaceBundleResourceQuota func(namespace, bundle string) error + SetDefaultResourceQuota func(quota utils.ResourceQuota) error + SetNamespaceBundleResourceQuota func(namespace, bundle string, quota utils.ResourceQuota) error + type Schema interface + CreateSchemaByPayload func(topic string, schemaPayload utils.PostSchemaPayload) error + CreateSchemaBySchemaInfo func(topic string, schemaInfo utils.SchemaInfo) error + DeleteSchema func(topic string) error + ForceDeleteSchema func(topic string) error + GetSchemaInfo func(topic string) (*utils.SchemaInfo, error) + GetSchemaInfoByVersion func(topic string, version int64) (*utils.SchemaInfo, error) + GetSchemaInfoWithVersion func(topic string) (*utils.SchemaInfoWithVersion, error) + GetVersionByPayload func(topic string, schemaPayload utils.PostSchemaPayload) (int64, error) + GetVersionBySchemaInfo func(topic string, schemaInfo utils.SchemaInfo) (int64, error) + TestCompatibilityWithPostSchemaPayload func(topic string, schemaPayload utils.PostSchemaPayload) (*utils.IsCompatibility, error) + TestCompatibilityWithSchemaInfo func(topic string, schemaInfo utils.SchemaInfo) (*utils.IsCompatibility, error) + type Sinks interface + CreateSink func(config *utils.SinkConfig, fileName string) error + CreateSinkWithURL func(config *utils.SinkConfig, pkgURL string) error + DeleteSink func(tenant, namespace, Sink string) error + GetBuiltInSinks func() ([]*utils.ConnectorDefinition, error) + GetSink func(tenant, namespace, Sink string) (utils.SinkConfig, error) + GetSinkStatus func(tenant, namespace, Sink string) (utils.SinkStatus, error) + GetSinkStatusWithID func(tenant, namespace, Sink string, id int) (utils.SinkInstanceStatusData, error) + ListSinks func(tenant, namespace string) ([]string, error) + ReloadBuiltInSinks func() error + RestartSink func(tenant, namespace, Sink string) error + RestartSinkWithID func(tenant, namespace, Sink string, id int) error + StartSink func(tenant, namespace, Sink string) error + StartSinkWithID func(tenant, namespace, Sink string, id int) error + StopSink func(tenant, namespace, Sink string) error + StopSinkWithID func(tenant, namespace, Sink string, id int) error + UpdateSink func(config *utils.SinkConfig, fileName string, options *utils.UpdateOptions) error + UpdateSinkWithURL func(config *utils.SinkConfig, pkgURL string, options *utils.UpdateOptions) error + type Sources interface + CreateSource func(config *utils.SourceConfig, fileName string) error + CreateSourceWithURL func(config *utils.SourceConfig, pkgURL string) error + DeleteSource func(tenant, namespace, source string) error + GetBuiltInSources func() ([]*utils.ConnectorDefinition, error) + GetSource func(tenant, namespace, source string) (utils.SourceConfig, error) + GetSourceStatus func(tenant, namespace, source string) (utils.SourceStatus, error) + GetSourceStatusWithID func(tenant, namespace, source string, id int) (utils.SourceInstanceStatusData, error) + ListSources func(tenant, namespace string) ([]string, error) + ReloadBuiltInSources func() error + RestartSource func(tenant, namespace, source string) error + RestartSourceWithID func(tenant, namespace, source string, id int) error + StartSource func(tenant, namespace, source string) error + StartSourceWithID func(tenant, namespace, source string, id int) error + StopSource func(tenant, namespace, source string) error + StopSourceWithID func(tenant, namespace, source string, id int) error + UpdateSource func(config *utils.SourceConfig, fileName string, options *utils.UpdateOptions) error + UpdateSourceWithURL func(config *utils.SourceConfig, pkgURL string, options *utils.UpdateOptions) error + type Subscriptions interface + ClearBacklog func(utils.TopicName, string) error + Create func(utils.TopicName, string, utils.MessageID) error + Delete func(utils.TopicName, string) error + ExpireAllMessages func(utils.TopicName, int64) error + ExpireMessages func(utils.TopicName, string, int64) error + ForceDelete func(utils.TopicName, string) error + GetMessageByID func(topic utils.TopicName, ledgerID, entryID int64) (*utils.Message, error) + GetMessagesByID func(topic utils.TopicName, ledgerID, entryID int64) ([]*utils.Message, error) + List func(utils.TopicName) ([]string, error) + PeekMessages func(utils.TopicName, string, int) ([]*utils.Message, error) + ResetCursorToMessageID func(utils.TopicName, string, utils.MessageID) error + ResetCursorToTimestamp func(utils.TopicName, string, int64) error + SkipMessages func(utils.TopicName, string, int64) error + type TLSOptions struct + AllowInsecureConnection bool + TrustCertsFilePath string + type Tenants interface + Create func(utils.TenantData) error + Delete func(string) error + Get func(string) (utils.TenantData, error) + List func() ([]string, error) + Update func(utils.TenantData) error + type Topics interface + Compact func(utils.TopicName) error + CompactStatus func(utils.TopicName) (utils.LongRunningProcessStatus, error) + Create func(topic utils.TopicName, partitions int) error + Delete func(topic utils.TopicName, force bool, nonPartitioned bool) error + GetBacklogQuotaMap func(topic utils.TopicName, applied bool) (map[utils.BacklogQuotaType]utils.BacklogQuota, error) + GetBundleRange func(utils.TopicName) (string, error) + GetCompactionThreshold func(topic utils.TopicName, applied bool) (int64, error) + GetDeduplicationStatus func(utils.TopicName) (bool, error) + GetDelayedDelivery func(utils.TopicName) (*utils.DelayedDeliveryData, error) + GetDispatchRate func(utils.TopicName) (*utils.DispatchRateData, error) + GetInactiveTopicPolicies func(topic utils.TopicName, applied bool) (utils.InactiveTopicPolicies, error) + GetInternalInfo func(utils.TopicName) (utils.ManagedLedgerInfo, error) + GetInternalStats func(utils.TopicName) (utils.PersistentTopicInternalStats, error) + GetLastMessageID func(utils.TopicName) (utils.MessageID, error) + GetMaxConsumers func(utils.TopicName) (int, error) + GetMaxProducers func(utils.TopicName) (int, error) + GetMaxUnackMessagesPerConsumer func(utils.TopicName) (int, error) + GetMaxUnackMessagesPerSubscription func(utils.TopicName) (int, error) + GetMessageID func(topic utils.TopicName, timestamp int64) (utils.MessageID, error) + GetMessageTTL func(utils.TopicName) (int, error) + GetMetadata func(utils.TopicName) (utils.PartitionedTopicMetadata, error) + GetPartitionedStats func(topic utils.TopicName, perPartition bool) (utils.PartitionedTopicStats, error) + GetPartitionedStatsWithOption func(topic utils.TopicName, perPartition bool, option utils.GetStatsOptions) (utils.PartitionedTopicStats, error) + GetPermissions func(utils.TopicName) (map[string][]utils.AuthAction, error) + GetPersistence func(utils.TopicName) (*utils.PersistenceData, error) + GetPublishRate func(utils.TopicName) (*utils.PublishRateData, error) + GetReplicationClusters func(topic utils.TopicName) ([]string, error) + GetRetention func(topic utils.TopicName, applied bool) (*utils.RetentionPolicies, error) + GetStats func(utils.TopicName) (utils.TopicStats, error) + GetStatsWithOption func(topic utils.TopicName, option utils.GetStatsOptions) (utils.TopicStats, error) + GrantPermission func(topic utils.TopicName, role string, action []utils.AuthAction) error + List func(utils.NameSpaceName) ([]string, []string, error) + Lookup func(utils.TopicName) (utils.LookupData, error) + Offload func(utils.TopicName, utils.MessageID) error + OffloadStatus func(utils.TopicName) (utils.OffloadProcessStatus, error) + RemoveBacklogQuota func(utils.TopicName, utils.BacklogQuotaType) error + RemoveCompactionThreshold func(utils.TopicName) error + RemoveDeduplicationStatus func(utils.TopicName) error + RemoveDelayedDelivery func(utils.TopicName) error + RemoveDispatchRate func(utils.TopicName) error + RemoveInactiveTopicPolicies func(utils.TopicName) error + RemoveMaxConsumers func(utils.TopicName) error + RemoveMaxProducers func(utils.TopicName) error + RemoveMaxUnackMessagesPerConsumer func(utils.TopicName) error + RemoveMaxUnackMessagesPerSubscription func(utils.TopicName) error + RemoveMessageTTL func(utils.TopicName) error + RemovePersistence func(utils.TopicName) error + RemovePublishRate func(utils.TopicName) error + RemoveRetention func(utils.TopicName) error + RevokePermission func(topic utils.TopicName, role string) error + SetBacklogQuota func(utils.TopicName, utils.BacklogQuota, utils.BacklogQuotaType) error + SetCompactionThreshold func(topic utils.TopicName, threshold int64) error + SetDeduplicationStatus func(topic utils.TopicName, enabled bool) error + SetDelayedDelivery func(utils.TopicName, utils.DelayedDeliveryData) error + SetDispatchRate func(utils.TopicName, utils.DispatchRateData) error + SetInactiveTopicPolicies func(topic utils.TopicName, data utils.InactiveTopicPolicies) error + SetMaxConsumers func(topic utils.TopicName, maxConsumers int) error + SetMaxProducers func(topic utils.TopicName, maxProducers int) error + SetMaxUnackMessagesPerConsumer func(topic utils.TopicName, maxUnackedNum int) error + SetMaxUnackMessagesPerSubscription func(topic utils.TopicName, maxUnackedNum int) error + SetMessageTTL func(topic utils.TopicName, messageTTL int) error + SetPersistence func(utils.TopicName, utils.PersistenceData) error + SetPublishRate func(utils.TopicName, utils.PublishRateData) error + SetReplicationClusters func(topic utils.TopicName, data []string) error + SetRetention func(utils.TopicName, utils.RetentionPolicies) error + Terminate func(utils.TopicName) (utils.MessageID, error) + Unload func(utils.TopicName) error + Update func(topic utils.TopicName, partitions int) error
Go to main page