Go API client for openapi

APIs for accessing Pinot Controller information

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: 1.0
• 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/net/context

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

import openapi "github.com/davidgs/golang-api-client"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AppConfigsApi	GetAppConfigs	Get /appconfigs
AtomicIngestionApi	EndDataIngestRequest	Post /segments/{tableName}/endDataIngestRequest	Mark the end of data ingestion to upload multiple segments
AtomicIngestionApi	StartDataIngestRequest	Post /segments/{tableName}/startDataIngestRequest	Mark the start of data ingestion to upload multiple segments
AuthApi	Info	Get /auth/info	Retrieve auth workflow info
AuthApi	Verify	Get /auth/verify	Check whether authentication is enabled
BrokerApi	GetBrokersForTable	Get /brokers/tables/{tableName}	List brokers for a given table
BrokerApi	GetBrokersForTableV2	Get /v2/brokers/tables/{tableName}	List brokers for a given table
BrokerApi	GetBrokersForTenant	Get /brokers/tenants/{tenantName}	List brokers for a given tenant
BrokerApi	GetBrokersForTenantV2	Get /v2/brokers/tenants/{tenantName}	List brokers for a given tenant
BrokerApi	GetTablesToBrokersMapping	Get /brokers/tables	List tables to brokers mappings
BrokerApi	GetTablesToBrokersMappingV2	Get /v2/brokers/tables	List tables to brokers mappings
BrokerApi	GetTenantsToBrokersMapping	Get /brokers/tenants	List tenants to brokers mappings
BrokerApi	GetTenantsToBrokersMappingV2	Get /v2/brokers/tenants	List tenants to brokers mappings
BrokerApi	ListBrokersMapping	Get /brokers	List tenants and tables to brokers mappings
BrokerApi	ListBrokersMappingV2	Get /v2/brokers	List tenants and tables to brokers mappings
BrokerApi	ToggleQueryRateLimiting	Post /brokers/instances/{instanceName}/qps	Enable/disable the query rate limiting for a broker instance
ClusterApi	DeleteClusterConfig	Delete /cluster/configs/{configName}	Delete cluster configuration
ClusterApi	GetClusterInfo	Get /cluster/info	Get cluster Info
ClusterApi	GetSegmentDebugInfo	Get /debug/segments/{tableName}/{segmentName}	Get debug information for segment.
ClusterApi	GetTableDebugInfo	Get /debug/tables/{tableName}	Get debug information for table.
ClusterApi	ListClusterConfigs	Get /cluster/configs	List cluster configurations
ClusterApi	UpdateClusterConfig	Post /cluster/configs	Update cluster configuration
ClusterHealthApi	GetClusterHealthDetails	Get /clusterHealth	Get cached cluster health details
HealthApi	CheckHealth	Get /health	Check controller health
HealthApi	CheckHealthLegacy	Get /pinot-controller/admin	Check controller health
InstanceApi	AddInstance	Post /instances	Create a new instance
InstanceApi	DropInstance	Delete /instances/{instanceName}	Drop an instance
InstanceApi	GetAllInstances	Get /instances	List all instances
InstanceApi	GetInstance	Get /instances/{instanceName}	Get instance information
InstanceApi	ToggleInstanceState	Post /instances/{instanceName}/state	Enable/disable/drop an instance
InstanceApi	UpdateBrokerResource	Post /instances/{instanceName}/updateBrokerResource	Update the tables served by the specified broker instance in the broker resource
InstanceApi	UpdateInstance	Put /instances/{instanceName}	Update the specified instance
InstanceApi	UpdateInstanceTags	Put /instances/{instanceName}/updateTags	Update the tags of the specified instance
LeaderApi	GetLeaderForTable	Get /leader/tables/{tableName}	Gets leader for a given table
LeaderApi	GetLeadersForAllTables	Get /leader/tables	Gets leaders for all tables
LoggerApi	DownloadLogFile	Get /loggers/download	Download a log file
LoggerApi	DownloadLogFileFromInstance	Get /loggers/instances/{instanceName}/download	Download a log file from a given instance
LoggerApi	GetLocalLogFiles	Get /loggers/files	Get all local log files
LoggerApi	GetLogFilesFromAllInstances	Get /loggers/instances	Collect log files from all the instances
LoggerApi	GetLogFilesFromInstance	Get /loggers/instances/{instanceName}	Collect log files from a given instance
LoggerApi	GetLogger	Get /loggers/{loggerName}	Get logger configs
LoggerApi	GetLoggers	Get /loggers	Get all the loggers
LoggerApi	SetLoggerLevel	Put /loggers/{loggerName}	Set logger level
PeriodicTaskApi	GetPeriodicTaskNames	Get /periodictask/names	Get comma-delimited list of all available periodic task names.
PeriodicTaskApi	RunPeriodicTask	Get /periodictask/run	Run periodic task against table. If table name is missing, task will run against all tables.
QueryApi	CancelQuery	Delete /query/{brokerId}/{queryId}	Cancel a query as identified by the queryId
QueryApi	GetRunningQueries	Get /queries	Get running queries from all brokers
SchemaApi	AddSchema1	Post /schemas	Add a new schema
SchemaApi	DeleteSchema	Delete /schemas/{schemaName}	Delete a schema
SchemaApi	GetSchema	Get /schemas/{schemaName}	Get a schema
SchemaApi	GetTableSchema	Get /tables/{tableName}/schema	Get table schema
SchemaApi	ListSchemaNames	Get /schemas	List all schema names
SchemaApi	UpdateSchema1	Put /schemas/{schemaName}	Update a schema
SchemaApi	ValidateSchema1	Post /schemas/validate	Validate schema
SegmentApi	DeleteAllSegments	Delete /segments/{tableName}	Delete all segments
SegmentApi	DeleteSegment	Delete /segments/{tableName}/{segmentName}	Delete a segment
SegmentApi	DeleteSegments	Post /segments/{tableName}/delete	Delete the segments in the JSON array payload
SegmentApi	DownloadSegment	Get /segments/{tableName}/{segmentName}	Download a segment
SegmentApi	EndReplaceSegments	Post /segments/{tableName}/endReplaceSegments	End to replace segments
SegmentApi	GetReloadJobStatus	Get /segments/segmentReloadStatus/{jobId}	Get status for a submitted reload operation
SegmentApi	GetSegmentMetadata	Get /segments/{tableName}/{segmentName}/metadata	Get the metadata for a segment
SegmentApi	GetSegmentMetadataDeprecated1	Get /tables/{tableName}/segments/{segmentName}/metadata	Get the metadata for a segment (deprecated, use 'GET /segments/{tableName}/{segmentName}/metadata' instead)
SegmentApi	GetSegmentMetadataDeprecated2	Get /tables/{tableName}/segments/{segmentName}	Get the metadata for a segment (deprecated, use 'GET /segments/{tableName}/{segmentName}/metadata' instead)
SegmentApi	GetSegmentTiers	Get /segments/{tableName}/{segmentName}/tiers	Get storage tiers for the given segment
SegmentApi	GetSegmentToCrcMap	Get /segments/{tableName}/crc	Get a map from segment to CRC of the segment (only apply to OFFLINE table)
SegmentApi	GetSegmentToCrcMapDeprecated	Get /tables/{tableName}/segments/crc	Get a map from segment to CRC of the segment (deprecated, use 'GET /segments/{tableName}/crc' instead)
SegmentApi	GetSegments	Get /segments/{tableName}	List all segments. An optional 'excludeReplacedSegments' parameter is used to get the list of segments which has not yet been replaced (determined by segment lineage entries) and can be queried from the table. The value is false by default.
SegmentApi	GetSelectedSegments	Get /segments/{tableName}/select	Get the selected segments given the (inclusive) start and (exclusive) end timestamps in milliseconds. These timestamps will be compared against the minmax values of the time column in each segment. If the table is a refresh use case, the value of start and end timestamp is voided, since there is no time column for refresh use case; instead, the whole qualified segments will be returned. If no timestamps are provided, all the qualified segments will be returned. For the segments that partially belong to the time range, the boolean flag 'excludeOverlapping' is introduced in order for user to determine whether to exclude this kind of segments in the response.
SegmentApi	GetServerMetadata	Get /segments/{tableName}/metadata	Get the server metadata for all table segments
SegmentApi	GetServerToSegmentsMap	Get /segments/{tableName}/servers	Get a map from server to segments hosted by the server
SegmentApi	GetServerToSegmentsMapDeprecated1	Get /tables/{tableName}/segments	Get a map from server to segments hosted by the server (deprecated, use 'GET /segments/{tableName}/servers' instead)
SegmentApi	GetServerToSegmentsMapDeprecated2	Get /tables/{tableName}/segments/metadata	Get a map from server to segments hosted by the server (deprecated, use 'GET /segments/{tableName}/servers' instead)
SegmentApi	GetTableTiers	Get /segments/{tableName}/tiers	Get storage tier for all segments in the given table
SegmentApi	GetZookeeperMetadata	Get /segments/{tableName}/zkmetadata	Get the zookeeper metadata for all table segments
SegmentApi	ListSegmentLineage	Get /segments/{tableName}/lineage	List segment lineage
SegmentApi	ReloadAllSegments	Post /segments/{tableName}/reload	Reload all segments
SegmentApi	ReloadAllSegmentsDeprecated1	Post /tables/{tableName}/segments/reload	Reload all segments (deprecated, use 'POST /segments/{tableName}/reload' instead)
SegmentApi	ReloadAllSegmentsDeprecated2	Get /tables/{tableName}/segments/reload	Reload all segments (deprecated, use 'POST /segments/{tableName}/reload' instead)
SegmentApi	ReloadSegment	Post /segments/{tableName}/{segmentName}/reload	Reload a segment
SegmentApi	ReloadSegmentDeprecated1	Post /tables/{tableName}/segments/{segmentName}/reload	Reload a segment (deprecated, use 'POST /segments/{tableName}/{segmentName}/reload' instead)
SegmentApi	ReloadSegmentDeprecated2	Get /tables/{tableName}/segments/{segmentName}/reload	Reload a segment (deprecated, use 'POST /segments/{tableName}/{segmentName}/reload' instead)
SegmentApi	ResetSegment	Post /segments/{tableNameWithType}/{segmentName}/reset	Resets a segment by first disabling it, waiting for external view to stabilize, and finally enabling it again
SegmentApi	ResetSegments	Post /segments/{tableNameWithType}/reset	Resets all segments (when errorSegmentsOnly = false) or segments with Error state (when errorSegmentsOnly = true) of the table, by first disabling them, waiting for external view to stabilize, and finally enabling them
SegmentApi	RevertReplaceSegments	Post /segments/{tableName}/revertReplaceSegments	Revert segments replacement
SegmentApi	StartReplaceSegments	Post /segments/{tableName}/startReplaceSegments	Start to replace segments
SegmentApi	UpdateTimeIntervalZK	Post /segments/{tableNameWithType}/updateZKTimeInterval	Update the start and end time of the segments based on latest schema
SegmentApi	UploadSegmentAsMultiPart	Post /segments	Upload a segment
SegmentApi	UploadSegmentAsMultiPartV2	Post /v2/segments	Upload a segment
TableApi	AddConfig	Post /tableConfigs	Add the TableConfigs using the tableConfigsStr json
TableApi	AddTable	Post /tables	Adds a table
TableApi	AlterTableStateOrListTableConfig	Get /tables/{tableName}	Get/Enable/Disable/Drop a table
TableApi	AssignInstances	Post /tables/{tableName}/assignInstances	Assign server instances to a table
TableApi	CheckTableConfig	Post /tables/validate	Validate table config for a table
TableApi	DeleteConfig	Delete /tableConfigs/{tableName}	Delete the TableConfigs
TableApi	DeleteTable	Delete /tables/{tableName}	Deletes a table
TableApi	DeleteTimeBoundary	Delete /tables/{tableName}/timeBoundary	Delete hybrid table query time boundary
TableApi	ForceCommit	Post /tables/{tableName}/forceCommit	Force commit the current consuming segments
TableApi	GetConfig	Get /tableConfigs/{tableName}	Get the TableConfigs for a given raw tableName
TableApi	GetConsumingSegmentsInfo	Get /tables/{tableName}/consumingSegmentsInfo	Returns state of consuming segments
TableApi	GetControllerJobs	Get /table/{tableName}/jobs	Get list of controller jobs for this table
TableApi	GetExternalView	Get /tables/{tableName}/externalview	Get table external view
TableApi	GetForceCommitJobStatus	Get /tables/forceCommitStatus/{jobId}	Get status for a submitted force commit operation
TableApi	GetIdealState	Get /tables/{tableName}/idealstate	Get table ideal state
TableApi	GetInstancePartitions	Get /tables/{tableName}/instancePartitions	Get the instance partitions
TableApi	GetLiveBrokers	Get /tables/livebrokers	List tables to live brokers mappings
TableApi	GetLiveBrokersForTable	Get /tables/{tableName}/livebrokers	List the brokers serving a table
TableApi	GetPauseStatus	Get /tables/{tableName}/pauseStatus	Return pause status of a realtime table
TableApi	GetTableAggregateMetadata	Get /tables/{tableName}/metadata	Get the aggregate metadata of all segments for a table
TableApi	GetTableInstances	Get /tables/{tableName}/instances	List table instances
TableApi	GetTableSize	Get /tables/{tableName}/size	Read table sizes
TableApi	GetTableState	Get /tables/{tableName}/state	Get current table state
TableApi	GetTableStats	Get /tables/{tableName}/stats	table stats
TableApi	GetTableStatus	Get /tables/{tableName}/status	table status
TableApi	IngestFromFile	Post /ingestFromFile	Ingest a file
TableApi	IngestFromURI	Post /ingestFromURI	Ingest from the given URI
TableApi	ListConfigs	Get /tableConfigs	Lists all TableConfigs in cluster
TableApi	ListTables	Get /tables	Lists all tables in cluster
TableApi	PauseConsumption	Post /tables/{tableName}/pauseConsumption	Pause consumption of a realtime table
TableApi	Put	Put /tables/{tableName}/segmentConfigs	Update segments configuration
TableApi	Rebalance	Post /tables/{tableName}/rebalance	Rebalances a table (reassign instances and segments for a table)
TableApi	RebalanceStatus	Get /rebalanceStatus/{jobId}	Gets detailed stats of a rebalance operation
TableApi	RebuildBrokerResource	Post /tables/{tableName}/rebuildBrokerResourceFromHelixTags	Rebuild broker resource for table
TableApi	RecommendConfig	Put /tables/recommender	Recommend config
TableApi	RemoveInstancePartitions	Delete /tables/{tableName}/instancePartitions	Remove the instance partitions
TableApi	ReplaceInstance	Post /tables/{tableName}/replaceInstance	Replace an instance in the instance partitions
TableApi	ResumeConsumption	Post /tables/{tableName}/resumeConsumption	Resume consumption of a realtime table
TableApi	SetInstancePartitions	Put /tables/{tableName}/instancePartitions	Create/update the instance partitions
TableApi	SetTimeBoundary	Post /tables/{tableName}/timeBoundary	Set hybrid table query time boundary based on offline segments' metadata
TableApi	UpdateConfig	Put /tableConfigs/{tableName}	Update the TableConfigs provided by the tableConfigsStr json
TableApi	UpdateIndexingConfig	Put /tables/{tableName}/indexingConfigs	Update table indexing configuration
TableApi	UpdateTableConfig	Put /tables/{tableName}	Updates table config for a table
TableApi	UpdateTableMetadata	Put /tables/{tableName}/metadataConfigs	Update table metadata
TableApi	ValidateConfig	Post /tableConfigs/validate	Validate the TableConfigs
TableApi	ValidateTableAndSchema	Post /tables/validateTableAndSchema	Validate table config for a table along with specified schema
TaskApi	CleanUpTasks	Put /tasks/{taskType}/cleanup	Clean up finished tasks (COMPLETED, FAILED) for the given task type
TaskApi	CleanUpTasksDeprecated	Put /tasks/cleanuptasks/{taskType}	Clean up finished tasks (COMPLETED, FAILED) for the given task type (deprecated)
TaskApi	DeleteTask	Delete /tasks/task/{taskName}	Delete a single task given its task name
TaskApi	DeleteTaskMetadataByTable	Delete /tasks/{taskType}/{tableNameWithType}/metadata	Delete task metadata for the given task type and table
TaskApi	DeleteTaskQueue	Delete /tasks/taskqueue/{taskType}	Delete a task queue (deprecated)
TaskApi	DeleteTasks	Delete /tasks/{taskType}	Delete all tasks (as well as the task queue) for the given task type
TaskApi	ExecuteAdhocTask	Post /tasks/execute	Execute a task on minion
TaskApi	GetCronSchedulerInformation	Get /tasks/scheduler/information	Fetch cron scheduler information
TaskApi	GetCronSchedulerJobDetails	Get /tasks/scheduler/jobDetails	Fetch cron scheduler job keys
TaskApi	GetCronSchedulerJobKeys	Get /tasks/scheduler/jobKeys	Fetch cron scheduler job keys
TaskApi	GetSubtaskConfigs	Get /tasks/subtask/{taskName}/config	Get the configs of specified sub tasks for the given task
TaskApi	GetSubtaskOnWorkerProgress	Get /tasks/subtask/workers/progress	Get progress of all subtasks with specified state tracked by minion worker in memory
TaskApi	GetSubtaskProgress	Get /tasks/subtask/{taskName}/progress	Get progress of specified sub tasks for the given task tracked by minion worker in memory
TaskApi	GetSubtaskStates	Get /tasks/subtask/{taskName}/state	Get the states of all the sub tasks for the given task
TaskApi	GetTaskConfig	Get /tasks/task/{taskName}/runtime/config	Get the task runtime config for the given task
TaskApi	GetTaskConfigs	Get /tasks/task/{taskName}/config	Get the task config (a list of child task configs) for the given task
TaskApi	GetTaskConfigsDeprecated	Get /tasks/taskconfig/{taskName}	Get the task config (a list of child task configs) for the given task (deprecated)
TaskApi	GetTaskCounts	Get /tasks/{taskType}/taskcounts	Fetch count of sub-tasks for each of the tasks for the given task type
TaskApi	GetTaskDebugInfo	Get /tasks/task/{taskName}/debug	Fetch information for the given task name
TaskApi	GetTaskGenerationDebugInto	Get /tasks/generator/{tableNameWithType}/{taskType}/debug	Fetch task generation information for the recent runs of the given task for the given table
TaskApi	GetTaskMetadataByTable	Get /tasks/{taskType}/{tableNameWithType}/metadata	Get task metadata for the given task type and table
TaskApi	GetTaskQueueState	Get /tasks/{taskType}/state	Get the state (task queue state) for the given task type
TaskApi	GetTaskQueueStateDeprecated	Get /tasks/taskqueuestate/{taskType}	Get the state (task queue state) for the given task type (deprecated)
TaskApi	GetTaskQueues	Get /tasks/taskqueues	List all task queues (deprecated)
TaskApi	GetTaskState	Get /tasks/task/{taskName}/state	Get the task state for the given task
TaskApi	GetTaskStateDeprecated	Get /tasks/taskstate/{taskName}	Get the task state for the given task (deprecated)
TaskApi	GetTaskStates	Get /tasks/{taskType}/taskstates	Get a map from task to task state for the given task type
TaskApi	GetTaskStatesByTable	Get /tasks/{taskType}/{tableNameWithType}/state	List all tasks for the given task type
TaskApi	GetTaskStatesDeprecated	Get /tasks/taskstates/{taskType}	Get a map from task to task state for the given task type (deprecated)
TaskApi	GetTasks	Get /tasks/{taskType}/tasks	List all tasks for the given task type
TaskApi	GetTasksDebugInfo	Get /tasks/{taskType}/{tableNameWithType}/debug	Fetch information for all the tasks for the given task type and table
TaskApi	GetTasksDebugInfo1	Get /tasks/{taskType}/debug	Fetch information for all the tasks for the given task type
TaskApi	GetTasksDeprecated	Get /tasks/tasks/{taskType}	List all tasks for the given task type (deprecated)
TaskApi	ListTaskTypes	Get /tasks/tasktypes	List all task types
TaskApi	ResumeTasks	Put /tasks/{taskType}/resume	Resume all stopped tasks (as well as the task queue) for the given task type
TaskApi	ScheduleTasks	Post /tasks/schedule	Schedule tasks and return a map from task type to task name scheduled
TaskApi	ScheduleTasksDeprecated	Put /tasks/scheduletasks	Schedule tasks (deprecated)
TaskApi	StopTasks	Put /tasks/{taskType}/stop	Stop all running/pending tasks (as well as the task queue) for the given task type
TaskApi	ToggleTaskQueueState	Put /tasks/taskqueue/{taskType}	Stop/resume a task queue (deprecated)
TenantApi	ChangeTenantState	Post /tenants/{tenantName}/metadata	Change tenant state
TenantApi	CreateTenant	Post /tenants	Create a tenant
TenantApi	DeleteTenant	Delete /tenants/{tenantName}	Delete a tenant
TenantApi	GetAllTenants	Get /tenants	List all tenants
TenantApi	GetTablesOnTenant	Get /tenants/{tenantName}/tables	List tables on a a server tenant
TenantApi	GetTenantMetadata	Get /tenants/{tenantName}/metadata	Get tenant information
TenantApi	ListInstanceOrToggleTenantState	Get /tenants/{tenantName}	List instance for a tenant, or enable/disable/drop a tenant
TenantApi	RebuildBrokerResource	Post /tables/{tableName}/rebuildBrokerResourceFromHelixTags	Rebuild broker resource for table
TenantApi	UpdateTenant	Put /tenants	Update a tenant
TunerApi	TuneTable	Get /tuner/{tableName}	Apply tuner(s) to a table
TunerApi	TuneTable1	Post /tuner/{tableName}	Apply specific tuner to a table
UpsertApi	EstimateHeapUsage	Post /upsert/estimateHeapUsage	Estimate memory usage for an upsert table
UserApi	AddUser	Post /users	Add a user
UserApi	DeleteUser	Delete /users/{username}	Delete a user
UserApi	GetUser	Get /users/{username}	Get an user in cluster
UserApi	ListUers	Get /users	List all uses in cluster
UserApi	UpdateUserConfig	Put /users/{username}	Update user config for a user
VersionApi	GetVersionNumber	Get /version	Get version number of Pinot components
WriteApiApi	GetWriteConfig	Get /v1/write/config/{table}	Get table config for write operation
WriteApiApi	Insert	Post /v1/write/{table}	Insert By POST Payload
WriteApiApi	UpdateWriteConfig	Put /v1/write/config/{table}	Update table config for write operation
ZookeeperApi	Delete	Delete /zk/delete	Delete the znode at this path
ZookeeperApi	GetChildren	Get /zk/getChildren	Get all child znodes
ZookeeperApi	GetData	Get /zk/get	Get content of the znode
ZookeeperApi	Ls	Get /zk/ls	List the child znodes
ZookeeperApi	Lsl	Get /zk/lsl	List the child znodes along with Stats
ZookeeperApi	PutChildren	Put /zk/putChildren	Update the content of multiple znRecord node under the same path
ZookeeperApi	PutData	Put /zk/put	Update the content of the node
ZookeeperApi	Stat	Get /zk/stat	Get the stat

