pulsar_admin

package module
v0.0.0-...-8dc8e08 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 18, 2021 License: Apache-2.0 Imports: 21 Imported by: 0

README

Pulsar API client generated from the OpenAPI definition

This provides the REST API for admin operations

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: v2
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./openapi"

Documentation for API Endpoints

All URIs are relative to http://localhost/admin/v2

Class Method HTTP request Description
BookiesApi DeleteBookieRackInfo Delete /bookies/racks-info/{bookie} Removed the rack placement information for a specific bookie in the cluster
BookiesApi GetBookieRackInfo Get /bookies/racks-info/{bookie} Gets the rack placement information for a specific bookie in the cluster
BookiesApi GetBookiesRackInfo Get /bookies/racks-info Gets the rack placement information for all the bookies in the cluster
BookiesApi UpdateBookieRackInfo Post /bookies/racks-info/{bookie} Updates the rack placement information for a specific bookie in the cluster
BrokerStatsApi GetAllocatorStats Get /broker-stats/allocator-stats/{allocator} Get the stats for the Netty allocator. Available allocators are 'default' and 'ml-cache'
BrokerStatsApi GetBrokerResourceAvailability Get /broker-stats/broker-resource-availability/{tenant}/{namespace} Broker availability report
BrokerStatsApi GetLoadReport Get /broker-stats/load-report Get Load for this broker
BrokerStatsApi GetMBeans Get /broker-stats/mbeans Get all the mbean details of this broker JVM
BrokerStatsApi GetMetrics Get /broker-stats/metrics Gets the metrics for Monitoring
BrokerStatsApi GetPendingBookieOpsStats Get /broker-stats/bookieops Get pending bookie client op stats by namesapce
BrokerStatsApi GetTopics2 Get /broker-stats/topics Get all the topic stats by namespace
BrokersApi GetActiveBrokers Get /brokers/{cluster} Get the list of active brokers (web service addresses) in the cluster.If authorization is not enabled, any cluster name is valid.
BrokersApi GetAllDynamicConfigurations Get /brokers/configuration/values Get value of all dynamic configurations' value overridden on local config
BrokersApi GetDynamicConfigurationName Get /brokers/configuration Get all updatable dynamic configurations's name
BrokersApi GetInternalConfigurationData Get /brokers/internal-configuration Get the internal configuration data
BrokersApi GetOwnedNamespaes Get /brokers/{clusterName}/{broker-webserviceurl}/ownedNamespaces Get the list of namespaces served by the specific broker
BrokersApi GetRuntimeConfiguration Get /brokers/configuration/runtime Get all runtime configurations. This operation requires Pulsar super-user privileges.
BrokersApi Healthcheck Get /brokers/health Run a healthcheck against the broker
BrokersApi UpdateDynamicConfiguration Post /brokers/configuration/{configName}/{configValue} Update dynamic serviceconfiguration into zk only. This operation requires Pulsar super-user privileges.
ClustersApi CreateCluster Put /clusters/{cluster} Create a new cluster.
ClustersApi DeleteCluster Delete /clusters/{cluster} Delete an existing cluster.
ClustersApi DeleteFailureDomain Delete /clusters/{cluster}/failureDomains/{domainName} Delete the failure domain of the cluster
ClustersApi DeleteNamespaceIsolationPolicy Delete /clusters/{cluster}/namespaceIsolationPolicies/{policyName} Delete namespace isolation policy.
ClustersApi GetBrokerWithNamespaceIsolationPolicy Get /clusters/{cluster}/namespaceIsolationPolicies/brokers/{broker} Get a broker with namespace-isolation policies attached to it.
ClustersApi GetBrokersWithNamespaceIsolationPolicy Get /clusters/{cluster}/namespaceIsolationPolicies/brokers Get list of brokers with namespace-isolation policies attached to them.
ClustersApi GetCluster Get /clusters/{cluster} Get the configuration for the specified cluster.
ClustersApi GetClusters Get /clusters Get the list of all the Pulsar clusters.
ClustersApi GetDomain Get /clusters/{cluster}/failureDomains/{domainName} Get a domain in a cluster
ClustersApi GetFailureDomains Get /clusters/{cluster}/failureDomains Get the cluster failure domains.
ClustersApi GetNamespaceIsolationPolicies Get /clusters/{cluster}/namespaceIsolationPolicies Get the namespace isolation policies assigned to the cluster.
ClustersApi GetNamespaceIsolationPolicy Get /clusters/{cluster}/namespaceIsolationPolicies/{policyName} Get the single namespace isolation policy assigned to the cluster.
ClustersApi GetPeerCluster Get /clusters/{cluster}/peers Get the peer-cluster data for the specified cluster.
ClustersApi SetFailureDomain Post /clusters/{cluster}/failureDomains/{domainName} Set the failure domain of the cluster.
ClustersApi SetNamespaceIsolationPolicy Post /clusters/{cluster}/namespaceIsolationPolicies/{policyName} Set namespace isolation policy.
ClustersApi SetPeerClusterNames Post /clusters/{cluster}/peers Update peer-cluster-list for a cluster.
ClustersApi UpdateCluster Post /clusters/{cluster} Update the configuration for a cluster.
NamespacesApi ClearNamespaceBacklog Post /namespaces/{tenant}/{namespace}/clearBacklog Clear backlog for all topics on a namespace.
NamespacesApi ClearNamespaceBacklogForSubscription Post /namespaces/{tenant}/{namespace}/clearBacklog/{subscription} Clear backlog for a given subscription on all topics on a namespace.
NamespacesApi ClearNamespaceBundleBacklog Post /namespaces/{tenant}/{namespace}/{bundle}/clearBacklog Clear backlog for all topics on a namespace bundle.
NamespacesApi ClearNamespaceBundleBacklogForSubscription Post /namespaces/{tenant}/{namespace}/{bundle}/clearBacklog/{subscription} Clear backlog for a given subscription on all topics on a namespace bundle.
NamespacesApi ClearOffloadDeletionLag Delete /namespaces/{tenant}/{namespace}/offloadDeletionLagMs Clear the namespace configured offload deletion lag. The topics in the namespace will fallback to using the default configured deletion lag for the broker
NamespacesApi CreateNamespace Put /namespaces/{tenant}/{namespace} Creates a new namespace with the specified policies
NamespacesApi DeleteBookieAffinityGroup Delete /namespaces/{property}/{namespace}/persistence/bookieAffinity Delete the bookie-affinity-group from namespace-local policy.
NamespacesApi DeleteNamespace Delete /namespaces/{tenant}/{namespace} Delete a namespace and all the topics under it.
NamespacesApi DeleteNamespaceBundle Delete /namespaces/{tenant}/{namespace}/{bundle} Delete a namespace bundle and all the topics under it.
NamespacesApi GetAntiAffinityNamespaces Get /namespaces/{cluster}/antiAffinity/{group} Get all namespaces that are grouped by given anti-affinity group in a given cluster. api can be only accessed by admin of any of the existing tenant
NamespacesApi GetBacklogQuotaMap Get /namespaces/{tenant}/{namespace}/backlogQuotaMap Get backlog quota map on a namespace.
NamespacesApi GetBookieAffinityGroup Get /namespaces/{property}/{namespace}/persistence/bookieAffinity Get the bookie-affinity-group from namespace-local policy.
NamespacesApi GetBundlesData Get /namespaces/{tenant}/{namespace}/bundles Get the bundles split data.
NamespacesApi GetCompactionThreshold Get /namespaces/{tenant}/{namespace}/compactionThreshold Maximum number of uncompacted bytes in topics before compaction is triggered.
NamespacesApi GetDispatchRate Get /namespaces/{tenant}/{namespace}/dispatchRate Get dispatch-rate configured for the namespace, -1 represents not configured yet
NamespacesApi GetMaxConsumersPerSubscription Get /namespaces/{tenant}/{namespace}/maxConsumersPerSubscription Get maxConsumersPerSubscription config on a namespace.
NamespacesApi GetMaxConsumersPerTopic Get /namespaces/{tenant}/{namespace}/maxConsumersPerTopic Get maxConsumersPerTopic config on a namespace.
NamespacesApi GetMaxProducersPerTopic Get /namespaces/{tenant}/{namespace}/maxProducersPerTopic Get maxProducersPerTopic config on a namespace.
NamespacesApi GetNamespaceAntiAffinityGroup Get /namespaces/{tenant}/{namespace}/antiAffinity Get anti-affinity group of a namespace.
NamespacesApi GetNamespaceMessageTTL Get /namespaces/{tenant}/{namespace}/messageTTL Get the message TTL for the namespace
NamespacesApi GetNamespaceReplicationClusters Get /namespaces/{tenant}/{namespace}/replication Get the replication clusters for a namespace.
NamespacesApi GetOffloadDeletionLag Get /namespaces/{tenant}/{namespace}/offloadDeletionLagMs Number of milliseconds to wait before deleting a ledger segment which has been offloaded from the Pulsar cluster's local storage (i.e. BookKeeper)
NamespacesApi GetOffloadThreshold Get /namespaces/{tenant}/{namespace}/offloadThreshold Maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage
NamespacesApi GetPermissions Get /namespaces/{tenant}/{namespace}/permissions Retrieve the permissions for a namespace.
NamespacesApi GetPersistence Get /namespaces/{tenant}/{namespace}/persistence Get the persistence configuration for a namespace.
NamespacesApi GetPolicies Get /namespaces/{tenant}/{namespace} Get the dump all the policies specified for a namespace.
NamespacesApi GetReplicatorDispatchRate Get /namespaces/{tenant}/{namespace}/replicatorDispatchRate Get replicator dispatch-rate configured for the namespace, -1 represents not configured yet
NamespacesApi GetRetention Get /namespaces/{tenant}/{namespace}/retention Get retention config on a namespace.
NamespacesApi GetSchemaAutoUpdateCompatibilityStrategy Get /namespaces/{tenant}/{namespace}/schemaAutoUpdateCompatibilityStrategy The strategy used to check the compatibility of new schemas, provided by producers, before automatically updating the schema
NamespacesApi GetSchemaValidtionEnforced Get /namespaces/{tenant}/{namespace}/schemaValidationEnforced Get schema validation enforced flag for namespace.
NamespacesApi GetSubscribeRate Get /namespaces/{tenant}/{namespace}/subscribeRate Get subscribe-rate configured for the namespace
NamespacesApi GetSubscriptionDispatchRate Get /namespaces/{tenant}/{namespace}/subscriptionDispatchRate Get Subscription dispatch-rate configured for the namespace, -1 represents not configured yet
NamespacesApi GetTenantNamespaces Get /namespaces/{tenant} Get the list of all the namespaces for a certain tenant.
NamespacesApi GetTopics Get /namespaces/{tenant}/{namespace}/topics Get the list of all the topics under a certain namespace.
NamespacesApi GrantPermissionOnNamespace Post /namespaces/{tenant}/{namespace}/permissions/{role} Grant a new permission to a role on a namespace.
NamespacesApi ModifyDeduplication Post /namespaces/{tenant}/{namespace}/deduplication Enable or disable broker side deduplication for all topics in a namespace
NamespacesApi ModifyEncryptionRequired Post /namespaces/{tenant}/{namespace}/encryptionRequired Message encryption is required or not for all topics in a namespace
NamespacesApi RemoveBacklogQuota Delete /namespaces/{tenant}/{namespace}/backlogQuota Remove a backlog quota policy from a namespace.
NamespacesApi RemoveNamespaceAntiAffinityGroup Delete /namespaces/{tenant}/{namespace}/antiAffinity Remove anti-affinity group of a namespace.
NamespacesApi RevokePermissionsOnNamespace Delete /namespaces/{tenant}/{namespace}/permissions/{role} Revoke all permissions to a role on a namespace.
NamespacesApi SetBacklogQuota Post /namespaces/{tenant}/{namespace}/backlogQuota Set a backlog quota for all the topics on a namespace.
NamespacesApi SetBookieAffinityGroup Post /namespaces/{tenant}/{namespace}/persistence/bookieAffinity Set the bookie-affinity-group to namespace-persistent policy.
NamespacesApi SetCompactionThreshold Put /namespaces/{tenant}/{namespace}/compactionThreshold Set maximum number of uncompacted bytes in a topic before compaction is triggered.
NamespacesApi SetDispatchRate Post /namespaces/{tenant}/{namespace}/dispatchRate Set dispatch-rate throttling for all topics of the namespace
NamespacesApi SetMaxConsumersPerSubscription Post /namespaces/{tenant}/{namespace}/maxConsumersPerSubscription Set maxConsumersPerSubscription configuration on a namespace.
NamespacesApi SetMaxConsumersPerTopic Post /namespaces/{tenant}/{namespace}/maxConsumersPerTopic Set maxConsumersPerTopic configuration on a namespace.
NamespacesApi SetMaxProducersPerTopic Post /namespaces/{tenant}/{namespace}/maxProducersPerTopic Set maxProducersPerTopic configuration on a namespace.
NamespacesApi SetNamespaceAntiAffinityGroup Post /namespaces/{tenant}/{namespace}/antiAffinity Set anti-affinity group for a namespace
NamespacesApi SetNamespaceMessageTTL Post /namespaces/{tenant}/{namespace}/messageTTL Set message TTL in seconds for namespace
NamespacesApi SetNamespaceReplicationClusters Post /namespaces/{tenant}/{namespace}/replication Set the replication clusters for a namespace.
NamespacesApi SetOffloadDeletionLag Put /namespaces/{tenant}/{namespace}/offloadDeletionLagMs Set number of milliseconds to wait before deleting a ledger segment which has been offloaded from the Pulsar cluster's local storage (i.e. BookKeeper)
NamespacesApi SetOffloadThreshold Put /namespaces/{tenant}/{namespace}/offloadThreshold Set maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage
NamespacesApi SetPersistence Post /namespaces/{tenant}/{namespace}/persistence Set the persistence configuration for all the topics on a namespace.
NamespacesApi SetReplicatorDispatchRate Post /namespaces/{tenant}/{namespace}/replicatorDispatchRate Set replicator dispatch-rate throttling for all topics of the namespace
NamespacesApi SetRetention Post /namespaces/{tenant}/{namespace}/retention Set retention configuration on a namespace.
NamespacesApi SetSchemaAutoUpdateCompatibilityStrategy Put /namespaces/{tenant}/{namespace}/schemaAutoUpdateCompatibilityStrategy Update the strategy used to check the compatibility of new schemas, provided by producers, before automatically updating the schema
NamespacesApi SetSchemaValidtionEnforced Post /namespaces/{tenant}/{namespace}/schemaValidationEnforced Set schema validation enforced flag on namespace.
NamespacesApi SetSubscribeRate Post /namespaces/{tenant}/{namespace}/subscribeRate Set subscribe-rate throttling for all topics of the namespace
NamespacesApi SetSubscriptionAuthMode Post /namespaces/{tenant}/{namespace}/subscriptionAuthMode Set a subscription auth mode for all the topics on a namespace.
NamespacesApi SetSubscriptionDispatchRate Post /namespaces/{tenant}/{namespace}/subscriptionDispatchRate Set Subscription dispatch-rate throttling for all topics of the namespace
NamespacesApi SplitNamespaceBundle Put /namespaces/{tenant}/{namespace}/{bundle}/split Split a namespace bundle
NamespacesApi UnloadNamespace Put /namespaces/{tenant}/{namespace}/unload Unload namespace
NamespacesApi UnloadNamespaceBundle Put /namespaces/{tenant}/{namespace}/{bundle}/unload Unload a namespace bundle
NamespacesApi UnsubscribeNamespace Post /namespaces/{tenant}/{namespace}/unsubscribe/{subscription} Unsubscribes the given subscription on all topics on a namespace.
NamespacesApi UnsubscribeNamespaceBundle Post /namespaces/{tenant}/{namespace}/{bundle}/unsubscribe/{subscription} Unsubscribes the given subscription on all topics on a namespace bundle.
NonPersistentTopicApi Compact Put /non-persistent/{tenant}/{namespace}/{topic}/compaction Trigger a compaction operation on a topic.
NonPersistentTopicApi CompactionStatus Get /non-persistent/{tenant}/{namespace}/{topic}/compaction Get the status of a compaction operation for a topic.
NonPersistentTopicApi CreateNonPartitionedTopic Put /non-persistent/{tenant}/{namespace}/{topic} Create a non-partitioned topic.
NonPersistentTopicApi CreatePartitionedTopic Put /non-persistent/{tenant}/{namespace}/{topic}/partitions Create a partitioned topic.
NonPersistentTopicApi CreateSubscription Put /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subscriptionName} Reset subscription to message position closest to given position.
NonPersistentTopicApi DeletePartitionedTopic Delete /non-persistent/{tenant}/{namespace}/{topic}/partitions Delete a partitioned topic.
NonPersistentTopicApi DeleteSubscription Delete /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName} Delete a subscription.
NonPersistentTopicApi DeleteTopic Delete /non-persistent/{tenant}/{namespace}/{topic} Delete a topic.
NonPersistentTopicApi ExpireMessagesForAllSubscriptions Post /non-persistent/{tenant}/{namespace}/{topic}/all_subscription/expireMessages/{expireTimeInSeconds} Expiry messages on all subscriptions of topic.
NonPersistentTopicApi ExpireTopicMessages Post /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages/{expireTimeInSeconds} Expiry messages on a topic subscription.
NonPersistentTopicApi GetBacklog Get /non-persistent/{tenant}/{namespace}/{topic}/backlog Get estimated backlog for offline topic.
NonPersistentTopicApi GetInternalStats Get /non-persistent/{tenant}/{namespace}/{topic}/internalStats Get the internal stats for the topic.
NonPersistentTopicApi GetLastMessageId Get /non-persistent/{tenant}/{namespace}/{topic}/lastMessageId Return the last commit message id of topic
NonPersistentTopicApi GetList Get /non-persistent/{tenant}/{namespace} Get the list of non-persistent topics under a namespace.
NonPersistentTopicApi GetListFromBundle Get /non-persistent/{tenant}/{namespace}/{bundle} Get the list of non-persistent topics under a namespace bundle.
NonPersistentTopicApi GetManagedLedgerInfo Get /non-persistent/{tenant}/{namespace}/{topic}/internal-info Get the internal stats for the topic.
NonPersistentTopicApi GetPartitionedMetadata Get /non-persistent/{tenant}/{namespace}/{topic}/partitions Get partitioned topic metadata.
NonPersistentTopicApi GetPartitionedStats Get /non-persistent/{tenant}/{namespace}/{topic}/partitioned-stats Get the stats for the partitioned topic.
NonPersistentTopicApi GetPartitionedTopicList Get /non-persistent/{tenant}/{namespace}/partitioned Get the list of partitioned topics under a namespace.
NonPersistentTopicApi GetPermissionsOnTopic Get /non-persistent/{tenant}/{namespace}/{topic}/permissions Get permissions on a topic.
NonPersistentTopicApi GetStats Get /non-persistent/{tenant}/{namespace}/{topic}/stats Get the stats for the topic.
NonPersistentTopicApi GetSubscriptions Get /non-persistent/{tenant}/{namespace}/{topic}/subscriptions Get the list of persistent subscriptions for a given topic.
NonPersistentTopicApi GrantPermissionsOnTopic Post /non-persistent/{tenant}/{namespace}/{topic}/permissions/{role} Grant a new permission to a role on a single topic.
NonPersistentTopicApi OffloadStatus Get /non-persistent/{tenant}/{namespace}/{topic}/offload Offload a prefix of a topic to long term storage
NonPersistentTopicApi PeekNthMessage Get /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/position/{messagePosition} Peek nth message on a topic subscription.
NonPersistentTopicApi ResetCursor Post /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor/{timestamp} Reset subscription to message position closest to absolute timestamp (in ms).
NonPersistentTopicApi ResetCursorOnPosition Post /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor Reset subscription to message position closest to given position.
NonPersistentTopicApi RevokePermissionsOnTopic Delete /non-persistent/{tenant}/{namespace}/{topic}/permissions/{role} Revoke permissions on a topic.
NonPersistentTopicApi SkipAllMessages Post /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip_all Skip all messages on a topic subscription.
NonPersistentTopicApi SkipMessages Post /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip/{numMessages} Skipping messages on a topic subscription.
NonPersistentTopicApi Terminate Post /non-persistent/{tenant}/{namespace}/{topic}/terminate Terminate a topic. A topic that is terminated will not accept any more messages to be published and will let consumer to drain existing messages in backlog
NonPersistentTopicApi TriggerOffload Put /non-persistent/{tenant}/{namespace}/{topic}/offload Offload a prefix of a topic to long term storage
NonPersistentTopicApi UnloadTopic Put /non-persistent/{tenant}/{namespace}/{topic}/unload Unload a topic
NonPersistentTopicApi UpdatePartitionedTopic Post /non-persistent/{tenant}/{namespace}/{topic}/partitions Increment partitons of an existing partitioned topic.
PersistentTopicApi Compact Put /persistent/{tenant}/{namespace}/{topic}/compaction Trigger a compaction operation on a topic.
PersistentTopicApi CompactionStatus Get /persistent/{tenant}/{namespace}/{topic}/compaction Get the status of a compaction operation for a topic.
PersistentTopicApi CreateNonPartitionedTopic Put /persistent/{tenant}/{namespace}/{topic} Create a non-partitioned topic.
PersistentTopicApi CreatePartitionedTopic Put /persistent/{tenant}/{namespace}/{topic}/partitions Create a partitioned topic.
PersistentTopicApi CreateSubscription Put /persistent/{tenant}/{namespace}/{topic}/subscription/{subscriptionName} Reset subscription to message position closest to given position.
PersistentTopicApi DeletePartitionedTopic Delete /persistent/{tenant}/{namespace}/{topic}/partitions Delete a partitioned topic.
PersistentTopicApi DeleteSubscription Delete /persistent/{tenant}/{namespace}/{topic}/subscription/{subName} Delete a subscription.
PersistentTopicApi DeleteTopic Delete /persistent/{tenant}/{namespace}/{topic} Delete a topic.
PersistentTopicApi ExpireMessagesForAllSubscriptions Post /persistent/{tenant}/{namespace}/{topic}/all_subscription/expireMessages/{expireTimeInSeconds} Expiry messages on all subscriptions of topic.
PersistentTopicApi ExpireTopicMessages Post /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages/{expireTimeInSeconds} Expiry messages on a topic subscription.
PersistentTopicApi GetBacklog Get /persistent/{tenant}/{namespace}/{topic}/backlog Get estimated backlog for offline topic.
PersistentTopicApi GetInternalStats Get /persistent/{tenant}/{namespace}/{topic}/internalStats Get the internal stats for the topic.
PersistentTopicApi GetLastMessageId Get /persistent/{tenant}/{namespace}/{topic}/lastMessageId Return the last commit message id of topic
PersistentTopicApi GetList Get /persistent/{tenant}/{namespace} Get the list of topics under a namespace.
PersistentTopicApi GetManagedLedgerInfo Get /persistent/{tenant}/{namespace}/{topic}/internal-info Get the internal stats for the topic.
PersistentTopicApi GetPartitionedMetadata Get /persistent/{tenant}/{namespace}/{topic}/partitions Get partitioned topic metadata.
PersistentTopicApi GetPartitionedStats Get /persistent/{tenant}/{namespace}/{topic}/partitioned-stats Get the stats for the partitioned topic.
PersistentTopicApi GetPartitionedTopicList Get /persistent/{tenant}/{namespace}/partitioned Get the list of partitioned topics under a namespace.
PersistentTopicApi GetPermissionsOnTopic Get /persistent/{tenant}/{namespace}/{topic}/permissions Get permissions on a topic.
PersistentTopicApi GetStats Get /persistent/{tenant}/{namespace}/{topic}/stats Get the stats for the topic.
PersistentTopicApi GetSubscriptions Get /persistent/{tenant}/{namespace}/{topic}/subscriptions Get the list of persistent subscriptions for a given topic.
PersistentTopicApi GrantPermissionsOnTopic Post /persistent/{tenant}/{namespace}/{topic}/permissions/{role} Grant a new permission to a role on a single topic.
PersistentTopicApi OffloadStatus Get /persistent/{tenant}/{namespace}/{topic}/offload Offload a prefix of a topic to long term storage
PersistentTopicApi PeekNthMessage Get /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/position/{messagePosition} Peek nth message on a topic subscription.
PersistentTopicApi ResetCursor Post /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor/{timestamp} Reset subscription to message position closest to absolute timestamp (in ms).
PersistentTopicApi ResetCursorOnPosition Post /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor Reset subscription to message position closest to given position.
PersistentTopicApi RevokePermissionsOnTopic Delete /persistent/{tenant}/{namespace}/{topic}/permissions/{role} Revoke permissions on a topic.
PersistentTopicApi SkipAllMessages Post /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip_all Skip all messages on a topic subscription.
PersistentTopicApi SkipMessages Post /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip/{numMessages} Skipping messages on a topic subscription.
PersistentTopicApi Terminate Post /persistent/{tenant}/{namespace}/{topic}/terminate Terminate a topic. A topic that is terminated will not accept any more messages to be published and will let consumer to drain existing messages in backlog
PersistentTopicApi TriggerOffload Put /persistent/{tenant}/{namespace}/{topic}/offload Offload a prefix of a topic to long term storage
PersistentTopicApi UnloadTopic Put /persistent/{tenant}/{namespace}/{topic}/unload Unload a topic
PersistentTopicApi UpdatePartitionedTopic Post /persistent/{tenant}/{namespace}/{topic}/partitions Increment partitons of an existing partitioned topic.
ResourceQuotasApi GetDefaultResourceQuota Get /resource-quotas Get the default quota
ResourceQuotasApi GetNamespaceBundleResourceQuota Get /resource-quotas/{tenant}/{namespace}/{bundle} Get resource quota of a namespace bundle.
ResourceQuotasApi RemoveNamespaceBundleResourceQuota Delete /resource-quotas/{tenant}/{namespace}/{bundle} Remove resource quota for a namespace.
ResourceQuotasApi SetDefaultResourceQuota Post /resource-quotas Set the default quota
ResourceQuotasApi SetNamespaceBundleResourceQuota Post /resource-quotas/{tenant}/{namespace}/{bundle} Set resource quota on a namespace.
SchemasApi DeleteSchema Delete /schemas/{tenant}/{namespace}/{topic}/schema Delete the schema of a topic
SchemasApi GetSchema Get /schemas/{tenant}/{namespace}/{topic}/schema Get the schema of a topic
SchemasApi GetSchema_0 Get /schemas/{tenant}/{namespace}/{topic}/schema/{version} Get the schema of a topic at a given version
SchemasApi PostSchema Post /schemas/{tenant}/{namespace}/{topic}/schema Update the schema of a topic
TenantsApi CreateTenant Put /tenants/{tenant} Create a new tenant.
TenantsApi DeleteTenant Delete /tenants/{tenant} Delete a tenant and all namespaces and topics under it.
TenantsApi GetTenantAdmin Get /tenants/{tenant} Get the admin configuration for a given tenant.
TenantsApi GetTenants Get /tenants Get the list of existing tenants.
TenantsApi UpdateTenant Post /tenants/{tenant} Update the admins for a tenant.

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	BookiesApi *BookiesApiService

	BrokerStatsApi *BrokerStatsApiService

	BrokersApi *BrokersApiService

	ClustersApi *ClustersApiService

	NamespacesApi *NamespacesApiService

	NonPersistentTopicApi *NonPersistentTopicApiService

	PersistentTopicApi *PersistentTopicApiService

	ResourceQuotasApi *ResourceQuotasApiService

	SchemasApi *SchemasApiService

	TenantsApi *TenantsApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Pulsar Admin REST API API vv2 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AllocatorStats 

type AllocatorStats struct {
	NumDirectArenas      int32            `json:"numDirectArenas,omitempty"`
	NumHeapArenas        int32            `json:"numHeapArenas,omitempty"`
	NumThreadLocalCaches int32            `json:"numThreadLocalCaches,omitempty"`
	NormalCacheSize      int32            `json:"normalCacheSize,omitempty"`
	SmallCacheSize       int32            `json:"smallCacheSize,omitempty"`
	TinyCacheSize        int32            `json:"tinyCacheSize,omitempty"`
	DirectArenas         []PoolArenaStats `json:"directArenas,omitempty"`
	HeapArenas           []PoolArenaStats `json:"heapArenas,omitempty"`
}

type AuthPolicies 

type AuthPolicies struct {
	NamespaceAuth         map[string][]string            `json:"namespace_auth,omitempty"`
	DestinationAuth       map[string]map[string][]string `json:"destination_auth,omitempty"`
	SubscriptionAuthRoles map[string][]string            `json:"subscription_auth_roles,omitempty"`
}

type AutoFailoverPolicyData 

type AutoFailoverPolicyData struct {
	// The auto failover policy type
	PolicyType string `json:"policy_type,omitempty"`
	// The parameters applied to the auto failover policy specified by `policy_type`. The parameters for 'min_available' are :   - 'min_limit': the limit of minimal number of available brokers in primary group before auto failover   - 'usage_threshold': the resource usage threshold. If the usage of a broker is beyond this value, it would be marked as unavailable
	Parameters map[string]string `json:"parameters,omitempty"`
}