Documentation For Models

• AdhocTaskConfig
• AggregationConfig
• AuthWorkflowInfo
• BatchIngestionConfig
• BloomFilterConfig
• ClusterHealthResponse
• ColumnPartitionConfig
• CompletionConfig
• ComplexTypeConfig
• ConfigSuccessResponse
• ConsumingSegmentInfo
• ConsumingSegmentsInfoMap
• DateTimeFieldSpec
• DedupConfig
• DimensionFieldSpec
• DimensionTableConfig
• FieldConfig
• FilterConfig
• FormDataMultiPart
• IndexingConfig
• IngestionConfig
• Instance
• InstanceAssignmentConfig
• InstanceConstraintConfig
• InstanceInfo
• InstancePartitions
• InstanceReplicaGroupPartitionConfig
• InstanceTagPoolConfig
• Instances
• JobKey
• JsonIndexConfig
• LeadControllerEntry
• LeadControllerResponse
• MetricFieldSpec
• PartitionOffsetInfo
• PinotTaskConfig
• QueryConfig
• QuotaConfig
• RebalanceResult
• RebalanceStateStats
• ReplicaGroupStrategyConfig
• RoutingConfig
• Schema
• SegmentAssignmentConfig
• SegmentConsumerInfo
• SegmentDebugInfo
• SegmentErrorInfo
• SegmentPartitionConfig
• SegmentSizeDetails
• SegmentSizeInfo
• SegmentState
• SegmentsValidationAndRetentionConfig
• ServerRebalanceJobStatusResponse
• ServerReloadControllerJobStatusResponse
• StarTreeIndexConfig
• StartReplaceSegmentsRequest
• StreamIngestionConfig
• StringResultResponse
• SubtaskDebugInfo
• SuccessResponse
• TableAndSchemaConfig
• TableConfig
• TableCustomConfig
• TableRebalanceProgressStats
• TableSizeDetails
• TableSubTypeSizeDetails
• TableTaskConfig
• TableTierDetails
• TableView
• TableWriteConfig
• TagOverrideConfig
• TaskCount
• TaskDebugInfo
• Tenant
• TenantConfig
• TenantMetadata
• TenantsList
• TierConfig
• TimeFieldSpec
• TimeGranularitySpec
• TimestampConfig
• TransformConfig
• TunerConfig
• UpsertConfig
• WritePayload

Documentation For Authorization

oauth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author