The auto failover policy configuration data

type BacklogQuota 

type BacklogQuota struct {
	Limit  int64  `json:"limit,omitempty"`
	Policy string `json:"policy,omitempty"`
}

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BookieAffinityGroupData 

type BookieAffinityGroupData struct {
	BookkeeperAffinityGroupPrimary   string `json:"bookkeeperAffinityGroupPrimary,omitempty"`
	BookkeeperAffinityGroupSecondary string `json:"bookkeeperAffinityGroupSecondary,omitempty"`
}

type BookieInfo 

type BookieInfo struct {
	Rack     string `json:"rack,omitempty"`
	Hostname string `json:"hostname,omitempty"`
}

type BookiesApiService 

type BookiesApiService service

func (*BookiesApiService) DeleteBookieRackInfo 

func (a *BookiesApiService) DeleteBookieRackInfo(ctx context.Context, bookie string) (*http.Response, error)

BookiesApiService Removed the rack placement information for a specific bookie in the cluster

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param bookie

func (*BookiesApiService) GetBookieRackInfo 

func (a *BookiesApiService) GetBookieRackInfo(ctx context.Context, bookie string) (BookieInfo, *http.Response, error)

BookiesApiService Gets the rack placement information for a specific bookie in the cluster

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param bookie

@return BookieInfo

func (*BookiesApiService) GetBookiesRackInfo 

func (a *BookiesApiService) GetBookiesRackInfo(ctx context.Context) (map[string]map[string]BookieInfo, *http.Response, error)

BookiesApiService Gets the rack placement information for all the bookies in the cluster

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return map[string]map[string]BookieInfo

func (*BookiesApiService) UpdateBookieRackInfo 

func (a *BookiesApiService) UpdateBookieRackInfo(ctx context.Context, bookie string, localVarOptionals *UpdateBookieRackInfoOpts) (*http.Response, error)

type BrokerNamespaceIsolationData 

type BrokerNamespaceIsolationData struct {
	// The broker name
	BrokerName string `json:"brokerName,omitempty"`
	// The namespace-isolation policies attached to this broker
	NamespaceRegex []string `json:"namespaceRegex,omitempty"`
}

The namespace isolation data for a given broker

type BrokerStatsApiService 

type BrokerStatsApiService service

func (*BrokerStatsApiService) GetAllocatorStats 

func (a *BrokerStatsApiService) GetAllocatorStats(ctx context.Context, allocator string) (AllocatorStats, *http.Response, error)

BrokerStatsApiService Get the stats for the Netty allocator. Available allocators are 'default' and 'ml-cache'

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param allocator

@return AllocatorStats

func (*BrokerStatsApiService) GetBrokerResourceAvailability 

func (a *BrokerStatsApiService) GetBrokerResourceAvailability(ctx context.Context, tenant string, namespace string) (map[string]ResourceUnit, *http.Response, error)

BrokerStatsApiService Broker availability report This API gives the current broker availability in percent, each resource percentage usage is calculated and thensum of all of the resource usage percent is called broker-resource-availability<br/><br/>THIS API IS ONLY FOR USE BY TESTING FOR CONFIRMING NAMESPACE ALLOCATION ALGORITHM

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

@return map[string]ResourceUnit

func (*BrokerStatsApiService) GetLoadReport 

func (a *BrokerStatsApiService) GetLoadReport(ctx context.Context) (LoadReport, *http.Response, error)

BrokerStatsApiService Get Load for this broker consists of topics stats & systemResourceUsage

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return LoadReport

func (*BrokerStatsApiService) GetMBeans 

func (a *BrokerStatsApiService) GetMBeans(ctx context.Context) ([]Metrics, *http.Response, error)

BrokerStatsApiService Get all the mbean details of this broker JVM

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Metrics

func (*BrokerStatsApiService) GetMetrics 

func (a *BrokerStatsApiService) GetMetrics(ctx context.Context) ([]Metrics, *http.Response, error)

BrokerStatsApiService Gets the metrics for Monitoring Requested should be executed by Monitoring agent on each broker to fetch the metrics

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Metrics

func (*BrokerStatsApiService) GetPendingBookieOpsStats 

func (a *BrokerStatsApiService) GetPendingBookieOpsStats(ctx context.Context) (map[string]PendingBookieOpsStats, *http.Response, error)

BrokerStatsApiService Get pending bookie client op stats by namesapce

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return map[string]PendingBookieOpsStats

func (*BrokerStatsApiService) GetTopics2 

func (a *BrokerStatsApiService) GetTopics2(ctx context.Context) (map[string]interface{}, *http.Response, error)

BrokerStatsApiService Get all the topic stats by namespace

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return map[string]interface{}

type BrokersApiService 

type BrokersApiService service

func (*BrokersApiService) GetActiveBrokers 

func (a *BrokersApiService) GetActiveBrokers(ctx context.Context, cluster string) ([]string, *http.Response, error)

BrokersApiService Get the list of active brokers (web service addresses) in the cluster.If authorization is not enabled, any cluster name is valid.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param cluster

@return []string

func (*BrokersApiService) GetAllDynamicConfigurations 

func (a *BrokersApiService) GetAllDynamicConfigurations(ctx context.Context) (map[string]map[string]interface{}, *http.Response, error)

BrokersApiService Get value of all dynamic configurations' value overridden on local config

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return map[string]map[string]interface{}

func (*BrokersApiService) GetDynamicConfigurationName 

func (a *BrokersApiService) GetDynamicConfigurationName(ctx context.Context) ([]map[string]interface{}, *http.Response, error)

BrokersApiService Get all updatable dynamic configurations's name

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []map[string]interface{}

func (*BrokersApiService) GetInternalConfigurationData 

func (a *BrokersApiService) GetInternalConfigurationData(ctx context.Context) (InternalConfigurationData, *http.Response, error)

BrokersApiService Get the internal configuration data

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return InternalConfigurationData

func (*BrokersApiService) GetOwnedNamespaes 

func (a *BrokersApiService) GetOwnedNamespaes(ctx context.Context, clusterName string, brokerWebserviceurl string) (map[string]NamespaceOwnershipStatus, *http.Response, error)

BrokersApiService Get the list of namespaces served by the specific broker

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param clusterName
  • @param brokerWebserviceurl

@return map[string]NamespaceOwnershipStatus

func (*BrokersApiService) GetRuntimeConfiguration 

func (a *BrokersApiService) GetRuntimeConfiguration(ctx context.Context) (map[string]map[string]interface{}, *http.Response, error)

BrokersApiService Get all runtime configurations. This operation requires Pulsar super-user privileges.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return map[string]map[string]interface{}

func (*BrokersApiService) Healthcheck 

func (a *BrokersApiService) Healthcheck(ctx context.Context) (*http.Response, error)

BrokersApiService Run a healthcheck against the broker

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*BrokersApiService) UpdateDynamicConfiguration 

func (a *BrokersApiService) UpdateDynamicConfiguration(ctx context.Context, configName string, configValue string) (*http.Response, error)

BrokersApiService Update dynamic serviceconfiguration into zk only. This operation requires Pulsar super-user privileges.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param configName
  • @param configValue

type BundlesData 

type BundlesData struct {
	Boundaries []string `json:"boundaries,omitempty"`
	NumBundles int32    `json:"numBundles,omitempty"`
}

type ClearNamespaceBacklogForSubscriptionOpts 

type ClearNamespaceBacklogForSubscriptionOpts struct {
	Authoritative optional.Bool
}

type ClearNamespaceBacklogOpts 

type ClearNamespaceBacklogOpts struct {
	Authoritative optional.Bool
}

type ClearNamespaceBundleBacklogForSubscriptionOpts 

type ClearNamespaceBundleBacklogForSubscriptionOpts struct {
	Authoritative optional.Bool
}

type ClearNamespaceBundleBacklogOpts 

type ClearNamespaceBundleBacklogOpts struct {
	Authoritative optional.Bool
}

type ClusterData 

type ClusterData struct {
	// The HTTP rest service URL (for admin operations)
	ServiceUrl string `json:"serviceUrl,omitempty"`
	// The HTTPS rest service URL (for admin operations)
	ServiceUrlTls string `json:"serviceUrlTls,omitempty"`
	// The broker service url (for produce and consume operations)
	BrokerServiceUrl string `json:"brokerServiceUrl,omitempty"`
	// The secured broker service url (for produce and consume operations)
	BrokerServiceUrlTls string `json:"brokerServiceUrlTls,omitempty"`
	// A set of peer cluster names
	PeerClusterNames []string `json:"peerClusterNames,omitempty"`
}

The configuration data for a cluster

type ClustersApiService 

type ClustersApiService service

func (*ClustersApiService) CreateCluster 

func (a *ClustersApiService) CreateCluster(ctx context.Context, cluster string, body ClusterData) (*http.Response, error)

ClustersApiService Create a new cluster. This operation requires Pulsar superuser privileges, and the name cannot contain the '/' characters.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param cluster The cluster name
  • @param body The cluster data

func (*ClustersApiService) DeleteCluster 

func (a *ClustersApiService) DeleteCluster(ctx context.Context, cluster string) (*http.Response, error)

ClustersApiService Delete an existing cluster. This operation requires Pulsar superuser privileges.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param cluster The cluster name

func (*ClustersApiService) DeleteFailureDomain 

func (a *ClustersApiService) DeleteFailureDomain(ctx context.Context, cluster string, domainName string) (*http.Response, error)

ClustersApiService Delete the failure domain of the cluster This operation requires Pulsar superuser privileges.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param cluster The cluster name
  • @param domainName The failure domain name

func (*ClustersApiService) DeleteNamespaceIsolationPolicy 

func (a *ClustersApiService) DeleteNamespaceIsolationPolicy(ctx context.Context, cluster string, policyName string) (*http.Response, error)

ClustersApiService Delete namespace isolation policy. This operation requires Pulsar superuser privileges.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param cluster The cluster name
  • @param policyName The namespace isolation policy name

func (*ClustersApiService) GetBrokerWithNamespaceIsolationPolicy 

func (a *ClustersApiService) GetBrokerWithNamespaceIsolationPolicy(ctx context.Context, cluster string, broker string) (BrokerNamespaceIsolationData, *http.Response, error)

ClustersApiService Get a broker with namespace-isolation policies attached to it. This operation requires Pulsar superuser privileges.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param cluster The cluster name
  • @param broker The broker name (<broker-hostname>:<web-service-port>)

@return BrokerNamespaceIsolationData

func (*ClustersApiService) GetBrokersWithNamespaceIsolationPolicy 

func (a *ClustersApiService) GetBrokersWithNamespaceIsolationPolicy(ctx context.Context, cluster string) ([]BrokerNamespaceIsolationData, *http.Response, error)

ClustersApiService Get list of brokers with namespace-isolation policies attached to them. This operation requires Pulsar superuser privileges.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param cluster The cluster name

@return []BrokerNamespaceIsolationData

func (*ClustersApiService) GetCluster 

func (a *ClustersApiService) GetCluster(ctx context.Context, cluster string) (ClusterData, *http.Response, error)

ClustersApiService Get the configuration for the specified cluster. This operation requires Pulsar superuser privileges.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param cluster The cluster name

@return ClusterData

func (*ClustersApiService) GetClusters 

func (a *ClustersApiService) GetClusters(ctx context.Context) ([]string, *http.Response, error)

ClustersApiService Get the list of all the Pulsar clusters.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []string

func (*ClustersApiService) GetDomain 

func (a *ClustersApiService) GetDomain(ctx context.Context, cluster string, domainName string) (FailureDomain, *http.Response, error)

ClustersApiService Get a domain in a cluster This operation requires Pulsar superuser privileges.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param cluster The cluster name
  • @param domainName The failure domain name

@return FailureDomain

func (*ClustersApiService) GetFailureDomains 

func (a *ClustersApiService) GetFailureDomains(ctx context.Context, cluster string) (map[string]FailureDomain, *http.Response, error)

ClustersApiService Get the cluster failure domains. This operation requires Pulsar superuser privileges.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param cluster The cluster name

@return map[string]FailureDomain

func (*ClustersApiService) GetNamespaceIsolationPolicies 

func (a *ClustersApiService) GetNamespaceIsolationPolicies(ctx context.Context, cluster string) (map[string]NamespaceIsolationData, *http.Response, error)

ClustersApiService Get the namespace isolation policies assigned to the cluster. This operation requires Pulsar superuser privileges.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param cluster The cluster name

@return map[string]NamespaceIsolationData

func (*ClustersApiService) GetNamespaceIsolationPolicy 

func (a *ClustersApiService) GetNamespaceIsolationPolicy(ctx context.Context, cluster string, policyName string) (NamespaceIsolationData, *http.Response, error)

ClustersApiService Get the single namespace isolation policy assigned to the cluster. This operation requires Pulsar superuser privileges.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param cluster The cluster name
  • @param policyName The name of the namespace isolation policy

@return NamespaceIsolationData

func (*ClustersApiService) GetPeerCluster 

func (a *ClustersApiService) GetPeerCluster(ctx context.Context, cluster string) ([]string, *http.Response, error)

ClustersApiService Get the peer-cluster data for the specified cluster. This operation requires Pulsar superuser privileges.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param cluster The cluster name

@return []string

func (*ClustersApiService) SetFailureDomain 

func (a *ClustersApiService) SetFailureDomain(ctx context.Context, cluster string, domainName string, body FailureDomain) (*http.Response, error)

ClustersApiService Set the failure domain of the cluster. This operation requires Pulsar superuser privileges.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param cluster The cluster name
  • @param domainName The failure domain name
  • @param body The configuration data of a failure domain

func (*ClustersApiService) SetNamespaceIsolationPolicy 

func (a *ClustersApiService) SetNamespaceIsolationPolicy(ctx context.Context, cluster string, policyName string, body NamespaceIsolationData) (*http.Response, error)

ClustersApiService Set namespace isolation policy. This operation requires Pulsar superuser privileges.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param cluster The cluster name
  • @param policyName The namespace isolation policy name
  • @param body The namespace isolation policy data

func (*ClustersApiService) SetPeerClusterNames 

func (a *ClustersApiService) SetPeerClusterNames(ctx context.Context, cluster string, body []string) (*http.Response, error)

ClustersApiService Update peer-cluster-list for a cluster. This operation requires Pulsar superuser privileges.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param cluster The cluster name
  • @param body The list of peer cluster names

func (*ClustersApiService) UpdateCluster 

func (a *ClustersApiService) UpdateCluster(ctx context.Context, cluster string, body ClusterData) (*http.Response, error)

ClustersApiService Update the configuration for a cluster. This operation requires Pulsar superuser privileges.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param cluster The cluster name
  • @param body The cluster data

type CompactOpts 

type CompactOpts struct {
	Authoritative optional.Bool
}

type CompactionStatusOpts 

type CompactionStatusOpts struct {
	Authoritative optional.Bool
}

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

type ConsumerStats 

type ConsumerStats struct {
	MsgRateOut                   float64           `json:"msgRateOut,omitempty"`
	MsgThroughputOut             float64           `json:"msgThroughputOut,omitempty"`
	MsgRateRedeliver             float64           `json:"msgRateRedeliver,omitempty"`
	ConsumerName                 string            `json:"consumerName,omitempty"`
	AvailablePermits             int32             `json:"availablePermits,omitempty"`
	UnackedMessages              int32             `json:"unackedMessages,omitempty"`
	BlockedConsumerOnUnackedMsgs bool              `json:"blockedConsumerOnUnackedMsgs,omitempty"`
	Metadata                     map[string]string `json:"metadata,omitempty"`
	ConnectedSince               string            `json:"connectedSince,omitempty"`
	ClientVersion                string            `json:"clientVersion,omitempty"`
	Address                      string            `json:"address,omitempty"`
}

type CreateNonPartitionedTopicOpts 

type CreateNonPartitionedTopicOpts struct {
	Authoritative optional.Bool
}

type CreateSubscriptionOpts 

type CreateSubscriptionOpts struct {
	Authoritative optional.Bool
	Replicated    optional.Bool
}

type CreateTenantOpts 

type CreateTenantOpts struct {
	Body optional.Interface
}

type CursorDetails 

type CursorDetails struct {
	CursorBacklog  int64 `json:"cursorBacklog,omitempty"`
	CursorLedgerId int64 `json:"cursorLedgerId,omitempty"`
}

type CursorStats 

type CursorStats struct {
	MarkDeletePosition                       string           `json:"markDeletePosition,omitempty"`
	ReadPosition                             string           `json:"readPosition,omitempty"`
	WaitingReadOp                            bool             `json:"waitingReadOp,omitempty"`
	PendingReadOps                           int32            `json:"pendingReadOps,omitempty"`
	MessagesConsumedCounter                  int64            `json:"messagesConsumedCounter,omitempty"`
	CursorLedger                             int64            `json:"cursorLedger,omitempty"`
	CursorLedgerLastEntry                    int64            `json:"cursorLedgerLastEntry,omitempty"`
	IndividuallyDeletedMessages              string           `json:"individuallyDeletedMessages,omitempty"`
	LastLedgerSwitchTimestamp                string           `json:"lastLedgerSwitchTimestamp,omitempty"`
	State                                    string           `json:"state,omitempty"`
	NumberOfEntriesSinceFirstNotAckedMessage int64            `json:"numberOfEntriesSinceFirstNotAckedMessage,omitempty"`
	TotalNonContiguousDeletedMessagesRange   int32            `json:"totalNonContiguousDeletedMessagesRange,omitempty"`
	Properties                               map[string]int64 `json:"properties,omitempty"`
}

type DeleteNamespaceBundleOpts 

type DeleteNamespaceBundleOpts struct {
	Authoritative optional.Bool
}

type DeleteNamespaceOpts 

type DeleteNamespaceOpts struct {
	Authoritative optional.Bool
}

type DeletePartitionedTopicOpts 

type DeletePartitionedTopicOpts struct {
	Force         optional.Bool
	Authoritative optional.Bool
}

type DeleteSchemaOpts 

type DeleteSchemaOpts struct {
	Authoritative optional.Bool
}

type DeleteSchemaResponse 

type DeleteSchemaResponse struct {
	Version int64 `json:"version,omitempty"`
}

type DeleteSubscriptionOpts 

type DeleteSubscriptionOpts struct {
	Authoritative optional.Bool
}

type DeleteTopicOpts 

type DeleteTopicOpts struct {
	Force         optional.Bool
	Authoritative optional.Bool
}

type DispatchRate 

type DispatchRate struct {
	DispatchThrottlingRateInMsg  int32 `json:"dispatchThrottlingRateInMsg,omitempty"`
	DispatchThrottlingRateInByte int64 `json:"dispatchThrottlingRateInByte,omitempty"`
	RatePeriodInSecond           int32 `json:"ratePeriodInSecond,omitempty"`
}

type ExpireMessagesForAllSubscriptionsOpts 

type ExpireMessagesForAllSubscriptionsOpts struct {
	Authoritative optional.Bool
}

type ExpireTopicMessagesOpts 

type ExpireTopicMessagesOpts struct {
	Authoritative optional.Bool
}

type FailureDomain 

type FailureDomain struct {
	// The collection of brokers in the same failure domain
	Brokers []string `json:"brokers,omitempty"`
}

The data of a failure domain configuration in a cluster

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type GetAntiAffinityNamespacesOpts 

type GetAntiAffinityNamespacesOpts struct {
	Tenant optional.String
}

type GetBacklogOpts 

type GetBacklogOpts struct {
	Authoritative optional.Bool
}

type GetInternalStatsOpts 

type GetInternalStatsOpts struct {
	Authoritative optional.Bool
}

type GetLastMessageIdOpts 

type GetLastMessageIdOpts struct {
	Authoritative optional.Bool
}

type GetPartitionedMetadataOpts 

type GetPartitionedMetadataOpts struct {
	Authoritative optional.Bool
}

type GetPartitionedStatsOpts 

type GetPartitionedStatsOpts struct {
	Authoritative optional.Bool
}

type GetSchemaOpts 

type GetSchemaOpts struct {
	Authoritative optional.Bool
}

type GetSchemaResponse 

type GetSchemaResponse struct {
	Version    int64             `json:"version,omitempty"`
	Type       string            `json:"type,omitempty"`
	Timestamp  int64             `json:"timestamp,omitempty"`
	Data       string            `json:"data,omitempty"`
	Properties map[string]string `json:"properties,omitempty"`
}

type GetSchema_1Opts 

type GetSchema_1Opts struct {
	Authoritative optional.Bool
}

type GetStatsOpts 

type GetStatsOpts struct {
	Authoritative optional.Bool
}

type GetSubscriptionsOpts 

type GetSubscriptionsOpts struct {
	Authoritative optional.Bool
}

type GetTopicsOpts 

type GetTopicsOpts struct {
	Mode optional.String
}

type GrantPermissionsOnTopicOpts 

type GrantPermissionsOnTopicOpts struct {
	Body optional.Interface
}

type InternalConfigurationData 

type InternalConfigurationData struct {
	ZookeeperServers          string `json:"zookeeperServers,omitempty"`
	ConfigurationStoreServers string `json:"configurationStoreServers,omitempty"`
	LedgersRootPath           string `json:"ledgersRootPath,omitempty"`
	StateStorageServiceUrl    string `json:"stateStorageServiceUrl,omitempty"`
}

type LedgerDetails 

type LedgerDetails struct {
	Entries   int64 `json:"entries,omitempty"`
	Timestamp int64 `json:"timestamp,omitempty"`
	Size      int64 `json:"size,omitempty"`
	LedgerId  int64 `json:"ledgerId,omitempty"`
}

type LedgerInfo 

type LedgerInfo struct {
	LedgerId  int64 `json:"ledgerId,omitempty"`
	Entries   int64 `json:"entries,omitempty"`
	Size      int64 `json:"size,omitempty"`
	Offloaded bool  `json:"offloaded,omitempty"`
}

type LoadReport 

type LoadReport struct {
	Name                       string                          `json:"name,omitempty"`
	BrokerVersionString        string                          `json:"brokerVersionString,omitempty"`
	WebServiceUrl              string                          `json:"webServiceUrl,omitempty"`
	WebServiceUrlTls           string                          `json:"webServiceUrlTls,omitempty"`
	PulsarServiceUrl           string                          `json:"pulsarServiceUrl,omitempty"`
	PulsarServiceUrlTls        string                          `json:"pulsarServiceUrlTls,omitempty"`
	PersistentTopicsEnabled    bool                            `json:"persistentTopicsEnabled,omitempty"`
	NonPersistentTopicsEnabled bool                            `json:"nonPersistentTopicsEnabled,omitempty"`
	Timestamp                  int64                           `json:"timestamp,omitempty"`
	MsgRateIn                  float64                         `json:"msgRateIn,omitempty"`
	MsgRateOut                 float64                         `json:"msgRateOut,omitempty"`
	NumTopics                  int32                           `json:"numTopics,omitempty"`
	NumConsumers               int32                           `json:"numConsumers,omitempty"`
	NumProducers               int32                           `json:"numProducers,omitempty"`
	NumBundles                 int32                           `json:"numBundles,omitempty"`
	SystemResourceUsage        SystemResourceUsage             `json:"systemResourceUsage,omitempty"`
	BundleStats                map[string]NamespaceBundleStats `json:"bundleStats,omitempty"`
	BundleGains                []string                        `json:"bundleGains,omitempty"`
	BundleLosses               []string                        `json:"bundleLosses,omitempty"`
	AllocatedCPU               float64                         `json:"allocatedCPU,omitempty"`
	AllocatedMemory            float64                         `json:"allocatedMemory,omitempty"`
	AllocatedBandwidthIn       float64                         `json:"allocatedBandwidthIn,omitempty"`
	AllocatedBandwidthOut      float64                         `json:"allocatedBandwidthOut,omitempty"`
	AllocatedMsgRateIn         float64                         `json:"allocatedMsgRateIn,omitempty"`
	AllocatedMsgRateOut        float64                         `json:"allocatedMsgRateOut,omitempty"`
	PreAllocatedCPU            float64                         `json:"preAllocatedCPU,omitempty"`
	PreAllocatedMemory         float64                         `json:"preAllocatedMemory,omitempty"`
	PreAllocatedBandwidthIn    float64                         `json:"preAllocatedBandwidthIn,omitempty"`
	PreAllocatedBandwidthOut   float64                         `json:"preAllocatedBandwidthOut,omitempty"`
	PreAllocatedMsgRateIn      float64                         `json:"preAllocatedMsgRateIn,omitempty"`
	PreAllocatedMsgRateOut     float64                         `json:"preAllocatedMsgRateOut,omitempty"`
	OverLoaded                 bool                            `json:"overLoaded,omitempty"`
	LoadReportType             string                          `json:"loadReportType,omitempty"`
	UnderLoaded                bool                            `json:"underLoaded,omitempty"`
	BandwidthIn                ResourceUsage                   `json:"bandwidthIn,omitempty"`
	BandwidthOut               ResourceUsage                   `json:"bandwidthOut,omitempty"`
	Memory                     ResourceUsage                   `json:"memory,omitempty"`
	LastUpdate                 int64                           `json:"lastUpdate,omitempty"`
	MsgThroughputIn            float64                         `json:"msgThroughputIn,omitempty"`
	MsgThroughputOut           float64                         `json:"msgThroughputOut,omitempty"`
	Cpu                        ResourceUsage                   `json:"cpu,omitempty"`
	DirectMemory               ResourceUsage                   `json:"directMemory,omitempty"`
}

type LongRunningProcessStatus 

type LongRunningProcessStatus struct {
	Status    string `json:"status,omitempty"`
	LastError string `json:"lastError,omitempty"`
}

type MessageIdImpl 

type MessageIdImpl struct {
	LedgerId       int64 `json:"ledgerId,omitempty"`
	EntryId        int64 `json:"entryId,omitempty"`
	PartitionIndex int32 `json:"partitionIndex,omitempty"`
}

type Metrics 

type Metrics struct {
	Metrics    map[string]map[string]interface{} `json:"metrics,omitempty"`
	Dimensions map[string]string                 `json:"dimensions,omitempty"`
}

type NamespaceBundleStats 

type NamespaceBundleStats struct {
	MsgRateIn        float64 `json:"msgRateIn,omitempty"`
	MsgThroughputIn  float64 `json:"msgThroughputIn,omitempty"`
	MsgRateOut       float64 `json:"msgRateOut,omitempty"`
	MsgThroughputOut float64 `json:"msgThroughputOut,omitempty"`
	ConsumerCount    int32   `json:"consumerCount,omitempty"`
	ProducerCount    int32   `json:"producerCount,omitempty"`
	Topics           int64   `json:"topics,omitempty"`
	CacheSize        int64   `json:"cacheSize,omitempty"`
}

type NamespaceIsolationData 

type NamespaceIsolationData struct {
	// The list of namespaces to apply this namespace isolation data
	Namespaces []string `json:"namespaces,omitempty"`
	// The list of secondary brokers for serving the list of namespaces in this isolation policy
	Primary            []string               `json:"primary,omitempty"`
	AutoFailoverPolicy AutoFailoverPolicyData `json:"auto_failover_policy,omitempty"`
}

The data of namespace isolation configuration

type NamespaceOwnershipStatus 

type NamespaceOwnershipStatus struct {
	BrokerAssignment string `json:"broker_assignment,omitempty"`
	IsControlled     bool   `json:"is_controlled,omitempty"`
	IsActive         bool   `json:"is_active,omitempty"`
}

type NamespacesApiService 

type NamespacesApiService service

func (*NamespacesApiService) ClearNamespaceBacklog 

func (a *NamespacesApiService) ClearNamespaceBacklog(ctx context.Context, tenant string, namespace string, localVarOptionals *ClearNamespaceBacklogOpts) (*http.Response, error)

func (*NamespacesApiService) ClearNamespaceBacklogForSubscription 

func (a *NamespacesApiService) ClearNamespaceBacklogForSubscription(ctx context.Context, tenant string, namespace string, subscription string, localVarOptionals *ClearNamespaceBacklogForSubscriptionOpts) (*http.Response, error)

func (*NamespacesApiService) ClearNamespaceBundleBacklog 

func (a *NamespacesApiService) ClearNamespaceBundleBacklog(ctx context.Context, tenant string, namespace string, bundle string, localVarOptionals *ClearNamespaceBundleBacklogOpts) (*http.Response, error)

func (*NamespacesApiService) ClearNamespaceBundleBacklogForSubscription 

func (a *NamespacesApiService) ClearNamespaceBundleBacklogForSubscription(ctx context.Context, tenant string, namespace string, subscription string, bundle string, localVarOptionals *ClearNamespaceBundleBacklogForSubscriptionOpts) (*http.Response, error)

func (*NamespacesApiService) ClearOffloadDeletionLag 

func (a *NamespacesApiService) ClearOffloadDeletionLag(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Clear the namespace configured offload deletion lag. The topics in the namespace will fallback to using the default configured deletion lag for the broker

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) CreateNamespace 

func (a *NamespacesApiService) CreateNamespace(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Creates a new namespace with the specified policies

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) DeleteBookieAffinityGroup 

func (a *NamespacesApiService) DeleteBookieAffinityGroup(ctx context.Context, property string, namespace string) (*http.Response, error)

NamespacesApiService Delete the bookie-affinity-group from namespace-local policy.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param property
  • @param namespace

func (*NamespacesApiService) DeleteNamespace 

func (a *NamespacesApiService) DeleteNamespace(ctx context.Context, tenant string, namespace string, localVarOptionals *DeleteNamespaceOpts) (*http.Response, error)

func (*NamespacesApiService) DeleteNamespaceBundle 

func (a *NamespacesApiService) DeleteNamespaceBundle(ctx context.Context, tenant string, namespace string, bundle string, localVarOptionals *DeleteNamespaceBundleOpts) (*http.Response, error)

func (*NamespacesApiService) GetAntiAffinityNamespaces 

func (a *NamespacesApiService) GetAntiAffinityNamespaces(ctx context.Context, cluster string, group string, localVarOptionals *GetAntiAffinityNamespacesOpts) ([]map[string]interface{}, *http.Response, error)

func (*NamespacesApiService) GetBacklogQuotaMap 

func (a *NamespacesApiService) GetBacklogQuotaMap(ctx context.Context, tenant string, namespace string) (map[string]map[string]interface{}, *http.Response, error)

NamespacesApiService Get backlog quota map on a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

@return map[string]map[string]interface{}

func (*NamespacesApiService) GetBookieAffinityGroup 

func (a *NamespacesApiService) GetBookieAffinityGroup(ctx context.Context, property string, namespace string) (BookieAffinityGroupData, *http.Response, error)

NamespacesApiService Get the bookie-affinity-group from namespace-local policy.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param property
  • @param namespace

@return BookieAffinityGroupData

func (*NamespacesApiService) GetBundlesData 

func (a *NamespacesApiService) GetBundlesData(ctx context.Context, tenant string, namespace string) (BundlesData, *http.Response, error)

NamespacesApiService Get the bundles split data.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

@return BundlesData

func (*NamespacesApiService) GetCompactionThreshold 

func (a *NamespacesApiService) GetCompactionThreshold(ctx context.Context, tenant string, namespace string) (int64, *http.Response, error)

NamespacesApiService Maximum number of uncompacted bytes in topics before compaction is triggered. The backlog size is compared to the threshold periodically. A threshold of 0 disabled automatic compaction

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

@return int64

func (*NamespacesApiService) GetDispatchRate 

func (a *NamespacesApiService) GetDispatchRate(ctx context.Context, tenant string, namespace string) (DispatchRate, *http.Response, error)

NamespacesApiService Get dispatch-rate configured for the namespace, -1 represents not configured yet

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

@return DispatchRate

func (*NamespacesApiService) GetMaxConsumersPerSubscription 

func (a *NamespacesApiService) GetMaxConsumersPerSubscription(ctx context.Context, tenant string, namespace string) (int32, *http.Response, error)

NamespacesApiService Get maxConsumersPerSubscription config on a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

@return int32

func (*NamespacesApiService) GetMaxConsumersPerTopic 

func (a *NamespacesApiService) GetMaxConsumersPerTopic(ctx context.Context, tenant string, namespace string) (int32, *http.Response, error)

NamespacesApiService Get maxConsumersPerTopic config on a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

@return int32

func (*NamespacesApiService) GetMaxProducersPerTopic 

func (a *NamespacesApiService) GetMaxProducersPerTopic(ctx context.Context, tenant string, namespace string) (int32, *http.Response, error)

NamespacesApiService Get maxProducersPerTopic config on a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

@return int32

func (*NamespacesApiService) GetNamespaceAntiAffinityGroup 

func (a *NamespacesApiService) GetNamespaceAntiAffinityGroup(ctx context.Context, tenant string, namespace string) (string, *http.Response, error)

NamespacesApiService Get anti-affinity group of a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

@return string

func (*NamespacesApiService) GetNamespaceMessageTTL 

func (a *NamespacesApiService) GetNamespaceMessageTTL(ctx context.Context, tenant string, namespace string) (int32, *http.Response, error)

NamespacesApiService Get the message TTL for the namespace

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

@return int32

func (*NamespacesApiService) GetNamespaceReplicationClusters 

func (a *NamespacesApiService) GetNamespaceReplicationClusters(ctx context.Context, tenant string, namespace string) ([]string, *http.Response, error)

NamespacesApiService Get the replication clusters for a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

@return []string

func (*NamespacesApiService) GetOffloadDeletionLag 

func (a *NamespacesApiService) GetOffloadDeletionLag(ctx context.Context, tenant string, namespace string) (int64, *http.Response, error)

NamespacesApiService Number of milliseconds to wait before deleting a ledger segment which has been offloaded from the Pulsar cluster's local storage (i.e. BookKeeper) A negative value denotes that deletion has been completely disabled. &#39;null&#39; denotes that the topics in the namespace will fall back to the broker default for deletion lag.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

@return int64

func (*NamespacesApiService) GetOffloadThreshold 

func (a *NamespacesApiService) GetOffloadThreshold(ctx context.Context, tenant string, namespace string) (int64, *http.Response, error)

NamespacesApiService Maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage A negative value disables automatic offloading

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

@return int64

func (*NamespacesApiService) GetPermissions 

func (a *NamespacesApiService) GetPermissions(ctx context.Context, tenant string, cluster string, namespace string) (map[string]map[string]interface{}, *http.Response, error)

NamespacesApiService Retrieve the permissions for a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param cluster
  • @param namespace

@return map[string]map[string]interface{}

func (*NamespacesApiService) GetPersistence 

func (a *NamespacesApiService) GetPersistence(ctx context.Context, tenant string, namespace string) (PersistencePolicies, *http.Response, error)

NamespacesApiService Get the persistence configuration for a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

@return PersistencePolicies

func (*NamespacesApiService) GetPolicies 

func (a *NamespacesApiService) GetPolicies(ctx context.Context, tenant string, namespace string) (Policies, *http.Response, error)

NamespacesApiService Get the dump all the policies specified for a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

@return Policies

func (*NamespacesApiService) GetReplicatorDispatchRate 

func (a *NamespacesApiService) GetReplicatorDispatchRate(ctx context.Context, tenant string, namespace string) (DispatchRate, *http.Response, error)

NamespacesApiService Get replicator dispatch-rate configured for the namespace, -1 represents not configured yet

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

@return DispatchRate

func (*NamespacesApiService) GetRetention 

func (a *NamespacesApiService) GetRetention(ctx context.Context, tenant string, namespace string) (RetentionPolicies, *http.Response, error)

NamespacesApiService Get retention config on a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

@return RetentionPolicies

func (*NamespacesApiService) GetSchemaAutoUpdateCompatibilityStrategy 

func (a *NamespacesApiService) GetSchemaAutoUpdateCompatibilityStrategy(ctx context.Context, tenant string, namespace string) (string, *http.Response, error)

NamespacesApiService The strategy used to check the compatibility of new schemas, provided by producers, before automatically updating the schema The value AutoUpdateDisabled prevents producers from updating the schema. If set to AutoUpdateDisabled, schemas must be updated through the REST api

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

@return string

func (*NamespacesApiService) GetSchemaValidtionEnforced 

func (a *NamespacesApiService) GetSchemaValidtionEnforced(ctx context.Context, tenant string, namespace string) (bool, *http.Response, error)

NamespacesApiService Get schema validation enforced flag for namespace. If the flag is set to true, when a producer without a schema attempts to produce to a topic with schema in this namespace, the producer will be failed to connect. PLEASE be carefully on using this, since non-java clients don&#39;t support schema.if you enable this setting, it will cause non-java clients failed to produce.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

@return bool

func (*NamespacesApiService) GetSubscribeRate 

func (a *NamespacesApiService) GetSubscribeRate(ctx context.Context, tenant string, namespace string) (SubscribeRate, *http.Response, error)

NamespacesApiService Get subscribe-rate configured for the namespace

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

@return SubscribeRate

func (*NamespacesApiService) GetSubscriptionDispatchRate 

func (a *NamespacesApiService) GetSubscriptionDispatchRate(ctx context.Context, tenant string, namespace string) (DispatchRate, *http.Response, error)

NamespacesApiService Get Subscription dispatch-rate configured for the namespace, -1 represents not configured yet

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

@return DispatchRate

func (*NamespacesApiService) GetTenantNamespaces 

func (a *NamespacesApiService) GetTenantNamespaces(ctx context.Context, tenant string) ([]string, *http.Response, error)

NamespacesApiService Get the list of all the namespaces for a certain tenant.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant

@return []string

func (*NamespacesApiService) GetTopics 

func (a *NamespacesApiService) GetTopics(ctx context.Context, tenant string, namespace string, localVarOptionals *GetTopicsOpts) ([]string, *http.Response, error)

func (*NamespacesApiService) GrantPermissionOnNamespace 

func (a *NamespacesApiService) GrantPermissionOnNamespace(ctx context.Context, tenant string, namespace string, role string) (*http.Response, error)

NamespacesApiService Grant a new permission to a role on a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace
  • @param role

func (*NamespacesApiService) ModifyDeduplication 

func (a *NamespacesApiService) ModifyDeduplication(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Enable or disable broker side deduplication for all topics in a namespace

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) ModifyEncryptionRequired 

func (a *NamespacesApiService) ModifyEncryptionRequired(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Message encryption is required or not for all topics in a namespace

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) RemoveBacklogQuota 

func (a *NamespacesApiService) RemoveBacklogQuota(ctx context.Context, tenant string, namespace string, localVarOptionals *RemoveBacklogQuotaOpts) (*http.Response, error)

func (*NamespacesApiService) RemoveNamespaceAntiAffinityGroup 

func (a *NamespacesApiService) RemoveNamespaceAntiAffinityGroup(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Remove anti-affinity group of a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) RevokePermissionsOnNamespace 

func (a *NamespacesApiService) RevokePermissionsOnNamespace(ctx context.Context, tenant string, namespace string, role string) (*http.Response, error)

NamespacesApiService Revoke all permissions to a role on a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace
  • @param role

func (*NamespacesApiService) SetBacklogQuota 

func (a *NamespacesApiService) SetBacklogQuota(ctx context.Context, tenant string, namespace string, localVarOptionals *SetBacklogQuotaOpts) (*http.Response, error)

func (*NamespacesApiService) SetBookieAffinityGroup 

func (a *NamespacesApiService) SetBookieAffinityGroup(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Set the bookie-affinity-group to namespace-persistent policy.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) SetCompactionThreshold 

func (a *NamespacesApiService) SetCompactionThreshold(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Set maximum number of uncompacted bytes in a topic before compaction is triggered. The backlog size is compared to the threshold periodically. A threshold of 0 disabled automatic compaction

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) SetDispatchRate 

func (a *NamespacesApiService) SetDispatchRate(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Set dispatch-rate throttling for all topics of the namespace

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) SetMaxConsumersPerSubscription 

func (a *NamespacesApiService) SetMaxConsumersPerSubscription(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Set maxConsumersPerSubscription configuration on a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) SetMaxConsumersPerTopic 

func (a *NamespacesApiService) SetMaxConsumersPerTopic(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Set maxConsumersPerTopic configuration on a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) SetMaxProducersPerTopic 

func (a *NamespacesApiService) SetMaxProducersPerTopic(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Set maxProducersPerTopic configuration on a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) SetNamespaceAntiAffinityGroup 

func (a *NamespacesApiService) SetNamespaceAntiAffinityGroup(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Set anti-affinity group for a namespace

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) SetNamespaceMessageTTL 

func (a *NamespacesApiService) SetNamespaceMessageTTL(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Set message TTL in seconds for namespace

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) SetNamespaceReplicationClusters 

func (a *NamespacesApiService) SetNamespaceReplicationClusters(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Set the replication clusters for a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) SetOffloadDeletionLag 

func (a *NamespacesApiService) SetOffloadDeletionLag(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Set number of milliseconds to wait before deleting a ledger segment which has been offloaded from the Pulsar cluster's local storage (i.e. BookKeeper) A negative value disables the deletion completely.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) SetOffloadThreshold 

func (a *NamespacesApiService) SetOffloadThreshold(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Set maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage A negative value disables automatic offloading

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) SetPersistence 

func (a *NamespacesApiService) SetPersistence(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Set the persistence configuration for all the topics on a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) SetReplicatorDispatchRate 

func (a *NamespacesApiService) SetReplicatorDispatchRate(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Set replicator dispatch-rate throttling for all topics of the namespace

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) SetRetention 

func (a *NamespacesApiService) SetRetention(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Set retention configuration on a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) SetSchemaAutoUpdateCompatibilityStrategy 

func (a *NamespacesApiService) SetSchemaAutoUpdateCompatibilityStrategy(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Update the strategy used to check the compatibility of new schemas, provided by producers, before automatically updating the schema The value AutoUpdateDisabled prevents producers from updating the schema. If set to AutoUpdateDisabled, schemas must be updated through the REST api

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) SetSchemaValidtionEnforced 

func (a *NamespacesApiService) SetSchemaValidtionEnforced(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Set schema validation enforced flag on namespace. If the flag is set to true, when a producer without a schema attempts to produce to a topic with schema in this namespace, the producer will be failed to connect. PLEASE be carefully on using this, since non-java clients don&#39;t support schema.if you enable this setting, it will cause non-java clients failed to produce.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) SetSubscribeRate 

func (a *NamespacesApiService) SetSubscribeRate(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Set subscribe-rate throttling for all topics of the namespace

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) SetSubscriptionAuthMode 

func (a *NamespacesApiService) SetSubscriptionAuthMode(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Set a subscription auth mode for all the topics on a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) SetSubscriptionDispatchRate 

func (a *NamespacesApiService) SetSubscriptionDispatchRate(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Set Subscription dispatch-rate throttling for all topics of the namespace

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) SplitNamespaceBundle 

func (a *NamespacesApiService) SplitNamespaceBundle(ctx context.Context, tenant string, namespace string, bundle string, localVarOptionals *SplitNamespaceBundleOpts) (*http.Response, error)

func (*NamespacesApiService) UnloadNamespace 

func (a *NamespacesApiService) UnloadNamespace(ctx context.Context, tenant string, namespace string) (*http.Response, error)

NamespacesApiService Unload namespace Unload an active namespace from the current broker serving it. Performing this operation will let the brokerremoves all producers, consumers, and connections using this namespace, and close all topics (includingtheir persistent store). During that operation, the namespace is marked as tentatively unavailable until thebroker completes the unloading action. This operation requires strictly super user privileges, since it wouldresult in non-persistent message loss and unexpected connection closure to the clients.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace

func (*NamespacesApiService) UnloadNamespaceBundle 

func (a *NamespacesApiService) UnloadNamespaceBundle(ctx context.Context, tenant string, namespace string, bundle string, localVarOptionals *UnloadNamespaceBundleOpts) (*http.Response, error)

func (*NamespacesApiService) UnsubscribeNamespace 

func (a *NamespacesApiService) UnsubscribeNamespace(ctx context.Context, tenant string, cluster string, namespace string, subscription string, localVarOptionals *UnsubscribeNamespaceOpts) (*http.Response, error)

func (*NamespacesApiService) UnsubscribeNamespaceBundle 

func (a *NamespacesApiService) UnsubscribeNamespaceBundle(ctx context.Context, tenant string, namespace string, subscription string, bundle string, localVarOptionals *UnsubscribeNamespaceBundleOpts) (*http.Response, error)

type NonPersistentPublisherStats 

type NonPersistentPublisherStats struct {
	MsgRateIn       float64           `json:"msgRateIn,omitempty"`
	MsgThroughputIn float64           `json:"msgThroughputIn,omitempty"`
	AverageMsgSize  float64           `json:"averageMsgSize,omitempty"`
	ProducerId      int64             `json:"producerId,omitempty"`
	Metadata        map[string]string `json:"metadata,omitempty"`
	MsgDropRate     float64           `json:"msgDropRate,omitempty"`
	ConnectedSince  string            `json:"connectedSince,omitempty"`
	ClientVersion   string            `json:"clientVersion,omitempty"`
	ProducerName    string            `json:"producerName,omitempty"`
	Address         string            `json:"address,omitempty"`
}

type NonPersistentReplicatorStats 

type NonPersistentReplicatorStats struct {
	MsgRateIn                 float64 `json:"msgRateIn,omitempty"`
	MsgThroughputIn           float64 `json:"msgThroughputIn,omitempty"`
	MsgRateOut                float64 `json:"msgRateOut,omitempty"`
	MsgThroughputOut          float64 `json:"msgThroughputOut,omitempty"`
	MsgRateExpired            float64 `json:"msgRateExpired,omitempty"`
	ReplicationBacklog        int64   `json:"replicationBacklog,omitempty"`
	Connected                 bool    `json:"connected,omitempty"`
	ReplicationDelayInSeconds int64   `json:"replicationDelayInSeconds,omitempty"`
	InboundConnection         string  `json:"inboundConnection,omitempty"`
	InboundConnectedSince     string  `json:"inboundConnectedSince,omitempty"`
	OutboundConnection        string  `json:"outboundConnection,omitempty"`
	OutboundConnectedSince    string  `json:"outboundConnectedSince,omitempty"`
	MsgDropRate               float64 `json:"msgDropRate,omitempty"`
}

type NonPersistentSubscriptionStats 

type NonPersistentSubscriptionStats struct {
	MsgRateOut                       float64         `json:"msgRateOut,omitempty"`
	MsgThroughputOut                 float64         `json:"msgThroughputOut,omitempty"`
	MsgRateRedeliver                 float64         `json:"msgRateRedeliver,omitempty"`
	MsgBacklog                       int64           `json:"msgBacklog,omitempty"`
	BlockedSubscriptionOnUnackedMsgs bool            `json:"blockedSubscriptionOnUnackedMsgs,omitempty"`
	MsgDelayed                       int64           `json:"msgDelayed,omitempty"`
	UnackedMessages                  int64           `json:"unackedMessages,omitempty"`
	Type                             string          `json:"type,omitempty"`
	ActiveConsumerName               string          `json:"activeConsumerName,omitempty"`
	MsgRateExpired                   float64         `json:"msgRateExpired,omitempty"`
	Consumers                        []ConsumerStats `json:"consumers,omitempty"`
	IsReplicated                     bool            `json:"isReplicated,omitempty"`
	MsgDropRate                      float64         `json:"msgDropRate,omitempty"`
}

type NonPersistentTopicApiService 

type NonPersistentTopicApiService service

func (*NonPersistentTopicApiService) Compact 

func (a *NonPersistentTopicApiService) Compact(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *CompactOpts) (*http.Response, error)

func (*NonPersistentTopicApiService) CompactionStatus 

func (a *NonPersistentTopicApiService) CompactionStatus(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *CompactionStatusOpts) (LongRunningProcessStatus, *http.Response, error)

func (*NonPersistentTopicApiService) CreateNonPartitionedTopic 

func (a *NonPersistentTopicApiService) CreateNonPartitionedTopic(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *CreateNonPartitionedTopicOpts) (*http.Response, error)

func (*NonPersistentTopicApiService) CreatePartitionedTopic 

func (a *NonPersistentTopicApiService) CreatePartitionedTopic(ctx context.Context, tenant string, namespace string, topic string, body int32) (*http.Response, error)

NonPersistentTopicApiService Create a partitioned topic. It needs to be called before creating a producer on a partitioned topic.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant Specify the tenant
  • @param namespace Specify the namespace
  • @param topic Specify topic name
  • @param body The number of partitions for the topic

func (*NonPersistentTopicApiService) CreateSubscription 

func (a *NonPersistentTopicApiService) CreateSubscription(ctx context.Context, tenant string, namespace string, topic string, subscriptionName string, localVarOptionals *CreateSubscriptionOpts) (*http.Response, error)

func (*NonPersistentTopicApiService) DeletePartitionedTopic 

func (a *NonPersistentTopicApiService) DeletePartitionedTopic(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *DeletePartitionedTopicOpts) (*http.Response, error)

func (*NonPersistentTopicApiService) DeleteSubscription 

func (a *NonPersistentTopicApiService) DeleteSubscription(ctx context.Context, tenant string, namespace string, topic string, subName string, localVarOptionals *DeleteSubscriptionOpts) (*http.Response, error)

func (*NonPersistentTopicApiService) DeleteTopic 

func (a *NonPersistentTopicApiService) DeleteTopic(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *DeleteTopicOpts) (*http.Response, error)

func (*NonPersistentTopicApiService) ExpireMessagesForAllSubscriptions 

func (a *NonPersistentTopicApiService) ExpireMessagesForAllSubscriptions(ctx context.Context, tenant string, namespace string, topic string, expireTimeInSeconds int32, localVarOptionals *ExpireMessagesForAllSubscriptionsOpts) (*http.Response, error)

func (*NonPersistentTopicApiService) ExpireTopicMessages 

func (a *NonPersistentTopicApiService) ExpireTopicMessages(ctx context.Context, tenant string, namespace string, topic string, subName string, expireTimeInSeconds int32, localVarOptionals *ExpireTopicMessagesOpts) (*http.Response, error)

func (*NonPersistentTopicApiService) GetBacklog 

func (a *NonPersistentTopicApiService) GetBacklog(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *GetBacklogOpts) (PersistentOfflineTopicStats, *http.Response, error)

func (*NonPersistentTopicApiService) GetInternalStats 

func (a *NonPersistentTopicApiService) GetInternalStats(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *GetInternalStatsOpts) (PersistentTopicInternalStats, *http.Response, error)

func (*NonPersistentTopicApiService) GetLastMessageId 

func (a *NonPersistentTopicApiService) GetLastMessageId(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *GetLastMessageIdOpts) (map[string]interface{}, *http.Response, error)

func (*NonPersistentTopicApiService) GetList 

func (a *NonPersistentTopicApiService) GetList(ctx context.Context, tenant string, namespace string) ([]string, *http.Response, error)

NonPersistentTopicApiService Get the list of non-persistent topics under a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant Specify the tenant
  • @param namespace Specify the namespace

@return []string

func (*NonPersistentTopicApiService) GetListFromBundle 

func (a *NonPersistentTopicApiService) GetListFromBundle(ctx context.Context, tenant string, namespace string, bundle string) ([]string, *http.Response, error)

NonPersistentTopicApiService Get the list of non-persistent topics under a namespace bundle.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace
  • @param bundle

@return []string

func (*NonPersistentTopicApiService) GetManagedLedgerInfo 

func (a *NonPersistentTopicApiService) GetManagedLedgerInfo(ctx context.Context, tenant string, namespace string, topic string) (*http.Response, error)

NonPersistentTopicApiService Get the internal stats for the topic.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant Specify the tenant
  • @param namespace Specify the namespace
  • @param topic Specify topic name

func (*NonPersistentTopicApiService) GetPartitionedMetadata 

func (a *NonPersistentTopicApiService) GetPartitionedMetadata(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *GetPartitionedMetadataOpts) (PartitionedTopicMetadata, *http.Response, error)

func (*NonPersistentTopicApiService) GetPartitionedStats 

func (a *NonPersistentTopicApiService) GetPartitionedStats(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *GetPartitionedStatsOpts) (*http.Response, error)

func (*NonPersistentTopicApiService) GetPartitionedTopicList 

func (a *NonPersistentTopicApiService) GetPartitionedTopicList(ctx context.Context, tenant string, namespace string) ([]string, *http.Response, error)

NonPersistentTopicApiService Get the list of partitioned topics under a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant Specify the tenant
  • @param namespace Specify the namespace

@return []string

func (*NonPersistentTopicApiService) GetPermissionsOnTopic 

func (a *NonPersistentTopicApiService) GetPermissionsOnTopic(ctx context.Context, tenant string, namespace string, topic string) (map[string]map[string]interface{}, *http.Response, error)

NonPersistentTopicApiService Get permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at thenamespace level combined (union) with any eventual specific permission set on the topic.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant Specify the tenant
  • @param namespace Specify the namespace
  • @param topic Specify topic name

@return map[string]map[string]interface{}

func (*NonPersistentTopicApiService) GetStats 

func (a *NonPersistentTopicApiService) GetStats(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *GetStatsOpts) (TopicStats, *http.Response, error)

func (*NonPersistentTopicApiService) GetSubscriptions 

func (a *NonPersistentTopicApiService) GetSubscriptions(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *GetSubscriptionsOpts) ([]map[string]interface{}, *http.Response, error)

func (*NonPersistentTopicApiService) GrantPermissionsOnTopic 

func (a *NonPersistentTopicApiService) GrantPermissionsOnTopic(ctx context.Context, tenant string, namespace string, topic string, role string, localVarOptionals *GrantPermissionsOnTopicOpts) (*http.Response, error)

func (*NonPersistentTopicApiService) OffloadStatus 

func (a *NonPersistentTopicApiService) OffloadStatus(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *OffloadStatusOpts) (OffloadProcessStatus, *http.Response, error)

func (*NonPersistentTopicApiService) PeekNthMessage 

func (a *NonPersistentTopicApiService) PeekNthMessage(ctx context.Context, tenant string, namespace string, topic string, subName string, messagePosition int32, localVarOptionals *PeekNthMessageOpts) (*http.Response, error)

func (*NonPersistentTopicApiService) ResetCursor 

func (a *NonPersistentTopicApiService) ResetCursor(ctx context.Context, tenant string, namespace string, topic string, subName string, timestamp int64, localVarOptionals *ResetCursorOpts) (*http.Response, error)

func (*NonPersistentTopicApiService) ResetCursorOnPosition 

func (a *NonPersistentTopicApiService) ResetCursorOnPosition(ctx context.Context, tenant string, namespace string, topic string, subName string, localVarOptionals *ResetCursorOnPositionOpts) (*http.Response, error)

func (*NonPersistentTopicApiService) RevokePermissionsOnTopic 

func (a *NonPersistentTopicApiService) RevokePermissionsOnTopic(ctx context.Context, tenant string, namespace string, topic string, role string) (*http.Response, error)

NonPersistentTopicApiService Revoke permissions on a topic. Revoke permissions to a role on a single topic. If the permission was not set at the topiclevel, but rather at the namespace level, this operation will return an error (HTTP status code 412).

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant Specify the tenant
  • @param namespace Specify the namespace
  • @param topic Specify topic name
  • @param role Client role to which grant permissions

func (*NonPersistentTopicApiService) SkipAllMessages 

func (a *NonPersistentTopicApiService) SkipAllMessages(ctx context.Context, tenant string, namespace string, topic string, subName string, localVarOptionals *SkipAllMessagesOpts) (*http.Response, error)

func (*NonPersistentTopicApiService) SkipMessages 

func (a *NonPersistentTopicApiService) SkipMessages(ctx context.Context, tenant string, namespace string, topic string, subName string, numMessages int32, localVarOptionals *SkipMessagesOpts) (*http.Response, error)

func (*NonPersistentTopicApiService) Terminate 

func (a *NonPersistentTopicApiService) Terminate(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *TerminateOpts) (map[string]interface{}, *http.Response, error)

func (*NonPersistentTopicApiService) TriggerOffload 

func (a *NonPersistentTopicApiService) TriggerOffload(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *TriggerOffloadOpts) (*http.Response, error)

func (*NonPersistentTopicApiService) UnloadTopic 

func (a *NonPersistentTopicApiService) UnloadTopic(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *UnloadTopicOpts) (*http.Response, error)

func (*NonPersistentTopicApiService) UpdatePartitionedTopic 

func (a *NonPersistentTopicApiService) UpdatePartitionedTopic(ctx context.Context, tenant string, namespace string, topic string, body int32) (*http.Response, error)

NonPersistentTopicApiService Increment partitons of an existing partitioned topic. It only increments partitions of existing non-global partitioned-topic

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant Specify the tenant
  • @param namespace Specify the namespace
  • @param topic Specify topic name
  • @param body The number of partitions for the topic

type NonPersistentTopicStats 

type NonPersistentTopicStats struct {
	MsgRateIn           float64                                   `json:"msgRateIn,omitempty"`
	MsgThroughputIn     float64                                   `json:"msgThroughputIn,omitempty"`
	MsgRateOut          float64                                   `json:"msgRateOut,omitempty"`
	MsgThroughputOut    float64                                   `json:"msgThroughputOut,omitempty"`
	AverageMsgSize      float64                                   `json:"averageMsgSize,omitempty"`
	StorageSize         int64                                     `json:"storageSize,omitempty"`
	Publishers          []NonPersistentPublisherStats             `json:"publishers,omitempty"`
	Subscriptions       map[string]NonPersistentSubscriptionStats `json:"subscriptions,omitempty"`
	Replication         map[string]NonPersistentReplicatorStats   `json:"replication,omitempty"`
	DeduplicationStatus string                                    `json:"deduplicationStatus,omitempty"`
	MsgDropRate         float64                                   `json:"msgDropRate,omitempty"`
}

type OffloadProcessStatus 

type OffloadProcessStatus struct {
	Status                  string        `json:"status,omitempty"`
	LastError               string        `json:"lastError,omitempty"`
	FirstUnoffloadedMessage MessageIdImpl `json:"firstUnoffloadedMessage,omitempty"`
}

type OffloadStatusOpts 

type OffloadStatusOpts struct {
	Authoritative optional.Bool
}

type PartitionedTopicMetadata 

type PartitionedTopicMetadata struct {
	Partitions int32 `json:"partitions,omitempty"`
}

type PeekNthMessageOpts 

type PeekNthMessageOpts struct {
	Authoritative optional.Bool
}

type PendingBookieOpsStats 

type PendingBookieOpsStats struct {
	DataLedgerOpenOp     int64 `json:"dataLedgerOpenOp,omitempty"`
	DataLedgerCloseOp    int64 `json:"dataLedgerCloseOp,omitempty"`
	DataLedgerCreateOp   int64 `json:"dataLedgerCreateOp,omitempty"`
	DataLedgerDeleteOp   int64 `json:"dataLedgerDeleteOp,omitempty"`
	CursorLedgerOpenOp   int64 `json:"cursorLedgerOpenOp,omitempty"`
	CursorLedgerCloseOp  int64 `json:"cursorLedgerCloseOp,omitempty"`
	CursorLedgerCreateOp int64 `json:"cursorLedgerCreateOp,omitempty"`
	CursorLedgerDeleteOp int64 `json:"cursorLedgerDeleteOp,omitempty"`
}

type PersistencePolicies 

type PersistencePolicies struct {
	BookkeeperEnsemble             int32   `json:"bookkeeperEnsemble,omitempty"`
	BookkeeperWriteQuorum          int32   `json:"bookkeeperWriteQuorum,omitempty"`
	BookkeeperAckQuorum            int32   `json:"bookkeeperAckQuorum,omitempty"`
	ManagedLedgerMaxMarkDeleteRate float64 `json:"managedLedgerMaxMarkDeleteRate,omitempty"`
}

type PersistentOfflineTopicStats 

type PersistentOfflineTopicStats struct {
	StorageSize       int64                    `json:"storageSize,omitempty"`
	TotalMessages     int64                    `json:"totalMessages,omitempty"`
	MessageBacklog    int64                    `json:"messageBacklog,omitempty"`
	BrokerName        string                   `json:"brokerName,omitempty"`
	TopicName         string                   `json:"topicName,omitempty"`
	DataLedgerDetails []LedgerDetails          `json:"dataLedgerDetails,omitempty"`
	CursorDetails     map[string]CursorDetails `json:"cursorDetails,omitempty"`
	StatGeneratedAt   time.Time                `json:"statGeneratedAt,omitempty"`
}

type PersistentTopicApiService 

type PersistentTopicApiService service

func (*PersistentTopicApiService) Compact 

func (a *PersistentTopicApiService) Compact(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *CompactOpts) (*http.Response, error)

func (*PersistentTopicApiService) CompactionStatus 

func (a *PersistentTopicApiService) CompactionStatus(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *CompactionStatusOpts) (LongRunningProcessStatus, *http.Response, error)

func (*PersistentTopicApiService) CreateNonPartitionedTopic 

func (a *PersistentTopicApiService) CreateNonPartitionedTopic(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *CreateNonPartitionedTopicOpts) (*http.Response, error)

func (*PersistentTopicApiService) CreatePartitionedTopic 

func (a *PersistentTopicApiService) CreatePartitionedTopic(ctx context.Context, tenant string, namespace string, topic string, body int32) (*http.Response, error)

PersistentTopicApiService Create a partitioned topic. It needs to be called before creating a producer on a partitioned topic.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant Specify the tenant
  • @param namespace Specify the namespace
  • @param topic Specify topic name
  • @param body The number of partitions for the topic

func (*PersistentTopicApiService) CreateSubscription 

func (a *PersistentTopicApiService) CreateSubscription(ctx context.Context, tenant string, namespace string, topic string, subscriptionName string, localVarOptionals *CreateSubscriptionOpts) (*http.Response, error)

func (*PersistentTopicApiService) DeletePartitionedTopic 

func (a *PersistentTopicApiService) DeletePartitionedTopic(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *DeletePartitionedTopicOpts) (*http.Response, error)

func (*PersistentTopicApiService) DeleteSubscription 

func (a *PersistentTopicApiService) DeleteSubscription(ctx context.Context, tenant string, namespace string, topic string, subName string, localVarOptionals *DeleteSubscriptionOpts) (*http.Response, error)

func (*PersistentTopicApiService) DeleteTopic 

func (a *PersistentTopicApiService) DeleteTopic(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *DeleteTopicOpts) (*http.Response, error)

func (*PersistentTopicApiService) ExpireMessagesForAllSubscriptions 

func (a *PersistentTopicApiService) ExpireMessagesForAllSubscriptions(ctx context.Context, tenant string, namespace string, topic string, expireTimeInSeconds int32, localVarOptionals *ExpireMessagesForAllSubscriptionsOpts) (*http.Response, error)

func (*PersistentTopicApiService) ExpireTopicMessages 

func (a *PersistentTopicApiService) ExpireTopicMessages(ctx context.Context, tenant string, namespace string, topic string, subName string, expireTimeInSeconds int32, localVarOptionals *ExpireTopicMessagesOpts) (*http.Response, error)

func (*PersistentTopicApiService) GetBacklog 

func (a *PersistentTopicApiService) GetBacklog(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *GetBacklogOpts) (PersistentOfflineTopicStats, *http.Response, error)

func (*PersistentTopicApiService) GetInternalStats 

func (a *PersistentTopicApiService) GetInternalStats(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *GetInternalStatsOpts) (PersistentTopicInternalStats, *http.Response, error)

func (*PersistentTopicApiService) GetLastMessageId 

func (a *PersistentTopicApiService) GetLastMessageId(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *GetLastMessageIdOpts) (map[string]interface{}, *http.Response, error)

func (*PersistentTopicApiService) GetList 

func (a *PersistentTopicApiService) GetList(ctx context.Context, tenant string, namespace string) ([]string, *http.Response, error)

PersistentTopicApiService Get the list of topics under a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant Specify the tenant
  • @param namespace Specify the namespace

@return []string

func (*PersistentTopicApiService) GetManagedLedgerInfo 

func (a *PersistentTopicApiService) GetManagedLedgerInfo(ctx context.Context, tenant string, namespace string, topic string) (*http.Response, error)

PersistentTopicApiService Get the internal stats for the topic.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant Specify the tenant
  • @param namespace Specify the namespace
  • @param topic Specify topic name

func (*PersistentTopicApiService) GetPartitionedMetadata 

func (a *PersistentTopicApiService) GetPartitionedMetadata(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *GetPartitionedMetadataOpts) (PartitionedTopicMetadata, *http.Response, error)

func (*PersistentTopicApiService) GetPartitionedStats 

func (a *PersistentTopicApiService) GetPartitionedStats(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *GetPartitionedStatsOpts) (*http.Response, error)

func (*PersistentTopicApiService) GetPartitionedTopicList 

func (a *PersistentTopicApiService) GetPartitionedTopicList(ctx context.Context, tenant string, namespace string) ([]string, *http.Response, error)

PersistentTopicApiService Get the list of partitioned topics under a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant Specify the tenant
  • @param namespace Specify the namespace

@return []string

func (*PersistentTopicApiService) GetPermissionsOnTopic 

func (a *PersistentTopicApiService) GetPermissionsOnTopic(ctx context.Context, tenant string, namespace string, topic string) (map[string]map[string]interface{}, *http.Response, error)

PersistentTopicApiService Get permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at thenamespace level combined (union) with any eventual specific permission set on the topic.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant Specify the tenant
  • @param namespace Specify the namespace
  • @param topic Specify topic name

@return map[string]map[string]interface{}

func (*PersistentTopicApiService) GetStats 

func (a *PersistentTopicApiService) GetStats(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *GetStatsOpts) (TopicStats, *http.Response, error)

func (*PersistentTopicApiService) GetSubscriptions 

func (a *PersistentTopicApiService) GetSubscriptions(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *GetSubscriptionsOpts) ([]map[string]interface{}, *http.Response, error)

func (*PersistentTopicApiService) GrantPermissionsOnTopic 

func (a *PersistentTopicApiService) GrantPermissionsOnTopic(ctx context.Context, tenant string, namespace string, topic string, role string, localVarOptionals *GrantPermissionsOnTopicOpts) (*http.Response, error)

func (*PersistentTopicApiService) OffloadStatus 

func (a *PersistentTopicApiService) OffloadStatus(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *OffloadStatusOpts) (OffloadProcessStatus, *http.Response, error)

func (*PersistentTopicApiService) PeekNthMessage 

func (a *PersistentTopicApiService) PeekNthMessage(ctx context.Context, tenant string, namespace string, topic string, subName string, messagePosition int32, localVarOptionals *PeekNthMessageOpts) (*http.Response, error)

func (*PersistentTopicApiService) ResetCursor 

func (a *PersistentTopicApiService) ResetCursor(ctx context.Context, tenant string, namespace string, topic string, subName string, timestamp int64, localVarOptionals *ResetCursorOpts) (*http.Response, error)

func (*PersistentTopicApiService) ResetCursorOnPosition 

func (a *PersistentTopicApiService) ResetCursorOnPosition(ctx context.Context, tenant string, namespace string, topic string, subName string, localVarOptionals *ResetCursorOnPositionOpts) (*http.Response, error)

func (*PersistentTopicApiService) RevokePermissionsOnTopic 

func (a *PersistentTopicApiService) RevokePermissionsOnTopic(ctx context.Context, tenant string, namespace string, topic string, role string) (*http.Response, error)

PersistentTopicApiService Revoke permissions on a topic. Revoke permissions to a role on a single topic. If the permission was not set at the topiclevel, but rather at the namespace level, this operation will return an error (HTTP status code 412).

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant Specify the tenant
  • @param namespace Specify the namespace
  • @param topic Specify topic name
  • @param role Client role to which grant permissions

func (*PersistentTopicApiService) SkipAllMessages 

func (a *PersistentTopicApiService) SkipAllMessages(ctx context.Context, tenant string, namespace string, topic string, subName string, localVarOptionals *SkipAllMessagesOpts) (*http.Response, error)

func (*PersistentTopicApiService) SkipMessages 

func (a *PersistentTopicApiService) SkipMessages(ctx context.Context, tenant string, namespace string, topic string, subName string, numMessages int32, localVarOptionals *SkipMessagesOpts) (*http.Response, error)

func (*PersistentTopicApiService) Terminate 

func (a *PersistentTopicApiService) Terminate(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *TerminateOpts) (map[string]interface{}, *http.Response, error)

func (*PersistentTopicApiService) TriggerOffload 

func (a *PersistentTopicApiService) TriggerOffload(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *TriggerOffloadOpts) (*http.Response, error)

func (*PersistentTopicApiService) UnloadTopic 

func (a *PersistentTopicApiService) UnloadTopic(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *UnloadTopicOpts) (*http.Response, error)

func (*PersistentTopicApiService) UpdatePartitionedTopic 

func (a *PersistentTopicApiService) UpdatePartitionedTopic(ctx context.Context, tenant string, namespace string, topic string, body int32) (*http.Response, error)

PersistentTopicApiService Increment partitons of an existing partitioned topic. It only increments partitions of existing non-global partitioned-topic

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant Specify the tenant
  • @param namespace Specify the namespace
  • @param topic Specify topic name
  • @param body The number of partitions for the topic

type PersistentTopicInternalStats 

type PersistentTopicInternalStats struct {
	EntriesAddedCounter                int64                  `json:"entriesAddedCounter,omitempty"`
	NumberOfEntries                    int64                  `json:"numberOfEntries,omitempty"`
	TotalSize                          int64                  `json:"totalSize,omitempty"`
	CurrentLedgerEntries               int64                  `json:"currentLedgerEntries,omitempty"`
	CurrentLedgerSize                  int64                  `json:"currentLedgerSize,omitempty"`
	LastLedgerCreatedTimestamp         string                 `json:"lastLedgerCreatedTimestamp,omitempty"`
	LastLedgerCreationFailureTimestamp string                 `json:"lastLedgerCreationFailureTimestamp,omitempty"`
	WaitingCursorsCount                int32                  `json:"waitingCursorsCount,omitempty"`
	PendingAddEntriesCount             int32                  `json:"pendingAddEntriesCount,omitempty"`
	LastConfirmedEntry                 string                 `json:"lastConfirmedEntry,omitempty"`
	State                              string                 `json:"state,omitempty"`
	Ledgers                            []LedgerInfo           `json:"ledgers,omitempty"`
	Cursors                            map[string]CursorStats `json:"cursors,omitempty"`
}

type Policies 

type Policies struct {
	AuthPolicies                          AuthPolicies             `json:"auth_policies,omitempty"`
	ReplicationClusters                   []string                 `json:"replication_clusters,omitempty"`
	Bundles                               BundlesData              `json:"bundles,omitempty"`
	BacklogQuotaMap                       map[string]BacklogQuota  `json:"backlog_quota_map,omitempty"`
	TopicDispatchRate                     map[string]DispatchRate  `json:"topicDispatchRate,omitempty"`
	SubscriptionDispatchRate              map[string]DispatchRate  `json:"subscriptionDispatchRate,omitempty"`
	ReplicatorDispatchRate                map[string]DispatchRate  `json:"replicatorDispatchRate,omitempty"`
	ClusterSubscribeRate                  map[string]SubscribeRate `json:"clusterSubscribeRate,omitempty"`
	Persistence                           PersistencePolicies      `json:"persistence,omitempty"`
	DeduplicationEnabled                  bool                     `json:"deduplicationEnabled,omitempty"`
	LatencyStatsSampleRate                map[string]int32         `json:"latency_stats_sample_rate,omitempty"`
	MessageTtlInSeconds                   int32                    `json:"message_ttl_in_seconds,omitempty"`
	RetentionPolicies                     RetentionPolicies        `json:"retention_policies,omitempty"`
	Deleted                               bool                     `json:"deleted,omitempty"`
	AntiAffinityGroup                     string                   `json:"antiAffinityGroup,omitempty"`
	EncryptionRequired                    bool                     `json:"encryption_required,omitempty"`
	SubscriptionAuthMode                  string                   `json:"subscription_auth_mode,omitempty"`
	MaxProducersPerTopic                  int32                    `json:"max_producers_per_topic,omitempty"`
	MaxConsumersPerTopic                  int32                    `json:"max_consumers_per_topic,omitempty"`
	MaxConsumersPerSubscription           int32                    `json:"max_consumers_per_subscription,omitempty"`
	CompactionThreshold                   int64                    `json:"compaction_threshold,omitempty"`
	OffloadThreshold                      int64                    `json:"offload_threshold,omitempty"`
	OffloadDeletionLagMs                  int64                    `json:"offload_deletion_lag_ms,omitempty"`
	SchemaAutoUpdateCompatibilityStrategy string                   `json:"schema_auto_update_compatibility_strategy,omitempty"`
	SchemaValidationEnforced              bool                     `json:"schema_validation_enforced,omitempty"`
}

type PoolArenaStats 

type PoolArenaStats struct {
	NumTinySubpages            int32                `json:"numTinySubpages,omitempty"`
	NumSmallSubpages           int32                `json:"numSmallSubpages,omitempty"`
	NumChunkLists              int32                `json:"numChunkLists,omitempty"`
	TinySubpages               []PoolSubpageStats   `json:"tinySubpages,omitempty"`
	SmallSubpages              []PoolSubpageStats   `json:"smallSubpages,omitempty"`
	ChunkLists                 []PoolChunkListStats `json:"chunkLists,omitempty"`
	NumAllocations             int64                `json:"numAllocations,omitempty"`
	NumTinyAllocations         int64                `json:"numTinyAllocations,omitempty"`
	NumSmallAllocations        int64                `json:"numSmallAllocations,omitempty"`
	NumNormalAllocations       int64                `json:"numNormalAllocations,omitempty"`
	NumHugeAllocations         int64                `json:"numHugeAllocations,omitempty"`
	NumDeallocations           int64                `json:"numDeallocations,omitempty"`
	NumTinyDeallocations       int64                `json:"numTinyDeallocations,omitempty"`
	NumSmallDeallocations      int64                `json:"numSmallDeallocations,omitempty"`
	NumNormalDeallocations     int64                `json:"numNormalDeallocations,omitempty"`
	NumHugeDeallocations       int64                `json:"numHugeDeallocations,omitempty"`
	NumActiveAllocations       int64                `json:"numActiveAllocations,omitempty"`
	NumActiveTinyAllocations   int64                `json:"numActiveTinyAllocations,omitempty"`
	NumActiveSmallAllocations  int64                `json:"numActiveSmallAllocations,omitempty"`
	NumActiveNormalAllocations int64                `json:"numActiveNormalAllocations,omitempty"`
	NumActiveHugeAllocations   int64                `json:"numActiveHugeAllocations,omitempty"`
}

type PoolChunkListStats 

type PoolChunkListStats struct {
	MinUsage int32            `json:"minUsage,omitempty"`
	MaxUsage int32            `json:"maxUsage,omitempty"`
	Chunks   []PoolChunkStats `json:"chunks,omitempty"`
}

type PoolChunkStats 

type PoolChunkStats struct {
	Usage     int32 `json:"usage,omitempty"`
	ChunkSize int32 `json:"chunkSize,omitempty"`
	FreeBytes int32 `json:"freeBytes,omitempty"`
}

type PoolSubpageStats 

type PoolSubpageStats struct {
	MaxNumElements int32 `json:"maxNumElements,omitempty"`
	NumAvailable   int32 `json:"numAvailable,omitempty"`
	ElementSize    int32 `json:"elementSize,omitempty"`
	PageSize       int32 `json:"pageSize,omitempty"`
}

type PostSchemaOpts 

type PostSchemaOpts struct {
	Authoritative optional.Bool
	Body          optional.Interface
}

type PostSchemaPayload 

type PostSchemaPayload struct {
	Type       string            `json:"type,omitempty"`
	Schema     string            `json:"schema,omitempty"`
	Properties map[string]string `json:"properties,omitempty"`
}

type PostSchemaResponse 

type PostSchemaResponse struct {
	Version map[string]interface{} `json:"version,omitempty"`
}

type PublisherStats 

type PublisherStats struct {
	MsgRateIn       float64           `json:"msgRateIn,omitempty"`
	MsgThroughputIn float64           `json:"msgThroughputIn,omitempty"`
	AverageMsgSize  float64           `json:"averageMsgSize,omitempty"`
	ProducerId      int64             `json:"producerId,omitempty"`
	Metadata        map[string]string `json:"metadata,omitempty"`
	ConnectedSince  string            `json:"connectedSince,omitempty"`
	ClientVersion   string            `json:"clientVersion,omitempty"`
	ProducerName    string            `json:"producerName,omitempty"`
	Address         string            `json:"address,omitempty"`
}

type RemoveBacklogQuotaOpts 

type RemoveBacklogQuotaOpts struct {
	BacklogQuotaType optional.String
}

type ReplicatorStats 

type ReplicatorStats struct {
	MsgRateIn                 float64 `json:"msgRateIn,omitempty"`
	MsgThroughputIn           float64 `json:"msgThroughputIn,omitempty"`
	MsgRateOut                float64 `json:"msgRateOut,omitempty"`
	MsgThroughputOut          float64 `json:"msgThroughputOut,omitempty"`
	MsgRateExpired            float64 `json:"msgRateExpired,omitempty"`
	ReplicationBacklog        int64   `json:"replicationBacklog,omitempty"`
	Connected                 bool    `json:"connected,omitempty"`
	ReplicationDelayInSeconds int64   `json:"replicationDelayInSeconds,omitempty"`
	InboundConnection         string  `json:"inboundConnection,omitempty"`
	InboundConnectedSince     string  `json:"inboundConnectedSince,omitempty"`
	OutboundConnection        string  `json:"outboundConnection,omitempty"`
	OutboundConnectedSince    string  `json:"outboundConnectedSince,omitempty"`
}

type ResetCursorOnPositionOpts 

type ResetCursorOnPositionOpts struct {
	Authoritative optional.Bool
	MessageId     optional.Interface
}

type ResetCursorOpts 

type ResetCursorOpts struct {
	Authoritative optional.Bool
}

type ResourceDescription 

type ResourceDescription struct {
	UsagePct      int32                    `json:"usagePct,omitempty"`
	ResourceUsage map[string]ResourceUsage `json:"resourceUsage,omitempty"`
}

type ResourceQuota 

type ResourceQuota struct {
	MsgRateIn    float64 `json:"msgRateIn,omitempty"`
	MsgRateOut   float64 `json:"msgRateOut,omitempty"`
	BandwidthIn  float64 `json:"bandwidthIn,omitempty"`
	BandwidthOut float64 `json:"bandwidthOut,omitempty"`
	Memory       float64 `json:"memory,omitempty"`
	Dynamic      bool    `json:"dynamic,omitempty"`
}

type ResourceQuotasApiService 

type ResourceQuotasApiService service

func (*ResourceQuotasApiService) GetDefaultResourceQuota 

func (a *ResourceQuotasApiService) GetDefaultResourceQuota(ctx context.Context) ([]string, *http.Response, error)

ResourceQuotasApiService Get the default quota

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []string

func (*ResourceQuotasApiService) GetNamespaceBundleResourceQuota 

func (a *ResourceQuotasApiService) GetNamespaceBundleResourceQuota(ctx context.Context, tenant string, namespace string, bundle string) (ResourceQuota, *http.Response, error)

ResourceQuotasApiService Get resource quota of a namespace bundle.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace
  • @param bundle

@return ResourceQuota

func (*ResourceQuotasApiService) RemoveNamespaceBundleResourceQuota 

func (a *ResourceQuotasApiService) RemoveNamespaceBundleResourceQuota(ctx context.Context, tenant string, namespace string, bundle string) (*http.Response, error)

ResourceQuotasApiService Remove resource quota for a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace
  • @param bundle

func (*ResourceQuotasApiService) SetDefaultResourceQuota 

func (a *ResourceQuotasApiService) SetDefaultResourceQuota(ctx context.Context) ([]string, *http.Response, error)

ResourceQuotasApiService Set the default quota

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []string

func (*ResourceQuotasApiService) SetNamespaceBundleResourceQuota 

func (a *ResourceQuotasApiService) SetNamespaceBundleResourceQuota(ctx context.Context, tenant string, namespace string, bundle string) (*http.Response, error)

ResourceQuotasApiService Set resource quota on a namespace.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant
  • @param namespace
  • @param bundle

type ResourceUnit 

type ResourceUnit struct {
	AvailableResource ResourceDescription `json:"availableResource,omitempty"`
	ResourceId        string              `json:"resourceId,omitempty"`
}

type ResourceUsage 

type ResourceUsage struct {
	Usage float64 `json:"usage,omitempty"`
	Limit float64 `json:"limit,omitempty"`
}

type RetentionPolicies 

type RetentionPolicies struct {
	RetentionTimeInMinutes int32 `json:"retentionTimeInMinutes,omitempty"`
	RetentionSizeInMB      int64 `json:"retentionSizeInMB,omitempty"`
}

type SchemasApiService 

type SchemasApiService service

func (*SchemasApiService) DeleteSchema 

func (a *SchemasApiService) DeleteSchema(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *DeleteSchemaOpts) (DeleteSchemaResponse, *http.Response, error)

func (*SchemasApiService) GetSchema 

func (a *SchemasApiService) GetSchema(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *GetSchemaOpts) (GetSchemaResponse, *http.Response, error)

func (*SchemasApiService) GetSchema_1 

func (a *SchemasApiService) GetSchema_1(ctx context.Context, tenant string, namespace string, topic string, version string, localVarOptionals *GetSchema_1Opts) (GetSchemaResponse, *http.Response, error)

func (*SchemasApiService) PostSchema 

func (a *SchemasApiService) PostSchema(ctx context.Context, tenant string, namespace string, topic string, localVarOptionals *PostSchemaOpts) (PostSchemaResponse, *http.Response, error)

type SetBacklogQuotaOpts 

type SetBacklogQuotaOpts struct {
	BacklogQuotaType optional.String
}

type SkipAllMessagesOpts 

type SkipAllMessagesOpts struct {
	Authoritative optional.Bool
}

type SkipMessagesOpts 

type SkipMessagesOpts struct {
	Authoritative optional.Bool
}

type SplitNamespaceBundleOpts 

type SplitNamespaceBundleOpts struct {
	Authoritative optional.Bool
	Unload        optional.Bool
}

type SubscribeRate 

type SubscribeRate struct {
	SubscribeThrottlingRatePerConsumer int32 `json:"subscribeThrottlingRatePerConsumer,omitempty"`
	RatePeriodInSecond                 int32 `json:"ratePeriodInSecond,omitempty"`
}

type SubscriptionStats 

type SubscriptionStats struct {
	MsgRateOut                       float64         `json:"msgRateOut,omitempty"`
	MsgThroughputOut                 float64         `json:"msgThroughputOut,omitempty"`
	MsgRateRedeliver                 float64         `json:"msgRateRedeliver,omitempty"`
	MsgBacklog                       int64           `json:"msgBacklog,omitempty"`
	BlockedSubscriptionOnUnackedMsgs bool            `json:"blockedSubscriptionOnUnackedMsgs,omitempty"`
	MsgDelayed                       int64           `json:"msgDelayed,omitempty"`
	UnackedMessages                  int64           `json:"unackedMessages,omitempty"`
	Type                             string          `json:"type,omitempty"`
	ActiveConsumerName               string          `json:"activeConsumerName,omitempty"`
	MsgRateExpired                   float64         `json:"msgRateExpired,omitempty"`
	Consumers                        []ConsumerStats `json:"consumers,omitempty"`
	IsReplicated                     bool            `json:"isReplicated,omitempty"`
}

type SystemResourceUsage 

type SystemResourceUsage struct {
	BandwidthIn  ResourceUsage `json:"bandwidthIn,omitempty"`
	BandwidthOut ResourceUsage `json:"bandwidthOut,omitempty"`
	Cpu          ResourceUsage `json:"cpu,omitempty"`
	Memory       ResourceUsage `json:"memory,omitempty"`
	DirectMemory ResourceUsage `json:"directMemory,omitempty"`
}

type TenantInfo 

type TenantInfo struct {
	// Comma separated list of auth principal allowed to administrate the tenant.
	AdminRoles []string `json:"adminRoles,omitempty"`
	// Comma separated allowed clusters.
	AllowedClusters []string `json:"allowedClusters,omitempty"`
}

Information of adminRoles and allowedClusters for tenant

type TenantsApiService 

type TenantsApiService service

func (*TenantsApiService) CreateTenant 

func (a *TenantsApiService) CreateTenant(ctx context.Context, tenant string, localVarOptionals *CreateTenantOpts) (*http.Response, error)

func (*TenantsApiService) DeleteTenant 

func (a *TenantsApiService) DeleteTenant(ctx context.Context, tenant string) (*http.Response, error)

TenantsApiService Delete a tenant and all namespaces and topics under it.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant The tenant name

func (*TenantsApiService) GetTenantAdmin 

func (a *TenantsApiService) GetTenantAdmin(ctx context.Context, tenant string) (TenantInfo, *http.Response, error)

TenantsApiService Get the admin configuration for a given tenant.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tenant The tenant name

@return TenantInfo

func (*TenantsApiService) GetTenants 

func (a *TenantsApiService) GetTenants(ctx context.Context) ([]string, *http.Response, error)

TenantsApiService Get the list of existing tenants.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []string

func (*TenantsApiService) UpdateTenant 

func (a *TenantsApiService) UpdateTenant(ctx context.Context, tenant string, localVarOptionals *UpdateTenantOpts) (*http.Response, error)

type TerminateOpts 

type TerminateOpts struct {
	Authoritative optional.Bool
}

type TopicStats 

type TopicStats struct {
	MsgRateIn           float64                      `json:"msgRateIn,omitempty"`
	MsgThroughputIn     float64                      `json:"msgThroughputIn,omitempty"`
	MsgRateOut          float64                      `json:"msgRateOut,omitempty"`
	MsgThroughputOut    float64                      `json:"msgThroughputOut,omitempty"`
	AverageMsgSize      float64                      `json:"averageMsgSize,omitempty"`
	StorageSize         int64                        `json:"storageSize,omitempty"`
	Publishers          []PublisherStats             `json:"publishers,omitempty"`
	Subscriptions       map[string]SubscriptionStats `json:"subscriptions,omitempty"`
	Replication         map[string]ReplicatorStats   `json:"replication,omitempty"`
	DeduplicationStatus string                       `json:"deduplicationStatus,omitempty"`
}

type TriggerOffloadOpts 

type TriggerOffloadOpts struct {
	Authoritative optional.Bool
}

type UnloadNamespaceBundleOpts 

type UnloadNamespaceBundleOpts struct {
	Authoritative optional.Bool
}

type UnloadTopicOpts 

type UnloadTopicOpts struct {
	Authoritative optional.Bool
}

type UnsubscribeNamespaceBundleOpts 

type UnsubscribeNamespaceBundleOpts struct {
	Authoritative optional.Bool
}

type UnsubscribeNamespaceOpts 

type UnsubscribeNamespaceOpts struct {
	Authoritative optional.Bool
}

type UpdateBookieRackInfoOpts 

type UpdateBookieRackInfoOpts struct {
	Group optional.String
}

type UpdateTenantOpts 

type UpdateTenantOpts struct {
	Body optional.Interface
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.