Documentation
¶
Overview ¶
Package api provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.8.0 DO NOT EDIT.
Index ¶
- func Handler(si ServerInterface) http.Handler
- func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler
- func HandlerFromMuxWithBaseURL(si ServerInterface, r chi.Router, baseURL string) http.Handler
- func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler
- type ACLEntry
- type AlterTopicConfigs200JSONResponse
- type AlterTopicConfigs400JSONResponse
- type AlterTopicConfigs401JSONResponse
- type AlterTopicConfigs403JSONResponse
- type AlterTopicConfigs404JSONResponse
- type AlterTopicConfigs502JSONResponse
- type AlterTopicConfigsJSONRequestBody
- type AlterTopicConfigsParams
- type AlterTopicConfigsRequest
- type AlterTopicConfigsRequestObject
- type AlterTopicConfigsResponse
- type AlterTopicConfigsResponseObject
- type AlterTopicConfigsResult
- type BadGateway
- type BadGatewayJSONResponse
- type BadRequest
- type BadRequestJSONResponse
- type BrokerInfo
- type BrokerIssue
- type Capabilities
- type CapabilitiesResponse
- type ChiServerOptions
- type Cluster
- type ClusterConfig
- type ClusterInfo
- type ConnectionErrorClass
- type ConsumeMessages200JSONResponse
- type ConsumeMessages400JSONResponse
- type ConsumeMessages401JSONResponse
- type ConsumeMessages403JSONResponse
- type ConsumeMessages404JSONResponse
- type ConsumeMessages502JSONResponse
- type ConsumeMessagesParams
- type ConsumeMessagesParamsFrom
- type ConsumeMessagesRequestObject
- type ConsumeMessagesResponseObject
- type CopyMessages200TexteventStreamResponse
- type CopyMessages400JSONResponse
- type CopyMessages401JSONResponse
- type CopyMessages403JSONResponse
- type CopyMessages428JSONResponse
- type CopyMessages429JSONResponse
- type CopyMessages429ResponseHeaders
- type CopyMessages502JSONResponse
- type CopyMessagesJSONRequestBody
- type CopyMessagesParams
- type CopyMessagesParamsXKafkitoConfirmProd
- type CopyMessagesRequestObject
- type CopyMessagesResponseObject
- type CopyProgressEvent
- type CopyRequest
- type CountMessages200JSONResponse
- type CountMessages400JSONResponse
- type CountMessages401JSONResponse
- type CountMessages403JSONResponse
- type CountMessages404JSONResponse
- type CountMessages502JSONResponse
- type CountMessagesParams
- type CountMessagesRequestObject
- type CountMessagesResponseObject
- type CreateACLResponse
- type CreateAcl201JSONResponse
- type CreateAcl400JSONResponse
- type CreateAcl401JSONResponse
- type CreateAcl403JSONResponse
- type CreateAcl404JSONResponse
- type CreateAcl502JSONResponse
- type CreateAclJSONRequestBody
- type CreateAclParams
- type CreateAclRequestObject
- type CreateAclResponseObject
- type CreateGroup200JSONResponse
- type CreateGroup400JSONResponse
- type CreateGroup401JSONResponse
- type CreateGroup403JSONResponse
- type CreateGroup404JSONResponse
- type CreateGroup409JSONResponse
- type CreateGroup502JSONResponse
- type CreateGroupJSONRequestBody
- type CreateGroupParams
- type CreateGroupRequest
- type CreateGroupRequestObject
- type CreateGroupResponseObject
- type CreateTopic201JSONResponse
- type CreateTopic400JSONResponse
- type CreateTopic401JSONResponse
- type CreateTopic403JSONResponse
- type CreateTopic404JSONResponse
- type CreateTopic502JSONResponse
- type CreateTopicJSONRequestBody
- type CreateTopicParams
- type CreateTopicRequest
- type CreateTopicRequestObject
- type CreateTopicResponseObject
- type CreatedResponse
- type DeleteACLResponse
- type DeleteAcl200JSONResponse
- type DeleteAcl400JSONResponse
- type DeleteAcl401JSONResponse
- type DeleteAcl403JSONResponse
- type DeleteAcl404JSONResponse
- type DeleteAcl502JSONResponse
- type DeleteAclJSONRequestBody
- type DeleteAclParams
- type DeleteAclRequestObject
- type DeleteAclResponseObject
- type DeleteGroup200JSONResponse
- type DeleteGroup400JSONResponse
- type DeleteGroup401JSONResponse
- type DeleteGroup403JSONResponse
- type DeleteGroup404JSONResponse
- type DeleteGroup502JSONResponse
- type DeleteGroupParams
- type DeleteGroupRequestObject
- type DeleteGroupResponseObject
- type DeleteRecords200JSONResponse
- type DeleteRecords400JSONResponse
- type DeleteRecords401JSONResponse
- type DeleteRecords403JSONResponse
- type DeleteRecords404JSONResponse
- type DeleteRecords428JSONResponse
- type DeleteRecords502JSONResponse
- type DeleteRecordsJSONRequestBody
- type DeleteRecordsParams
- type DeleteRecordsParamsXKafkitoConfirmProd
- type DeleteRecordsRequest
- type DeleteRecordsRequestObject
- type DeleteRecordsResponse
- type DeleteRecordsResponseObject
- type DeleteRecordsResult
- type DeleteSCRAMUserResponse
- type DeleteScramUser200JSONResponse
- type DeleteScramUser400JSONResponse
- type DeleteScramUser401JSONResponse
- type DeleteScramUser403JSONResponse
- type DeleteScramUser404JSONResponse
- type DeleteScramUser502JSONResponse
- type DeleteScramUserParams
- type DeleteScramUserParamsMechanism
- type DeleteScramUserRequestObject
- type DeleteScramUserResponseObject
- type DeleteSubject200JSONResponse
- type DeleteSubject400JSONResponse
- type DeleteSubject401JSONResponse
- type DeleteSubject403JSONResponse
- type DeleteSubject404JSONResponse
- type DeleteSubject502JSONResponse
- type DeleteSubjectParams
- type DeleteSubjectRequestObject
- type DeleteSubjectResponse
- type DeleteSubjectResponseObject
- type DeleteTopic200JSONResponse
- type DeleteTopic400JSONResponse
- type DeleteTopic401JSONResponse
- type DeleteTopic403JSONResponse
- type DeleteTopic404JSONResponse
- type DeleteTopic428JSONResponse
- type DeleteTopic502JSONResponse
- type DeleteTopicParams
- type DeleteTopicParamsXKafkitoConfirmProd
- type DeleteTopicRequestObject
- type DeleteTopicResponseObject
- type DeletedNameResponse
- type DescribeGroup200JSONResponse
- type DescribeGroup400JSONResponse
- type DescribeGroup401JSONResponse
- type DescribeGroup403JSONResponse
- type DescribeGroup404JSONResponse
- type DescribeGroup502JSONResponse
- type DescribeGroupParams
- type DescribeGroupRequestObject
- type DescribeGroupResponseObject
- type DescribeTopic200JSONResponse
- type DescribeTopic400JSONResponse
- type DescribeTopic401JSONResponse
- type DescribeTopic403JSONResponse
- type DescribeTopic404JSONResponse
- type DescribeTopic502JSONResponse
- type DescribeTopicParams
- type DescribeTopicRequestObject
- type DescribeTopicResponse
- type DescribeTopicResponseObject
- type DownloadMessageRaw200ApplicationoctetStreamResponse
- type DownloadMessageRaw200ApplicationxmlResponse
- type DownloadMessageRaw200JSONResponse
- type DownloadMessageRaw200ResponseHeaders
- type DownloadMessageRaw200TextResponse
- type DownloadMessageRaw400JSONResponse
- type DownloadMessageRaw401JSONResponse
- type DownloadMessageRaw403JSONResponse
- type DownloadMessageRaw404JSONResponse
- type DownloadMessageRaw413JSONResponse
- type DownloadMessageRaw502JSONResponse
- type DownloadMessageRawParams
- type DownloadMessageRawRequestObject
- type DownloadMessageRawResponseObject
- type Error
- type Forbidden
- type ForbiddenJSONResponse
- type FromTsMsQuery
- type GetCapabilities200JSONResponse
- type GetCapabilities400JSONResponse
- type GetCapabilities401JSONResponse
- type GetCapabilities403JSONResponse
- type GetCapabilities404JSONResponse
- type GetCapabilities502JSONResponse
- type GetCapabilitiesParams
- type GetCapabilitiesRequestObject
- type GetCapabilitiesResponseObject
- type GetHealth200JSONResponse
- type GetHealthRequestObject
- type GetHealthResponseObject
- type GetInfo200JSONResponse
- type GetInfo401JSONResponse
- type GetInfoRequestObject
- type GetInfoResponseObject
- type GetMe200JSONResponse
- type GetMe401JSONResponse
- type GetMeRequestObject
- type GetMeResponseObject
- type GetMessageTimeline200JSONResponse
- type GetMessageTimeline400JSONResponse
- type GetMessageTimeline401JSONResponse
- type GetMessageTimeline403JSONResponse
- type GetMessageTimeline404JSONResponse
- type GetMessageTimeline502JSONResponse
- type GetMessageTimelineParams
- type GetMessageTimelineRequestObject
- type GetMessageTimelineResponseObject
- type GetOpenApiSpec200ApplicationyamlResponse
- type GetOpenApiSpec401JSONResponse
- type GetOpenApiSpecRequestObject
- type GetOpenApiSpecResponseObject
- type GetReadiness200JSONResponse
- type GetReadiness503JSONResponse
- type GetReadinessRequestObject
- type GetReadinessResponseObject
- type GetSchemaVersion200JSONResponse
- type GetSchemaVersion400JSONResponse
- type GetSchemaVersion401JSONResponse
- type GetSchemaVersion403JSONResponse
- type GetSchemaVersion404JSONResponse
- type GetSchemaVersion502JSONResponse
- type GetSchemaVersionParams
- type GetSchemaVersionRequestObject
- type GetSchemaVersionResponseObject
- type Group
- type GroupDetail
- type GroupInfo
- type GroupMember
- type GroupOffset
- type HealthResponse
- type HealthResponseStatus
- type InfoResponse
- type InvalidParamFormatError
- type ListACLsResponse
- type ListAcls200JSONResponse
- type ListAcls400JSONResponse
- type ListAcls401JSONResponse
- type ListAcls403JSONResponse
- type ListAcls404JSONResponse
- type ListAcls502JSONResponse
- type ListAclsParams
- type ListAclsRequestObject
- type ListAclsResponseObject
- type ListBrokers200JSONResponse
- type ListBrokers400JSONResponse
- type ListBrokers401JSONResponse
- type ListBrokers403JSONResponse
- type ListBrokers404JSONResponse
- type ListBrokers502JSONResponse
- type ListBrokersParams
- type ListBrokersRequestObject
- type ListBrokersResponse
- type ListBrokersResponseObject
- type ListClusters200JSONResponse
- type ListClusters401JSONResponse
- type ListClustersRequestObject
- type ListClustersResponse
- type ListClustersResponseObject
- type ListGroups200JSONResponse
- type ListGroups400JSONResponse
- type ListGroups401JSONResponse
- type ListGroups403JSONResponse
- type ListGroups404JSONResponse
- type ListGroups502JSONResponse
- type ListGroupsParams
- type ListGroupsRequestObject
- type ListGroupsResponse
- type ListGroupsResponseObject
- type ListSCRAMUsersResponse
- type ListSchemaVersions200JSONResponse
- type ListSchemaVersions400JSONResponse
- type ListSchemaVersions401JSONResponse
- type ListSchemaVersions403JSONResponse
- type ListSchemaVersions404JSONResponse
- type ListSchemaVersions502JSONResponse
- type ListSchemaVersionsParams
- type ListSchemaVersionsRequestObject
- type ListSchemaVersionsResponse
- type ListSchemaVersionsResponseObject
- type ListScramUsers200JSONResponse
- type ListScramUsers400JSONResponse
- type ListScramUsers401JSONResponse
- type ListScramUsers403JSONResponse
- type ListScramUsers404JSONResponse
- type ListScramUsers502JSONResponse
- type ListScramUsersParams
- type ListScramUsersRequestObject
- type ListScramUsersResponseObject
- type ListSubjects200JSONResponse
- type ListSubjects400JSONResponse
- type ListSubjects401JSONResponse
- type ListSubjects403JSONResponse
- type ListSubjects404JSONResponse
- type ListSubjects502JSONResponse
- type ListSubjectsParams
- type ListSubjectsRequestObject
- type ListSubjectsResponse
- type ListSubjectsResponseObject
- type ListTopicConsumers200JSONResponse
- type ListTopicConsumers400JSONResponse
- type ListTopicConsumers401JSONResponse
- type ListTopicConsumers403JSONResponse
- type ListTopicConsumers404JSONResponse
- type ListTopicConsumers502JSONResponse
- type ListTopicConsumers504JSONResponse
- type ListTopicConsumersParams
- type ListTopicConsumersRequestObject
- type ListTopicConsumersResponse
- type ListTopicConsumersResponseObject
- type ListTopics200JSONResponse
- type ListTopics400JSONResponse
- type ListTopics401JSONResponse
- type ListTopics403JSONResponse
- type ListTopics404JSONResponse
- type ListTopics502JSONResponse
- type ListTopicsParams
- type ListTopicsRequestObject
- type ListTopicsResponse
- type ListTopicsResponseObject
- type MaskingRule
- type MaskingRuleTargets
- type MeResponse
- type MemberAssignment
- type Message
- type MessageCountPartition
- type MessageCountResponse
- type MessageTimelineResponse
- type MessageTimelineSlot
- type MessagesPage
- type MiddlewareFunc
- type NotFound
- type NotFoundJSONResponse
- type ParseErrorOffset
- type PartitionInfo
- type PartitionQuery
- type PartitionRange
- type PayloadTooLarge
- type PayloadTooLargeJSONResponse
- type PrivateClusterHeader
- type PrivateClustersStatus
- type ProdConfirmHeader
- type ProdConfirmationRequired
- type ProdConfirmationRequiredJSONResponse
- type ProduceMessage200JSONResponse
- type ProduceMessage400JSONResponse
- type ProduceMessage401JSONResponse
- type ProduceMessage403JSONResponse
- type ProduceMessage404JSONResponse
- type ProduceMessage413JSONResponse
- type ProduceMessage428JSONResponse
- type ProduceMessage502JSONResponse
- type ProduceMessageJSONRequestBody
- type ProduceMessageParams
- type ProduceMessageParamsContentEncoding
- type ProduceMessageParamsXKafkitoConfirmProd
- type ProduceMessageRequestObject
- type ProduceMessageResponseObject
- type ProduceRequest
- type ProduceResult
- type ReadinessResponse
- type ReadinessResponseStatus
- type RefreshCapabilities200JSONResponse
- type RefreshCapabilities400JSONResponse
- type RefreshCapabilities401JSONResponse
- type RefreshCapabilities403JSONResponse
- type RefreshCapabilities404JSONResponse
- type RefreshCapabilities502JSONResponse
- type RefreshCapabilitiesParams
- type RefreshCapabilitiesRequestObject
- type RefreshCapabilitiesResponseObject
- type RegisterSchema200JSONResponse
- type RegisterSchema400JSONResponse
- type RegisterSchema401JSONResponse
- type RegisterSchema403JSONResponse
- type RegisterSchema404JSONResponse
- type RegisterSchema502JSONResponse
- type RegisterSchemaJSONRequestBody
- type RegisterSchemaParams
- type RegisterSchemaRequest
- type RegisterSchemaRequestObject
- type RegisterSchemaResponse
- type RegisterSchemaResponseObject
- type RequiredHeaderError
- type RequiredParamError
- type ResetGroupOffsets200JSONResponse
- type ResetGroupOffsets400JSONResponse
- type ResetGroupOffsets401JSONResponse
- type ResetGroupOffsets403JSONResponse
- type ResetGroupOffsets404JSONResponse
- type ResetGroupOffsets428JSONResponse
- type ResetGroupOffsets502JSONResponse
- type ResetGroupOffsetsJSONRequestBody
- type ResetGroupOffsetsParams
- type ResetGroupOffsetsParamsXKafkitoConfirmProd
- type ResetGroupOffsetsRequestObject
- type ResetGroupOffsetsResponseObject
- type ResetOffsetResult
- type ResetOffsetsRequest
- type ResetOffsetsResponse
- type SCRAMCredential
- type SCRAMUser
- type SRDecodedMeta
- type SampleMessages200JSONResponse
- type SampleMessages400JSONResponse
- type SampleMessages401JSONResponse
- type SampleMessages403JSONResponse
- type SampleMessages404JSONResponse
- type SampleMessages502JSONResponse
- type SampleMessagesParams
- type SampleMessagesRequestObject
- type SampleMessagesResponseObject
- type SampleResponse
- type SchemaReference
- type SchemaSubject
- type SchemaVersion
- type SearchMessages200JSONResponse
- type SearchMessages400JSONResponse
- type SearchMessages401JSONResponse
- type SearchMessages403JSONResponse
- type SearchMessages404JSONResponse
- type SearchMessages502JSONResponse
- type SearchMessagesJSONRequestBody
- type SearchMessagesParams
- type SearchMessagesRequestObject
- type SearchMessagesResponseObject
- type SearchRequest
- type SearchRequestDirection
- type SearchRequestMode
- type SearchRequestOp
- type SearchRequestZones
- type SearchResponse
- type SearchStats
- type ServerInterface
- type ServerInterfaceWrapper
- func (siw *ServerInterfaceWrapper) AlterTopicConfigs(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ConsumeMessages(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) CopyMessages(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) CountMessages(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) CreateAcl(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) CreateGroup(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) CreateTopic(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) DeleteAcl(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) DeleteGroup(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) DeleteRecords(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) DeleteScramUser(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) DeleteSubject(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) DeleteTopic(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) DescribeGroup(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) DescribeTopic(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) DownloadMessageRaw(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetCapabilities(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetHealth(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetInfo(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetMe(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetMessageTimeline(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetOpenApiSpec(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetReadiness(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetSchemaVersion(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListAcls(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListBrokers(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListClusters(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListGroups(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListSchemaVersions(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListScramUsers(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListSubjects(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListTopicConsumers(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListTopics(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ProduceMessage(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) RefreshCapabilities(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) RegisterSchema(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ResetGroupOffsets(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) SampleMessages(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) SearchMessages(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) TestCluster(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) UpsertScramUser(w http.ResponseWriter, r *http.Request)
- type StrictHTTPServerOptions
- type StrictHandlerFunc
- type StrictMiddlewareFunc
- type StrictServerInterface
- type Subject
- type TestCluster200JSONResponse
- type TestCluster400JSONResponse
- type TestCluster401JSONResponse
- type TestCluster403JSONResponse
- type TestCluster429JSONResponse
- type TestCluster429ResponseHeaders
- type TestClusterJSONRequestBody
- type TestClusterParams
- type TestClusterRequestObject
- type TestClusterResponseObject
- type ToTsMsQuery
- type TooManyValuesForParamError
- type Topic
- type TopicConfigEntry
- type TopicConsumer
- type TopicDetail
- type TopicInfo
- type Unauthorized
- type UnauthorizedJSONResponse
- type UnauthorizedResponseHeaders
- type UnescapedCookieParamError
- type Unimplemented
- func (_ Unimplemented) AlterTopicConfigs(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, ...)
- func (_ Unimplemented) ConsumeMessages(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, ...)
- func (_ Unimplemented) CopyMessages(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, ...)
- func (_ Unimplemented) CountMessages(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, ...)
- func (_ Unimplemented) CreateAcl(w http.ResponseWriter, r *http.Request, cluster Cluster, ...)
- func (_ Unimplemented) CreateGroup(w http.ResponseWriter, r *http.Request, cluster Cluster, ...)
- func (_ Unimplemented) CreateTopic(w http.ResponseWriter, r *http.Request, cluster Cluster, ...)
- func (_ Unimplemented) DeleteAcl(w http.ResponseWriter, r *http.Request, cluster Cluster, ...)
- func (_ Unimplemented) DeleteGroup(w http.ResponseWriter, r *http.Request, cluster Cluster, group Group, ...)
- func (_ Unimplemented) DeleteRecords(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, ...)
- func (_ Unimplemented) DeleteScramUser(w http.ResponseWriter, r *http.Request, cluster Cluster, user string, ...)
- func (_ Unimplemented) DeleteSubject(w http.ResponseWriter, r *http.Request, cluster Cluster, subject Subject, ...)
- func (_ Unimplemented) DeleteTopic(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, ...)
- func (_ Unimplemented) DescribeGroup(w http.ResponseWriter, r *http.Request, cluster Cluster, group Group, ...)
- func (_ Unimplemented) DescribeTopic(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, ...)
- func (_ Unimplemented) DownloadMessageRaw(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, ...)
- func (_ Unimplemented) GetCapabilities(w http.ResponseWriter, r *http.Request, cluster Cluster, ...)
- func (_ Unimplemented) GetHealth(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) GetInfo(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) GetMe(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) GetMessageTimeline(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, ...)
- func (_ Unimplemented) GetOpenApiSpec(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) GetReadiness(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) GetSchemaVersion(w http.ResponseWriter, r *http.Request, cluster Cluster, subject Subject, ...)
- func (_ Unimplemented) ListAcls(w http.ResponseWriter, r *http.Request, cluster Cluster, params ListAclsParams)
- func (_ Unimplemented) ListBrokers(w http.ResponseWriter, r *http.Request, cluster Cluster, ...)
- func (_ Unimplemented) ListClusters(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) ListGroups(w http.ResponseWriter, r *http.Request, cluster Cluster, ...)
- func (_ Unimplemented) ListSchemaVersions(w http.ResponseWriter, r *http.Request, cluster Cluster, subject Subject, ...)
- func (_ Unimplemented) ListScramUsers(w http.ResponseWriter, r *http.Request, cluster Cluster, ...)
- func (_ Unimplemented) ListSubjects(w http.ResponseWriter, r *http.Request, cluster Cluster, ...)
- func (_ Unimplemented) ListTopicConsumers(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, ...)
- func (_ Unimplemented) ListTopics(w http.ResponseWriter, r *http.Request, cluster Cluster, ...)
- func (_ Unimplemented) ProduceMessage(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, ...)
- func (_ Unimplemented) RefreshCapabilities(w http.ResponseWriter, r *http.Request, cluster Cluster, ...)
- func (_ Unimplemented) RegisterSchema(w http.ResponseWriter, r *http.Request, cluster Cluster, subject Subject, ...)
- func (_ Unimplemented) ResetGroupOffsets(w http.ResponseWriter, r *http.Request, cluster Cluster, group Group, ...)
- func (_ Unimplemented) SampleMessages(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, ...)
- func (_ Unimplemented) SearchMessages(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, ...)
- func (_ Unimplemented) TestCluster(w http.ResponseWriter, r *http.Request, params TestClusterParams)
- func (_ Unimplemented) UpsertScramUser(w http.ResponseWriter, r *http.Request, cluster Cluster, ...)
- type UnmarshalingParamError
- type UpsertSCRAMUserRequest
- type UpsertSCRAMUserRequestMechanism
- type UpsertSCRAMUserResponse
- type UpsertScramUser200JSONResponse
- type UpsertScramUser400JSONResponse
- type UpsertScramUser401JSONResponse
- type UpsertScramUser403JSONResponse
- type UpsertScramUser404JSONResponse
- type UpsertScramUser502JSONResponse
- type UpsertScramUserJSONRequestBody
- type UpsertScramUserParams
- type UpsertScramUserRequestObject
- type UpsertScramUserResponseObject
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Handler ¶
func Handler(si ServerInterface) http.Handler
Handler creates http.Handler with routing matching OpenAPI spec.
func HandlerFromMux ¶
func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler
HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.
func HandlerWithOptions ¶
func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler
HandlerWithOptions creates http.Handler with additional options
Types ¶
type ACLEntry ¶
ACLEntry ACL binding. As a request body it is a create spec or a delete filter. Enum-like fields are parsed case-insensitively by franz-go (`kmsg`).
type AlterTopicConfigs200JSONResponse ¶
type AlterTopicConfigs200JSONResponse AlterTopicConfigsResponse
func (AlterTopicConfigs200JSONResponse) VisitAlterTopicConfigsResponse ¶
func (response AlterTopicConfigs200JSONResponse) VisitAlterTopicConfigsResponse(w http.ResponseWriter) error
type AlterTopicConfigs400JSONResponse ¶
type AlterTopicConfigs400JSONResponse struct{ BadRequestJSONResponse }
func (AlterTopicConfigs400JSONResponse) VisitAlterTopicConfigsResponse ¶
func (response AlterTopicConfigs400JSONResponse) VisitAlterTopicConfigsResponse(w http.ResponseWriter) error
type AlterTopicConfigs401JSONResponse ¶
func (AlterTopicConfigs401JSONResponse) VisitAlterTopicConfigsResponse ¶
func (response AlterTopicConfigs401JSONResponse) VisitAlterTopicConfigsResponse(w http.ResponseWriter) error
type AlterTopicConfigs403JSONResponse ¶
type AlterTopicConfigs403JSONResponse struct{ ForbiddenJSONResponse }
func (AlterTopicConfigs403JSONResponse) VisitAlterTopicConfigsResponse ¶
func (response AlterTopicConfigs403JSONResponse) VisitAlterTopicConfigsResponse(w http.ResponseWriter) error
type AlterTopicConfigs404JSONResponse ¶
type AlterTopicConfigs404JSONResponse struct{ NotFoundJSONResponse }
func (AlterTopicConfigs404JSONResponse) VisitAlterTopicConfigsResponse ¶
func (response AlterTopicConfigs404JSONResponse) VisitAlterTopicConfigsResponse(w http.ResponseWriter) error
type AlterTopicConfigs502JSONResponse ¶
type AlterTopicConfigs502JSONResponse struct{ BadGatewayJSONResponse }
func (AlterTopicConfigs502JSONResponse) VisitAlterTopicConfigsResponse ¶
func (response AlterTopicConfigs502JSONResponse) VisitAlterTopicConfigsResponse(w http.ResponseWriter) error
type AlterTopicConfigsJSONRequestBody ¶
type AlterTopicConfigsJSONRequestBody = AlterTopicConfigsRequest
AlterTopicConfigsJSONRequestBody defines body for AlterTopicConfigs for application/json ContentType.
type AlterTopicConfigsParams ¶
type AlterTopicConfigsParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
AlterTopicConfigsParams defines parameters for AlterTopicConfigs.
type AlterTopicConfigsRequest ¶
type AlterTopicConfigsRequest = kafka.AlterTopicConfigsRequest
AlterTopicConfigsRequest defines model for AlterTopicConfigsRequest.
type AlterTopicConfigsRequestObject ¶
type AlterTopicConfigsRequestObject struct {
Cluster Cluster `json:"cluster"`
Topic Topic `json:"topic"`
Params AlterTopicConfigsParams
Body *AlterTopicConfigsJSONRequestBody
}
type AlterTopicConfigsResponse ¶
type AlterTopicConfigsResponse struct {
Results []AlterTopicConfigsResult `json:"results"`
}
AlterTopicConfigsResponse defines model for AlterTopicConfigsResponse.
type AlterTopicConfigsResponseObject ¶
type AlterTopicConfigsResponseObject interface {
VisitAlterTopicConfigsResponse(w http.ResponseWriter) error
}
type AlterTopicConfigsResult ¶
type AlterTopicConfigsResult = kafka.AlterTopicConfigsResult
AlterTopicConfigsResult defines model for AlterTopicConfigsResult.
type BadGatewayJSONResponse ¶
type BadGatewayJSONResponse Error
type BadRequestJSONResponse ¶
type BadRequestJSONResponse Error
type BrokerIssue ¶ added in v1.3.0
type BrokerIssue = kafka.BrokerIssue
BrokerIssue defines model for BrokerIssue.
type Capabilities ¶
type Capabilities = kafka.Capabilities
Capabilities defines model for Capabilities.
type CapabilitiesResponse ¶
type CapabilitiesResponse struct {
Capabilities Capabilities `json:"capabilities"`
Cluster string `json:"cluster"`
}
CapabilitiesResponse defines model for CapabilitiesResponse.
type ChiServerOptions ¶
type ChiServerOptions struct {
BaseURL string
BaseRouter chi.Router
Middlewares []MiddlewareFunc
ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
type ClusterConfig ¶
type ClusterConfig = config.ClusterConfig
ClusterConfig Ad-hoc ("private") cluster definition supplied per request instead of from the server config — the same JSON the `X-Kafkito-Cluster` header carries (base64-encoded there). Broker and Schema Registry hosts are subject to the server's outbound-host (SSRF) policy. A definition that violates it or fails validation gets a 400 whose message names the field (a broker by its 1-based position) and a fixed reason, never the submitted value.
type ConnectionErrorClass ¶ added in v1.3.0
ConnectionErrorClass Class of a failed connection attempt to a cluster. Each class has a fixed text: `refused` connection refused, `timeout` connection timed out, `dns` host name could not be resolved, `tls` TLS handshake failed, `sasl` authentication failed, `blocked` destination not allowed (outbound address guard), `unreachable` broker not reachable (any other failure).
type ConsumeMessages200JSONResponse ¶
type ConsumeMessages200JSONResponse MessagesPage
func (ConsumeMessages200JSONResponse) VisitConsumeMessagesResponse ¶
func (response ConsumeMessages200JSONResponse) VisitConsumeMessagesResponse(w http.ResponseWriter) error
type ConsumeMessages400JSONResponse ¶
type ConsumeMessages400JSONResponse struct{ BadRequestJSONResponse }
func (ConsumeMessages400JSONResponse) VisitConsumeMessagesResponse ¶
func (response ConsumeMessages400JSONResponse) VisitConsumeMessagesResponse(w http.ResponseWriter) error
type ConsumeMessages401JSONResponse ¶
func (ConsumeMessages401JSONResponse) VisitConsumeMessagesResponse ¶
func (response ConsumeMessages401JSONResponse) VisitConsumeMessagesResponse(w http.ResponseWriter) error
type ConsumeMessages403JSONResponse ¶
type ConsumeMessages403JSONResponse struct{ ForbiddenJSONResponse }
func (ConsumeMessages403JSONResponse) VisitConsumeMessagesResponse ¶
func (response ConsumeMessages403JSONResponse) VisitConsumeMessagesResponse(w http.ResponseWriter) error
type ConsumeMessages404JSONResponse ¶
type ConsumeMessages404JSONResponse struct{ NotFoundJSONResponse }
func (ConsumeMessages404JSONResponse) VisitConsumeMessagesResponse ¶
func (response ConsumeMessages404JSONResponse) VisitConsumeMessagesResponse(w http.ResponseWriter) error
type ConsumeMessages502JSONResponse ¶
type ConsumeMessages502JSONResponse struct{ BadGatewayJSONResponse }
func (ConsumeMessages502JSONResponse) VisitConsumeMessagesResponse ¶
func (response ConsumeMessages502JSONResponse) VisitConsumeMessagesResponse(w http.ResponseWriter) error
type ConsumeMessagesParams ¶
type ConsumeMessagesParams struct {
// Partition Partition number; -1 = all partitions.
Partition *PartitionQuery `form:"partition,omitempty" json:"partition,omitempty"`
// Limit Page size. Values above 500 are clamped to 500.
Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
// From Seek mode. `end` = newest records, `start` = oldest, `offset` = from `offset` (single partition) or `partition_offsets`; `from_ts_ms` / `to_ts_ms` narrow the range here too: the offset is lifted to the first record at or after `from_ts_ms`, and the page stops before `to_ts_ms`. `timestamp` = first record at or after `from_ts_ms`.
From *ConsumeMessagesParamsFrom `form:"from,omitempty" json:"from,omitempty"`
// Offset Required when `from=offset` and `partition_offsets` is not set.
Offset *int64 `form:"offset,omitempty" json:"offset,omitempty"`
// PartitionOffsets Per-partition seek offsets as `p:o,p:o` (max 1024 entries). Only valid with `from=offset`.
PartitionOffsets *string `form:"partition_offsets,omitempty" json:"partition_offsets,omitempty"`
// FromTsMs Optional inclusive lower timestamp bound in Unix milliseconds.
FromTsMs *FromTsMsQuery `form:"from_ts_ms,omitempty" json:"from_ts_ms,omitempty"`
// ToTsMs Optional exclusive upper timestamp bound in Unix milliseconds.
ToTsMs *ToTsMsQuery `form:"to_ts_ms,omitempty" json:"to_ts_ms,omitempty"`
// Cursor Opaque continuation token from a previous `next_cursor`.
Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
ConsumeMessagesParams defines parameters for ConsumeMessages.
type ConsumeMessagesParamsFrom ¶
type ConsumeMessagesParamsFrom string
ConsumeMessagesParamsFrom defines parameters for ConsumeMessages.
const ( End ConsumeMessagesParamsFrom = "end" Offset ConsumeMessagesParamsFrom = "offset" Start ConsumeMessagesParamsFrom = "start" Timestamp ConsumeMessagesParamsFrom = "timestamp" )
Defines values for ConsumeMessagesParamsFrom.
func (ConsumeMessagesParamsFrom) Valid ¶
func (e ConsumeMessagesParamsFrom) Valid() bool
Valid indicates whether the value is a known member of the ConsumeMessagesParamsFrom enum.
type ConsumeMessagesRequestObject ¶
type ConsumeMessagesRequestObject struct {
Cluster Cluster `json:"cluster"`
Topic Topic `json:"topic"`
Params ConsumeMessagesParams
}
type ConsumeMessagesResponseObject ¶
type ConsumeMessagesResponseObject interface {
VisitConsumeMessagesResponse(w http.ResponseWriter) error
}
type CopyMessages200TexteventStreamResponse ¶
func (CopyMessages200TexteventStreamResponse) VisitCopyMessagesResponse ¶
func (response CopyMessages200TexteventStreamResponse) VisitCopyMessagesResponse(w http.ResponseWriter) error
type CopyMessages400JSONResponse ¶
type CopyMessages400JSONResponse Error
func (CopyMessages400JSONResponse) VisitCopyMessagesResponse ¶
func (response CopyMessages400JSONResponse) VisitCopyMessagesResponse(w http.ResponseWriter) error
type CopyMessages401JSONResponse ¶
func (CopyMessages401JSONResponse) VisitCopyMessagesResponse ¶
func (response CopyMessages401JSONResponse) VisitCopyMessagesResponse(w http.ResponseWriter) error
type CopyMessages403JSONResponse ¶
type CopyMessages403JSONResponse struct{ ForbiddenJSONResponse }
func (CopyMessages403JSONResponse) VisitCopyMessagesResponse ¶
func (response CopyMessages403JSONResponse) VisitCopyMessagesResponse(w http.ResponseWriter) error
type CopyMessages428JSONResponse ¶
type CopyMessages428JSONResponse struct {
ProdConfirmationRequiredJSONResponse
}
func (CopyMessages428JSONResponse) VisitCopyMessagesResponse ¶
func (response CopyMessages428JSONResponse) VisitCopyMessagesResponse(w http.ResponseWriter) error
type CopyMessages429JSONResponse ¶
type CopyMessages429JSONResponse struct {
Body Error
Headers CopyMessages429ResponseHeaders
}
func (CopyMessages429JSONResponse) VisitCopyMessagesResponse ¶
func (response CopyMessages429JSONResponse) VisitCopyMessagesResponse(w http.ResponseWriter) error
type CopyMessages429ResponseHeaders ¶
type CopyMessages429ResponseHeaders struct {
RetryAfter *int
}
type CopyMessages502JSONResponse ¶
type CopyMessages502JSONResponse struct{ BadGatewayJSONResponse }
func (CopyMessages502JSONResponse) VisitCopyMessagesResponse ¶
func (response CopyMessages502JSONResponse) VisitCopyMessagesResponse(w http.ResponseWriter) error
type CopyMessagesJSONRequestBody ¶
type CopyMessagesJSONRequestBody = CopyRequest
CopyMessagesJSONRequestBody defines body for CopyMessages for application/json ContentType.
type CopyMessagesParams ¶
type CopyMessagesParams struct {
// XKafkitoConfirmProd Must be `true` when the target cluster is marked `is_prod`; the request is rejected with 428 otherwise. Send only after explicit user confirmation.
XKafkitoConfirmProd *CopyMessagesParamsXKafkitoConfirmProd `json:"X-Kafkito-Confirm-Prod,omitempty"`
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
CopyMessagesParams defines parameters for CopyMessages.
type CopyMessagesParamsXKafkitoConfirmProd ¶
type CopyMessagesParamsXKafkitoConfirmProd string
CopyMessagesParamsXKafkitoConfirmProd defines parameters for CopyMessages.
const (
CopyMessagesParamsXKafkitoConfirmProdTrue CopyMessagesParamsXKafkitoConfirmProd = "true"
)
Defines values for CopyMessagesParamsXKafkitoConfirmProd.
func (CopyMessagesParamsXKafkitoConfirmProd) Valid ¶
func (e CopyMessagesParamsXKafkitoConfirmProd) Valid() bool
Valid indicates whether the value is a known member of the CopyMessagesParamsXKafkitoConfirmProd enum.
type CopyMessagesRequestObject ¶
type CopyMessagesRequestObject struct {
Cluster Cluster `json:"cluster"`
Topic Topic `json:"topic"`
Params CopyMessagesParams
Body *CopyMessagesJSONRequestBody
}
type CopyMessagesResponseObject ¶
type CopyMessagesResponseObject interface {
VisitCopyMessagesResponse(w http.ResponseWriter) error
}
type CopyProgressEvent ¶
type CopyProgressEvent struct {
// Copied Records produced to the destination topic so far.
Copied int64 `json:"copied"`
// Done True on the final event only; omitted otherwise.
Done *bool `json:"done,omitempty"`
// Error Set on the final event when the job aborted. Omitted when empty. Errors after the stream opened still carry HTTP status 200. The text starts with `consume: ` (reading the source) or `produce: ` (writing to the destination), followed by a text that names no address, port or operating system detail: a Kafka error code with its description (for example `TOPIC_AUTHORIZATION_FAILED: ...`), `topic not found`, `partition not found`, `cancelled`, the message of the `private_cluster_address_blocked` error, or the fixed text of a `ConnectionErrorClass`. The server log has the full error.
Error *string `json:"error,omitempty"`
// Skipped Source records deliberately left out because they cannot be reproduced byte-for-byte (Schema-Registry-decoded, or masked values, keys or header values). Omitted while 0.
Skipped *int64 `json:"skipped,omitempty"`
}
CopyProgressEvent One SSE event of the copy stream, sent as a `data: {json}` line pair. Progress events arrive periodically — one right after the stream opens and at least one per fetched page — and the final event has `done: true`.
type CopyRequest ¶
type CopyRequest struct {
// DestCluster Name of a server-configured destination cluster. Mutually exclusive with `dest_cluster_config`.
DestCluster *string `json:"dest_cluster,omitempty"`
// DestClusterConfig Ad-hoc ("private") cluster definition supplied per request instead of from the server config — the same JSON the `X-Kafkito-Cluster` header carries (base64-encoded there). Broker and Schema Registry hosts are subject to the server's outbound-host (SSRF) policy. A definition that violates it or fails validation gets a 400 whose message names the field (a broker by its 1-based position) and a fixed reason, never the submitted value.
DestClusterConfig *ClusterConfig `json:"dest_cluster_config,omitempty"`
// DestTopic Destination topic. Must already exist.
DestTopic string `json:"dest_topic"`
// FromTsMs Inclusive lower bound on source record timestamps.
FromTsMs *int64 `json:"from_ts_ms,omitempty"`
// Limit Maximum number of records to copy. Absent = no limit.
Limit *int64 `json:"limit,omitempty"`
// Partition Single source partition. Absent = all partitions.
Partition *int32 `json:"partition,omitempty"`
// PreservePartition Produce each record to the same partition number it came from. Requires the destination topic to have at least as many partitions as the highest source partition, otherwise the request is rejected with 400.
PreservePartition *bool `json:"preserve_partition,omitempty"`
// ToTsMs Exclusive upper bound on source record timestamps. When omitted the server substitutes the job's start time, so a copy of a live topic terminates instead of tailing it forever.
ToTsMs *int64 `json:"to_ts_ms,omitempty"`
}
CopyRequest Body of the topic copy endpoint. Exactly one of `dest_cluster` / `dest_cluster_config` must be set.
type CountMessages200JSONResponse ¶
type CountMessages200JSONResponse MessageCountResponse
func (CountMessages200JSONResponse) VisitCountMessagesResponse ¶
func (response CountMessages200JSONResponse) VisitCountMessagesResponse(w http.ResponseWriter) error
type CountMessages400JSONResponse ¶
type CountMessages400JSONResponse struct{ BadRequestJSONResponse }
func (CountMessages400JSONResponse) VisitCountMessagesResponse ¶
func (response CountMessages400JSONResponse) VisitCountMessagesResponse(w http.ResponseWriter) error
type CountMessages401JSONResponse ¶
func (CountMessages401JSONResponse) VisitCountMessagesResponse ¶
func (response CountMessages401JSONResponse) VisitCountMessagesResponse(w http.ResponseWriter) error
type CountMessages403JSONResponse ¶
type CountMessages403JSONResponse struct{ ForbiddenJSONResponse }
func (CountMessages403JSONResponse) VisitCountMessagesResponse ¶
func (response CountMessages403JSONResponse) VisitCountMessagesResponse(w http.ResponseWriter) error
type CountMessages404JSONResponse ¶
type CountMessages404JSONResponse struct{ NotFoundJSONResponse }
func (CountMessages404JSONResponse) VisitCountMessagesResponse ¶
func (response CountMessages404JSONResponse) VisitCountMessagesResponse(w http.ResponseWriter) error
type CountMessages502JSONResponse ¶
type CountMessages502JSONResponse struct{ BadGatewayJSONResponse }
func (CountMessages502JSONResponse) VisitCountMessagesResponse ¶
func (response CountMessages502JSONResponse) VisitCountMessagesResponse(w http.ResponseWriter) error
type CountMessagesParams ¶
type CountMessagesParams struct {
// Partition Partition number; -1 = all partitions.
Partition *PartitionQuery `form:"partition,omitempty" json:"partition,omitempty"`
// FromTsMs Optional inclusive lower timestamp bound in Unix milliseconds.
FromTsMs *FromTsMsQuery `form:"from_ts_ms,omitempty" json:"from_ts_ms,omitempty"`
// ToTsMs Optional exclusive upper timestamp bound in Unix milliseconds.
ToTsMs *ToTsMsQuery `form:"to_ts_ms,omitempty" json:"to_ts_ms,omitempty"`
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
CountMessagesParams defines parameters for CountMessages.
type CountMessagesRequestObject ¶
type CountMessagesRequestObject struct {
Cluster Cluster `json:"cluster"`
Topic Topic `json:"topic"`
Params CountMessagesParams
}
type CountMessagesResponseObject ¶
type CountMessagesResponseObject interface {
VisitCountMessagesResponse(w http.ResponseWriter) error
}
type CreateACLResponse ¶
type CreateACLResponse struct {
// Acl ACL binding. As a request body it is a create spec or a delete filter. Enum-like fields are parsed case-insensitively by franz-go (`kmsg`).
Acl ACLEntry `json:"acl"`
Ok bool `json:"ok"`
}
CreateACLResponse defines model for CreateACLResponse.
type CreateAcl201JSONResponse ¶
type CreateAcl201JSONResponse CreateACLResponse
func (CreateAcl201JSONResponse) VisitCreateAclResponse ¶
func (response CreateAcl201JSONResponse) VisitCreateAclResponse(w http.ResponseWriter) error
type CreateAcl400JSONResponse ¶
type CreateAcl400JSONResponse struct{ BadRequestJSONResponse }
func (CreateAcl400JSONResponse) VisitCreateAclResponse ¶
func (response CreateAcl400JSONResponse) VisitCreateAclResponse(w http.ResponseWriter) error
type CreateAcl401JSONResponse ¶
func (CreateAcl401JSONResponse) VisitCreateAclResponse ¶
func (response CreateAcl401JSONResponse) VisitCreateAclResponse(w http.ResponseWriter) error
type CreateAcl403JSONResponse ¶
type CreateAcl403JSONResponse struct{ ForbiddenJSONResponse }
func (CreateAcl403JSONResponse) VisitCreateAclResponse ¶
func (response CreateAcl403JSONResponse) VisitCreateAclResponse(w http.ResponseWriter) error
type CreateAcl404JSONResponse ¶
type CreateAcl404JSONResponse struct{ NotFoundJSONResponse }
func (CreateAcl404JSONResponse) VisitCreateAclResponse ¶
func (response CreateAcl404JSONResponse) VisitCreateAclResponse(w http.ResponseWriter) error
type CreateAcl502JSONResponse ¶
type CreateAcl502JSONResponse struct{ BadGatewayJSONResponse }
func (CreateAcl502JSONResponse) VisitCreateAclResponse ¶
func (response CreateAcl502JSONResponse) VisitCreateAclResponse(w http.ResponseWriter) error
type CreateAclJSONRequestBody ¶
type CreateAclJSONRequestBody = ACLEntry
CreateAclJSONRequestBody defines body for CreateAcl for application/json ContentType.
type CreateAclParams ¶
type CreateAclParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
CreateAclParams defines parameters for CreateAcl.
type CreateAclRequestObject ¶
type CreateAclRequestObject struct {
Cluster Cluster `json:"cluster"`
Params CreateAclParams
Body *CreateAclJSONRequestBody
}
type CreateAclResponseObject ¶
type CreateAclResponseObject interface {
VisitCreateAclResponse(w http.ResponseWriter) error
}
type CreateGroup200JSONResponse ¶
type CreateGroup200JSONResponse ResetOffsetsResponse
func (CreateGroup200JSONResponse) VisitCreateGroupResponse ¶
func (response CreateGroup200JSONResponse) VisitCreateGroupResponse(w http.ResponseWriter) error
type CreateGroup400JSONResponse ¶
type CreateGroup400JSONResponse struct{ BadRequestJSONResponse }
func (CreateGroup400JSONResponse) VisitCreateGroupResponse ¶
func (response CreateGroup400JSONResponse) VisitCreateGroupResponse(w http.ResponseWriter) error
type CreateGroup401JSONResponse ¶
func (CreateGroup401JSONResponse) VisitCreateGroupResponse ¶
func (response CreateGroup401JSONResponse) VisitCreateGroupResponse(w http.ResponseWriter) error
type CreateGroup403JSONResponse ¶
type CreateGroup403JSONResponse struct{ ForbiddenJSONResponse }
func (CreateGroup403JSONResponse) VisitCreateGroupResponse ¶
func (response CreateGroup403JSONResponse) VisitCreateGroupResponse(w http.ResponseWriter) error
type CreateGroup404JSONResponse ¶
type CreateGroup404JSONResponse struct{ NotFoundJSONResponse }
func (CreateGroup404JSONResponse) VisitCreateGroupResponse ¶
func (response CreateGroup404JSONResponse) VisitCreateGroupResponse(w http.ResponseWriter) error
type CreateGroup409JSONResponse ¶
type CreateGroup409JSONResponse Error
func (CreateGroup409JSONResponse) VisitCreateGroupResponse ¶
func (response CreateGroup409JSONResponse) VisitCreateGroupResponse(w http.ResponseWriter) error
type CreateGroup502JSONResponse ¶
type CreateGroup502JSONResponse struct{ BadGatewayJSONResponse }
func (CreateGroup502JSONResponse) VisitCreateGroupResponse ¶
func (response CreateGroup502JSONResponse) VisitCreateGroupResponse(w http.ResponseWriter) error
type CreateGroupJSONRequestBody ¶
type CreateGroupJSONRequestBody = CreateGroupRequest
CreateGroupJSONRequestBody defines body for CreateGroup for application/json ContentType.
type CreateGroupParams ¶
type CreateGroupParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
CreateGroupParams defines parameters for CreateGroup.
type CreateGroupRequest ¶
type CreateGroupRequest = kafka.CreateGroupRequest
CreateGroupRequest defines model for CreateGroupRequest.
type CreateGroupRequestObject ¶
type CreateGroupRequestObject struct {
Cluster Cluster `json:"cluster"`
Params CreateGroupParams
Body *CreateGroupJSONRequestBody
}
type CreateGroupResponseObject ¶
type CreateGroupResponseObject interface {
VisitCreateGroupResponse(w http.ResponseWriter) error
}
type CreateTopic201JSONResponse ¶
type CreateTopic201JSONResponse CreatedResponse
func (CreateTopic201JSONResponse) VisitCreateTopicResponse ¶
func (response CreateTopic201JSONResponse) VisitCreateTopicResponse(w http.ResponseWriter) error
type CreateTopic400JSONResponse ¶
type CreateTopic400JSONResponse struct{ BadRequestJSONResponse }
func (CreateTopic400JSONResponse) VisitCreateTopicResponse ¶
func (response CreateTopic400JSONResponse) VisitCreateTopicResponse(w http.ResponseWriter) error
type CreateTopic401JSONResponse ¶
func (CreateTopic401JSONResponse) VisitCreateTopicResponse ¶
func (response CreateTopic401JSONResponse) VisitCreateTopicResponse(w http.ResponseWriter) error
type CreateTopic403JSONResponse ¶
type CreateTopic403JSONResponse struct{ ForbiddenJSONResponse }
func (CreateTopic403JSONResponse) VisitCreateTopicResponse ¶
func (response CreateTopic403JSONResponse) VisitCreateTopicResponse(w http.ResponseWriter) error
type CreateTopic404JSONResponse ¶
type CreateTopic404JSONResponse struct{ NotFoundJSONResponse }
func (CreateTopic404JSONResponse) VisitCreateTopicResponse ¶
func (response CreateTopic404JSONResponse) VisitCreateTopicResponse(w http.ResponseWriter) error
type CreateTopic502JSONResponse ¶
type CreateTopic502JSONResponse struct{ BadGatewayJSONResponse }
func (CreateTopic502JSONResponse) VisitCreateTopicResponse ¶
func (response CreateTopic502JSONResponse) VisitCreateTopicResponse(w http.ResponseWriter) error
type CreateTopicJSONRequestBody ¶
type CreateTopicJSONRequestBody = CreateTopicRequest
CreateTopicJSONRequestBody defines body for CreateTopic for application/json ContentType.
type CreateTopicParams ¶
type CreateTopicParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
CreateTopicParams defines parameters for CreateTopic.
type CreateTopicRequest ¶
type CreateTopicRequest = kafka.CreateTopicRequest
CreateTopicRequest defines model for CreateTopicRequest.
type CreateTopicRequestObject ¶
type CreateTopicRequestObject struct {
Cluster Cluster `json:"cluster"`
Params CreateTopicParams
Body *CreateTopicJSONRequestBody
}
type CreateTopicResponseObject ¶
type CreateTopicResponseObject interface {
VisitCreateTopicResponse(w http.ResponseWriter) error
}
type CreatedResponse ¶
type CreatedResponse struct {
Created string `json:"created"`
}
CreatedResponse defines model for CreatedResponse.
type DeleteACLResponse ¶
type DeleteACLResponse struct {
// Deleted Number of deleted ACL bindings.
Deleted int `json:"deleted"`
Ok bool `json:"ok"`
}
DeleteACLResponse defines model for DeleteACLResponse.
type DeleteAcl200JSONResponse ¶
type DeleteAcl200JSONResponse DeleteACLResponse
func (DeleteAcl200JSONResponse) VisitDeleteAclResponse ¶
func (response DeleteAcl200JSONResponse) VisitDeleteAclResponse(w http.ResponseWriter) error
type DeleteAcl400JSONResponse ¶
type DeleteAcl400JSONResponse struct{ BadRequestJSONResponse }
func (DeleteAcl400JSONResponse) VisitDeleteAclResponse ¶
func (response DeleteAcl400JSONResponse) VisitDeleteAclResponse(w http.ResponseWriter) error
type DeleteAcl401JSONResponse ¶
func (DeleteAcl401JSONResponse) VisitDeleteAclResponse ¶
func (response DeleteAcl401JSONResponse) VisitDeleteAclResponse(w http.ResponseWriter) error
type DeleteAcl403JSONResponse ¶
type DeleteAcl403JSONResponse struct{ ForbiddenJSONResponse }
func (DeleteAcl403JSONResponse) VisitDeleteAclResponse ¶
func (response DeleteAcl403JSONResponse) VisitDeleteAclResponse(w http.ResponseWriter) error
type DeleteAcl404JSONResponse ¶
type DeleteAcl404JSONResponse struct{ NotFoundJSONResponse }
func (DeleteAcl404JSONResponse) VisitDeleteAclResponse ¶
func (response DeleteAcl404JSONResponse) VisitDeleteAclResponse(w http.ResponseWriter) error
type DeleteAcl502JSONResponse ¶
type DeleteAcl502JSONResponse struct{ BadGatewayJSONResponse }
func (DeleteAcl502JSONResponse) VisitDeleteAclResponse ¶
func (response DeleteAcl502JSONResponse) VisitDeleteAclResponse(w http.ResponseWriter) error
type DeleteAclJSONRequestBody ¶
type DeleteAclJSONRequestBody = ACLEntry
DeleteAclJSONRequestBody defines body for DeleteAcl for application/json ContentType.
type DeleteAclParams ¶
type DeleteAclParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
DeleteAclParams defines parameters for DeleteAcl.
type DeleteAclRequestObject ¶
type DeleteAclRequestObject struct {
Cluster Cluster `json:"cluster"`
Params DeleteAclParams
Body *DeleteAclJSONRequestBody
}
type DeleteAclResponseObject ¶
type DeleteAclResponseObject interface {
VisitDeleteAclResponse(w http.ResponseWriter) error
}
type DeleteGroup200JSONResponse ¶
type DeleteGroup200JSONResponse DeletedNameResponse
func (DeleteGroup200JSONResponse) VisitDeleteGroupResponse ¶
func (response DeleteGroup200JSONResponse) VisitDeleteGroupResponse(w http.ResponseWriter) error
type DeleteGroup400JSONResponse ¶
type DeleteGroup400JSONResponse struct{ BadRequestJSONResponse }
func (DeleteGroup400JSONResponse) VisitDeleteGroupResponse ¶
func (response DeleteGroup400JSONResponse) VisitDeleteGroupResponse(w http.ResponseWriter) error
type DeleteGroup401JSONResponse ¶
func (DeleteGroup401JSONResponse) VisitDeleteGroupResponse ¶
func (response DeleteGroup401JSONResponse) VisitDeleteGroupResponse(w http.ResponseWriter) error
type DeleteGroup403JSONResponse ¶
type DeleteGroup403JSONResponse struct{ ForbiddenJSONResponse }
func (DeleteGroup403JSONResponse) VisitDeleteGroupResponse ¶
func (response DeleteGroup403JSONResponse) VisitDeleteGroupResponse(w http.ResponseWriter) error
type DeleteGroup404JSONResponse ¶
type DeleteGroup404JSONResponse struct{ NotFoundJSONResponse }
func (DeleteGroup404JSONResponse) VisitDeleteGroupResponse ¶
func (response DeleteGroup404JSONResponse) VisitDeleteGroupResponse(w http.ResponseWriter) error
type DeleteGroup502JSONResponse ¶
type DeleteGroup502JSONResponse struct{ BadGatewayJSONResponse }
func (DeleteGroup502JSONResponse) VisitDeleteGroupResponse ¶
func (response DeleteGroup502JSONResponse) VisitDeleteGroupResponse(w http.ResponseWriter) error
type DeleteGroupParams ¶
type DeleteGroupParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
DeleteGroupParams defines parameters for DeleteGroup.
type DeleteGroupRequestObject ¶
type DeleteGroupRequestObject struct {
Cluster Cluster `json:"cluster"`
Group Group `json:"group"`
Params DeleteGroupParams
}
type DeleteGroupResponseObject ¶
type DeleteGroupResponseObject interface {
VisitDeleteGroupResponse(w http.ResponseWriter) error
}
type DeleteRecords200JSONResponse ¶
type DeleteRecords200JSONResponse DeleteRecordsResponse
func (DeleteRecords200JSONResponse) VisitDeleteRecordsResponse ¶
func (response DeleteRecords200JSONResponse) VisitDeleteRecordsResponse(w http.ResponseWriter) error
type DeleteRecords400JSONResponse ¶
type DeleteRecords400JSONResponse struct{ BadRequestJSONResponse }
func (DeleteRecords400JSONResponse) VisitDeleteRecordsResponse ¶
func (response DeleteRecords400JSONResponse) VisitDeleteRecordsResponse(w http.ResponseWriter) error
type DeleteRecords401JSONResponse ¶
func (DeleteRecords401JSONResponse) VisitDeleteRecordsResponse ¶
func (response DeleteRecords401JSONResponse) VisitDeleteRecordsResponse(w http.ResponseWriter) error
type DeleteRecords403JSONResponse ¶
type DeleteRecords403JSONResponse struct{ ForbiddenJSONResponse }
func (DeleteRecords403JSONResponse) VisitDeleteRecordsResponse ¶
func (response DeleteRecords403JSONResponse) VisitDeleteRecordsResponse(w http.ResponseWriter) error
type DeleteRecords404JSONResponse ¶
type DeleteRecords404JSONResponse struct{ NotFoundJSONResponse }
func (DeleteRecords404JSONResponse) VisitDeleteRecordsResponse ¶
func (response DeleteRecords404JSONResponse) VisitDeleteRecordsResponse(w http.ResponseWriter) error
type DeleteRecords428JSONResponse ¶
type DeleteRecords428JSONResponse struct {
ProdConfirmationRequiredJSONResponse
}
func (DeleteRecords428JSONResponse) VisitDeleteRecordsResponse ¶
func (response DeleteRecords428JSONResponse) VisitDeleteRecordsResponse(w http.ResponseWriter) error
type DeleteRecords502JSONResponse ¶
type DeleteRecords502JSONResponse struct{ BadGatewayJSONResponse }
func (DeleteRecords502JSONResponse) VisitDeleteRecordsResponse ¶
func (response DeleteRecords502JSONResponse) VisitDeleteRecordsResponse(w http.ResponseWriter) error
type DeleteRecordsJSONRequestBody ¶
type DeleteRecordsJSONRequestBody = DeleteRecordsRequest
DeleteRecordsJSONRequestBody defines body for DeleteRecords for application/json ContentType.
type DeleteRecordsParams ¶
type DeleteRecordsParams struct {
// XKafkitoConfirmProd Must be `true` when the target cluster is marked `is_prod`; the request is rejected with 428 otherwise. Send only after explicit user confirmation.
XKafkitoConfirmProd *DeleteRecordsParamsXKafkitoConfirmProd `json:"X-Kafkito-Confirm-Prod,omitempty"`
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
DeleteRecordsParams defines parameters for DeleteRecords.
type DeleteRecordsParamsXKafkitoConfirmProd ¶
type DeleteRecordsParamsXKafkitoConfirmProd string
DeleteRecordsParamsXKafkitoConfirmProd defines parameters for DeleteRecords.
const (
DeleteRecordsParamsXKafkitoConfirmProdTrue DeleteRecordsParamsXKafkitoConfirmProd = "true"
)
Defines values for DeleteRecordsParamsXKafkitoConfirmProd.
func (DeleteRecordsParamsXKafkitoConfirmProd) Valid ¶
func (e DeleteRecordsParamsXKafkitoConfirmProd) Valid() bool
Valid indicates whether the value is a known member of the DeleteRecordsParamsXKafkitoConfirmProd enum.
type DeleteRecordsRequest ¶
type DeleteRecordsRequest = kafka.DeleteRecordsRequest
DeleteRecordsRequest defines model for DeleteRecordsRequest.
type DeleteRecordsRequestObject ¶
type DeleteRecordsRequestObject struct {
Cluster Cluster `json:"cluster"`
Topic Topic `json:"topic"`
Params DeleteRecordsParams
Body *DeleteRecordsJSONRequestBody
}
type DeleteRecordsResponse ¶
type DeleteRecordsResponse struct {
Results []DeleteRecordsResult `json:"results"`
}
DeleteRecordsResponse defines model for DeleteRecordsResponse.
type DeleteRecordsResponseObject ¶
type DeleteRecordsResponseObject interface {
VisitDeleteRecordsResponse(w http.ResponseWriter) error
}
type DeleteRecordsResult ¶
type DeleteRecordsResult = kafka.DeleteRecordsResult
DeleteRecordsResult defines model for DeleteRecordsResult.
type DeleteSCRAMUserResponse ¶
type DeleteSCRAMUserResponse struct {
// Deleted Number of mechanisms deleted.
Deleted int `json:"deleted"`
Ok bool `json:"ok"`
User string `json:"user"`
}
DeleteSCRAMUserResponse defines model for DeleteSCRAMUserResponse.
type DeleteScramUser200JSONResponse ¶
type DeleteScramUser200JSONResponse DeleteSCRAMUserResponse
func (DeleteScramUser200JSONResponse) VisitDeleteScramUserResponse ¶
func (response DeleteScramUser200JSONResponse) VisitDeleteScramUserResponse(w http.ResponseWriter) error
type DeleteScramUser400JSONResponse ¶
type DeleteScramUser400JSONResponse struct{ BadRequestJSONResponse }
func (DeleteScramUser400JSONResponse) VisitDeleteScramUserResponse ¶
func (response DeleteScramUser400JSONResponse) VisitDeleteScramUserResponse(w http.ResponseWriter) error
type DeleteScramUser401JSONResponse ¶
func (DeleteScramUser401JSONResponse) VisitDeleteScramUserResponse ¶
func (response DeleteScramUser401JSONResponse) VisitDeleteScramUserResponse(w http.ResponseWriter) error
type DeleteScramUser403JSONResponse ¶
type DeleteScramUser403JSONResponse struct{ ForbiddenJSONResponse }
func (DeleteScramUser403JSONResponse) VisitDeleteScramUserResponse ¶
func (response DeleteScramUser403JSONResponse) VisitDeleteScramUserResponse(w http.ResponseWriter) error
type DeleteScramUser404JSONResponse ¶
type DeleteScramUser404JSONResponse struct{ NotFoundJSONResponse }
func (DeleteScramUser404JSONResponse) VisitDeleteScramUserResponse ¶
func (response DeleteScramUser404JSONResponse) VisitDeleteScramUserResponse(w http.ResponseWriter) error
type DeleteScramUser502JSONResponse ¶
type DeleteScramUser502JSONResponse struct{ BadGatewayJSONResponse }
func (DeleteScramUser502JSONResponse) VisitDeleteScramUserResponse ¶
func (response DeleteScramUser502JSONResponse) VisitDeleteScramUserResponse(w http.ResponseWriter) error
type DeleteScramUserParams ¶
type DeleteScramUserParams struct {
// Mechanism Mechanism to delete. Omitted = both mechanisms are tried.
Mechanism *DeleteScramUserParamsMechanism `form:"mechanism,omitempty" json:"mechanism,omitempty"`
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
DeleteScramUserParams defines parameters for DeleteScramUser.
type DeleteScramUserParamsMechanism ¶
type DeleteScramUserParamsMechanism string
DeleteScramUserParamsMechanism defines parameters for DeleteScramUser.
const ( DeleteScramUserParamsMechanismSCRAMSHA256 DeleteScramUserParamsMechanism = "SCRAM-SHA-256" DeleteScramUserParamsMechanismSCRAMSHA512 DeleteScramUserParamsMechanism = "SCRAM-SHA-512" )
Defines values for DeleteScramUserParamsMechanism.
func (DeleteScramUserParamsMechanism) Valid ¶
func (e DeleteScramUserParamsMechanism) Valid() bool
Valid indicates whether the value is a known member of the DeleteScramUserParamsMechanism enum.
type DeleteScramUserRequestObject ¶
type DeleteScramUserRequestObject struct {
Cluster Cluster `json:"cluster"`
User string `json:"user"`
Params DeleteScramUserParams
}
type DeleteScramUserResponseObject ¶
type DeleteScramUserResponseObject interface {
VisitDeleteScramUserResponse(w http.ResponseWriter) error
}
type DeleteSubject200JSONResponse ¶
type DeleteSubject200JSONResponse DeleteSubjectResponse
func (DeleteSubject200JSONResponse) VisitDeleteSubjectResponse ¶
func (response DeleteSubject200JSONResponse) VisitDeleteSubjectResponse(w http.ResponseWriter) error
type DeleteSubject400JSONResponse ¶
type DeleteSubject400JSONResponse struct{ BadRequestJSONResponse }
func (DeleteSubject400JSONResponse) VisitDeleteSubjectResponse ¶
func (response DeleteSubject400JSONResponse) VisitDeleteSubjectResponse(w http.ResponseWriter) error
type DeleteSubject401JSONResponse ¶
func (DeleteSubject401JSONResponse) VisitDeleteSubjectResponse ¶
func (response DeleteSubject401JSONResponse) VisitDeleteSubjectResponse(w http.ResponseWriter) error
type DeleteSubject403JSONResponse ¶
type DeleteSubject403JSONResponse struct{ ForbiddenJSONResponse }
func (DeleteSubject403JSONResponse) VisitDeleteSubjectResponse ¶
func (response DeleteSubject403JSONResponse) VisitDeleteSubjectResponse(w http.ResponseWriter) error
type DeleteSubject404JSONResponse ¶
type DeleteSubject404JSONResponse struct{ NotFoundJSONResponse }
func (DeleteSubject404JSONResponse) VisitDeleteSubjectResponse ¶
func (response DeleteSubject404JSONResponse) VisitDeleteSubjectResponse(w http.ResponseWriter) error
type DeleteSubject502JSONResponse ¶
type DeleteSubject502JSONResponse struct{ BadGatewayJSONResponse }
func (DeleteSubject502JSONResponse) VisitDeleteSubjectResponse ¶
func (response DeleteSubject502JSONResponse) VisitDeleteSubjectResponse(w http.ResponseWriter) error
type DeleteSubjectParams ¶
type DeleteSubjectParams struct {
// Permanent `true` performs a hard delete. Only `true` and `false` are accepted.
Permanent *bool `form:"permanent,omitempty" json:"permanent,omitempty"`
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
DeleteSubjectParams defines parameters for DeleteSubject.
type DeleteSubjectRequestObject ¶
type DeleteSubjectRequestObject struct {
Cluster Cluster `json:"cluster"`
Subject Subject `json:"subject"`
Params DeleteSubjectParams
}
type DeleteSubjectResponse ¶
type DeleteSubjectResponse struct {
Deleted string `json:"deleted"`
Permanent bool `json:"permanent"`
Versions []int `json:"versions"`
}
DeleteSubjectResponse defines model for DeleteSubjectResponse.
type DeleteSubjectResponseObject ¶
type DeleteSubjectResponseObject interface {
VisitDeleteSubjectResponse(w http.ResponseWriter) error
}
type DeleteTopic200JSONResponse ¶
type DeleteTopic200JSONResponse DeletedNameResponse
func (DeleteTopic200JSONResponse) VisitDeleteTopicResponse ¶
func (response DeleteTopic200JSONResponse) VisitDeleteTopicResponse(w http.ResponseWriter) error
type DeleteTopic400JSONResponse ¶
type DeleteTopic400JSONResponse struct{ BadRequestJSONResponse }
func (DeleteTopic400JSONResponse) VisitDeleteTopicResponse ¶
func (response DeleteTopic400JSONResponse) VisitDeleteTopicResponse(w http.ResponseWriter) error
type DeleteTopic401JSONResponse ¶
func (DeleteTopic401JSONResponse) VisitDeleteTopicResponse ¶
func (response DeleteTopic401JSONResponse) VisitDeleteTopicResponse(w http.ResponseWriter) error
type DeleteTopic403JSONResponse ¶
type DeleteTopic403JSONResponse struct{ ForbiddenJSONResponse }
func (DeleteTopic403JSONResponse) VisitDeleteTopicResponse ¶
func (response DeleteTopic403JSONResponse) VisitDeleteTopicResponse(w http.ResponseWriter) error
type DeleteTopic404JSONResponse ¶
type DeleteTopic404JSONResponse struct{ NotFoundJSONResponse }
func (DeleteTopic404JSONResponse) VisitDeleteTopicResponse ¶
func (response DeleteTopic404JSONResponse) VisitDeleteTopicResponse(w http.ResponseWriter) error
type DeleteTopic428JSONResponse ¶
type DeleteTopic428JSONResponse struct {
ProdConfirmationRequiredJSONResponse
}
func (DeleteTopic428JSONResponse) VisitDeleteTopicResponse ¶
func (response DeleteTopic428JSONResponse) VisitDeleteTopicResponse(w http.ResponseWriter) error
type DeleteTopic502JSONResponse ¶
type DeleteTopic502JSONResponse struct{ BadGatewayJSONResponse }
func (DeleteTopic502JSONResponse) VisitDeleteTopicResponse ¶
func (response DeleteTopic502JSONResponse) VisitDeleteTopicResponse(w http.ResponseWriter) error
type DeleteTopicParams ¶
type DeleteTopicParams struct {
// XKafkitoConfirmProd Must be `true` when the target cluster is marked `is_prod`; the request is rejected with 428 otherwise. Send only after explicit user confirmation.
XKafkitoConfirmProd *DeleteTopicParamsXKafkitoConfirmProd `json:"X-Kafkito-Confirm-Prod,omitempty"`
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
DeleteTopicParams defines parameters for DeleteTopic.
type DeleteTopicParamsXKafkitoConfirmProd ¶
type DeleteTopicParamsXKafkitoConfirmProd string
DeleteTopicParamsXKafkitoConfirmProd defines parameters for DeleteTopic.
const (
DeleteTopicParamsXKafkitoConfirmProdTrue DeleteTopicParamsXKafkitoConfirmProd = "true"
)
Defines values for DeleteTopicParamsXKafkitoConfirmProd.
func (DeleteTopicParamsXKafkitoConfirmProd) Valid ¶
func (e DeleteTopicParamsXKafkitoConfirmProd) Valid() bool
Valid indicates whether the value is a known member of the DeleteTopicParamsXKafkitoConfirmProd enum.
type DeleteTopicRequestObject ¶
type DeleteTopicRequestObject struct {
Cluster Cluster `json:"cluster"`
Topic Topic `json:"topic"`
Params DeleteTopicParams
}
type DeleteTopicResponseObject ¶
type DeleteTopicResponseObject interface {
VisitDeleteTopicResponse(w http.ResponseWriter) error
}
type DeletedNameResponse ¶
type DeletedNameResponse struct {
Deleted string `json:"deleted"`
}
DeletedNameResponse defines model for DeletedNameResponse.
type DescribeGroup200JSONResponse ¶
type DescribeGroup200JSONResponse GroupDetail
func (DescribeGroup200JSONResponse) VisitDescribeGroupResponse ¶
func (response DescribeGroup200JSONResponse) VisitDescribeGroupResponse(w http.ResponseWriter) error
type DescribeGroup400JSONResponse ¶
type DescribeGroup400JSONResponse struct{ BadRequestJSONResponse }
func (DescribeGroup400JSONResponse) VisitDescribeGroupResponse ¶
func (response DescribeGroup400JSONResponse) VisitDescribeGroupResponse(w http.ResponseWriter) error
type DescribeGroup401JSONResponse ¶
func (DescribeGroup401JSONResponse) VisitDescribeGroupResponse ¶
func (response DescribeGroup401JSONResponse) VisitDescribeGroupResponse(w http.ResponseWriter) error
type DescribeGroup403JSONResponse ¶
type DescribeGroup403JSONResponse struct{ ForbiddenJSONResponse }
func (DescribeGroup403JSONResponse) VisitDescribeGroupResponse ¶
func (response DescribeGroup403JSONResponse) VisitDescribeGroupResponse(w http.ResponseWriter) error
type DescribeGroup404JSONResponse ¶
type DescribeGroup404JSONResponse struct{ NotFoundJSONResponse }
func (DescribeGroup404JSONResponse) VisitDescribeGroupResponse ¶
func (response DescribeGroup404JSONResponse) VisitDescribeGroupResponse(w http.ResponseWriter) error
type DescribeGroup502JSONResponse ¶
type DescribeGroup502JSONResponse struct{ BadGatewayJSONResponse }
func (DescribeGroup502JSONResponse) VisitDescribeGroupResponse ¶
func (response DescribeGroup502JSONResponse) VisitDescribeGroupResponse(w http.ResponseWriter) error
type DescribeGroupParams ¶
type DescribeGroupParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
DescribeGroupParams defines parameters for DescribeGroup.
type DescribeGroupRequestObject ¶
type DescribeGroupRequestObject struct {
Cluster Cluster `json:"cluster"`
Group Group `json:"group"`
Params DescribeGroupParams
}
type DescribeGroupResponseObject ¶
type DescribeGroupResponseObject interface {
VisitDescribeGroupResponse(w http.ResponseWriter) error
}
type DescribeTopic200JSONResponse ¶
type DescribeTopic200JSONResponse DescribeTopicResponse
func (DescribeTopic200JSONResponse) VisitDescribeTopicResponse ¶
func (response DescribeTopic200JSONResponse) VisitDescribeTopicResponse(w http.ResponseWriter) error
type DescribeTopic400JSONResponse ¶
type DescribeTopic400JSONResponse struct{ BadRequestJSONResponse }
func (DescribeTopic400JSONResponse) VisitDescribeTopicResponse ¶
func (response DescribeTopic400JSONResponse) VisitDescribeTopicResponse(w http.ResponseWriter) error
type DescribeTopic401JSONResponse ¶
func (DescribeTopic401JSONResponse) VisitDescribeTopicResponse ¶
func (response DescribeTopic401JSONResponse) VisitDescribeTopicResponse(w http.ResponseWriter) error
type DescribeTopic403JSONResponse ¶
type DescribeTopic403JSONResponse struct{ ForbiddenJSONResponse }
func (DescribeTopic403JSONResponse) VisitDescribeTopicResponse ¶
func (response DescribeTopic403JSONResponse) VisitDescribeTopicResponse(w http.ResponseWriter) error
type DescribeTopic404JSONResponse ¶
type DescribeTopic404JSONResponse struct{ NotFoundJSONResponse }
func (DescribeTopic404JSONResponse) VisitDescribeTopicResponse ¶
func (response DescribeTopic404JSONResponse) VisitDescribeTopicResponse(w http.ResponseWriter) error
type DescribeTopic502JSONResponse ¶
type DescribeTopic502JSONResponse struct{ BadGatewayJSONResponse }
func (DescribeTopic502JSONResponse) VisitDescribeTopicResponse ¶
func (response DescribeTopic502JSONResponse) VisitDescribeTopicResponse(w http.ResponseWriter) error
type DescribeTopicParams ¶
type DescribeTopicParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
DescribeTopicParams defines parameters for DescribeTopic.
type DescribeTopicRequestObject ¶
type DescribeTopicRequestObject struct {
Cluster Cluster `json:"cluster"`
Topic Topic `json:"topic"`
Params DescribeTopicParams
}
type DescribeTopicResponse ¶
type DescribeTopicResponse struct {
Cluster string `json:"cluster"`
Topic TopicDetail `json:"topic"`
}
DescribeTopicResponse defines model for DescribeTopicResponse.
type DescribeTopicResponseObject ¶
type DescribeTopicResponseObject interface {
VisitDescribeTopicResponse(w http.ResponseWriter) error
}
type DownloadMessageRaw200ApplicationoctetStreamResponse ¶
type DownloadMessageRaw200ApplicationoctetStreamResponse struct {
Body io.Reader
Headers DownloadMessageRaw200ResponseHeaders
ContentLength int64
}
func (DownloadMessageRaw200ApplicationoctetStreamResponse) VisitDownloadMessageRawResponse ¶
func (response DownloadMessageRaw200ApplicationoctetStreamResponse) VisitDownloadMessageRawResponse(w http.ResponseWriter) error
type DownloadMessageRaw200ApplicationxmlResponse ¶ added in v1.3.0
type DownloadMessageRaw200ApplicationxmlResponse struct {
Body io.Reader
Headers DownloadMessageRaw200ResponseHeaders
ContentLength int64
}
func (DownloadMessageRaw200ApplicationxmlResponse) VisitDownloadMessageRawResponse ¶ added in v1.3.0
func (response DownloadMessageRaw200ApplicationxmlResponse) VisitDownloadMessageRawResponse(w http.ResponseWriter) error
type DownloadMessageRaw200JSONResponse ¶
type DownloadMessageRaw200JSONResponse struct {
Body openapi_types.File
Headers DownloadMessageRaw200ResponseHeaders
}
func (DownloadMessageRaw200JSONResponse) VisitDownloadMessageRawResponse ¶
func (response DownloadMessageRaw200JSONResponse) VisitDownloadMessageRawResponse(w http.ResponseWriter) error
type DownloadMessageRaw200TextResponse ¶
type DownloadMessageRaw200TextResponse struct {
Body openapi_types.File
Headers DownloadMessageRaw200ResponseHeaders
}
func (DownloadMessageRaw200TextResponse) VisitDownloadMessageRawResponse ¶
func (response DownloadMessageRaw200TextResponse) VisitDownloadMessageRawResponse(w http.ResponseWriter) error
type DownloadMessageRaw400JSONResponse ¶
type DownloadMessageRaw400JSONResponse struct{ BadRequestJSONResponse }
func (DownloadMessageRaw400JSONResponse) VisitDownloadMessageRawResponse ¶
func (response DownloadMessageRaw400JSONResponse) VisitDownloadMessageRawResponse(w http.ResponseWriter) error
type DownloadMessageRaw401JSONResponse ¶
func (DownloadMessageRaw401JSONResponse) VisitDownloadMessageRawResponse ¶
func (response DownloadMessageRaw401JSONResponse) VisitDownloadMessageRawResponse(w http.ResponseWriter) error
type DownloadMessageRaw403JSONResponse ¶
type DownloadMessageRaw403JSONResponse Error
func (DownloadMessageRaw403JSONResponse) VisitDownloadMessageRawResponse ¶
func (response DownloadMessageRaw403JSONResponse) VisitDownloadMessageRawResponse(w http.ResponseWriter) error
type DownloadMessageRaw404JSONResponse ¶
type DownloadMessageRaw404JSONResponse struct{ NotFoundJSONResponse }
func (DownloadMessageRaw404JSONResponse) VisitDownloadMessageRawResponse ¶
func (response DownloadMessageRaw404JSONResponse) VisitDownloadMessageRawResponse(w http.ResponseWriter) error
type DownloadMessageRaw413JSONResponse ¶
type DownloadMessageRaw413JSONResponse struct{ PayloadTooLargeJSONResponse }
func (DownloadMessageRaw413JSONResponse) VisitDownloadMessageRawResponse ¶
func (response DownloadMessageRaw413JSONResponse) VisitDownloadMessageRawResponse(w http.ResponseWriter) error
type DownloadMessageRaw502JSONResponse ¶
type DownloadMessageRaw502JSONResponse struct{ BadGatewayJSONResponse }
func (DownloadMessageRaw502JSONResponse) VisitDownloadMessageRawResponse ¶
func (response DownloadMessageRaw502JSONResponse) VisitDownloadMessageRawResponse(w http.ResponseWriter) error
type DownloadMessageRawParams ¶
type DownloadMessageRawParams struct {
// Decoded `false` serves the value bytes as stored in Kafka instead of the Schema Registry decoded JSON. Only `true` and `false` are accepted.
Decoded *bool `form:"decoded,omitempty" json:"decoded,omitempty"`
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
DownloadMessageRawParams defines parameters for DownloadMessageRaw.
type DownloadMessageRawRequestObject ¶
type DownloadMessageRawRequestObject struct {
Cluster Cluster `json:"cluster"`
Topic Topic `json:"topic"`
Partition int32 `json:"partition"`
Offset int64 `json:"offset"`
Params DownloadMessageRawParams
}
type DownloadMessageRawResponseObject ¶
type DownloadMessageRawResponseObject interface {
VisitDownloadMessageRawResponse(w http.ResponseWriter) error
}
type Error ¶
type Error struct {
// Action RBAC-denied action (403 only).
Action *string `json:"action,omitempty"`
// Code Machine-readable code where one exists, e.g. `kafka_upstream`, `private_cluster_address_blocked`, `private_clusters_disabled`, `private_clusters_forbidden`, `plain_without_tls`, `production_confirmation_required`, `copy_concurrency_limit`, `rate_limited`, `kafka_message_too_large`, `kafka_not_authorized`, `rbac_denied`, `topic_consumers_timeout`, `value_masked`, `invalid_request` (the request does not match this document; `error` names the parameter or body field and the violated rule, never the submitted value).
Code *string `json:"code,omitempty"`
// Error Human-readable message (`unauthorized`, `forbidden`, `not found`, ...).
Error string `json:"error"`
// Message Detail for 401 responses from the auth middleware.
Message *string `json:"message,omitempty"`
// Resource RBAC-denied resource as `<type>:<name>` (403 only).
Resource *string `json:"resource,omitempty"`
}
Error Error body emitted by all JSON error paths.
type ForbiddenJSONResponse ¶
type ForbiddenJSONResponse Error
type GetCapabilities200JSONResponse ¶
type GetCapabilities200JSONResponse CapabilitiesResponse
func (GetCapabilities200JSONResponse) VisitGetCapabilitiesResponse ¶
func (response GetCapabilities200JSONResponse) VisitGetCapabilitiesResponse(w http.ResponseWriter) error
type GetCapabilities400JSONResponse ¶
type GetCapabilities400JSONResponse struct{ BadRequestJSONResponse }
func (GetCapabilities400JSONResponse) VisitGetCapabilitiesResponse ¶
func (response GetCapabilities400JSONResponse) VisitGetCapabilitiesResponse(w http.ResponseWriter) error
type GetCapabilities401JSONResponse ¶
func (GetCapabilities401JSONResponse) VisitGetCapabilitiesResponse ¶
func (response GetCapabilities401JSONResponse) VisitGetCapabilitiesResponse(w http.ResponseWriter) error
type GetCapabilities403JSONResponse ¶ added in v1.3.0
type GetCapabilities403JSONResponse struct{ ForbiddenJSONResponse }
func (GetCapabilities403JSONResponse) VisitGetCapabilitiesResponse ¶ added in v1.3.0
func (response GetCapabilities403JSONResponse) VisitGetCapabilitiesResponse(w http.ResponseWriter) error
type GetCapabilities404JSONResponse ¶
type GetCapabilities404JSONResponse struct{ NotFoundJSONResponse }
func (GetCapabilities404JSONResponse) VisitGetCapabilitiesResponse ¶
func (response GetCapabilities404JSONResponse) VisitGetCapabilitiesResponse(w http.ResponseWriter) error
type GetCapabilities502JSONResponse ¶
type GetCapabilities502JSONResponse struct{ BadGatewayJSONResponse }
func (GetCapabilities502JSONResponse) VisitGetCapabilitiesResponse ¶
func (response GetCapabilities502JSONResponse) VisitGetCapabilitiesResponse(w http.ResponseWriter) error
type GetCapabilitiesParams ¶
type GetCapabilitiesParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
GetCapabilitiesParams defines parameters for GetCapabilities.
type GetCapabilitiesRequestObject ¶
type GetCapabilitiesRequestObject struct {
Cluster Cluster `json:"cluster"`
Params GetCapabilitiesParams
}
type GetCapabilitiesResponseObject ¶
type GetCapabilitiesResponseObject interface {
VisitGetCapabilitiesResponse(w http.ResponseWriter) error
}
type GetHealth200JSONResponse ¶
type GetHealth200JSONResponse HealthResponse
func (GetHealth200JSONResponse) VisitGetHealthResponse ¶
func (response GetHealth200JSONResponse) VisitGetHealthResponse(w http.ResponseWriter) error
type GetHealthRequestObject ¶
type GetHealthRequestObject struct {
}
type GetHealthResponseObject ¶
type GetHealthResponseObject interface {
VisitGetHealthResponse(w http.ResponseWriter) error
}
type GetInfo200JSONResponse ¶
type GetInfo200JSONResponse InfoResponse
func (GetInfo200JSONResponse) VisitGetInfoResponse ¶
func (response GetInfo200JSONResponse) VisitGetInfoResponse(w http.ResponseWriter) error
type GetInfo401JSONResponse ¶
func (GetInfo401JSONResponse) VisitGetInfoResponse ¶
func (response GetInfo401JSONResponse) VisitGetInfoResponse(w http.ResponseWriter) error
type GetInfoRequestObject ¶
type GetInfoRequestObject struct {
}
type GetInfoResponseObject ¶
type GetInfoResponseObject interface {
VisitGetInfoResponse(w http.ResponseWriter) error
}
type GetMe200JSONResponse ¶
type GetMe200JSONResponse MeResponse
func (GetMe200JSONResponse) VisitGetMeResponse ¶
func (response GetMe200JSONResponse) VisitGetMeResponse(w http.ResponseWriter) error
type GetMe401JSONResponse ¶
func (GetMe401JSONResponse) VisitGetMeResponse ¶
func (response GetMe401JSONResponse) VisitGetMeResponse(w http.ResponseWriter) error
type GetMeRequestObject ¶
type GetMeRequestObject struct {
}
type GetMeResponseObject ¶
type GetMeResponseObject interface {
VisitGetMeResponse(w http.ResponseWriter) error
}
type GetMessageTimeline200JSONResponse ¶
type GetMessageTimeline200JSONResponse MessageTimelineResponse
func (GetMessageTimeline200JSONResponse) VisitGetMessageTimelineResponse ¶
func (response GetMessageTimeline200JSONResponse) VisitGetMessageTimelineResponse(w http.ResponseWriter) error
type GetMessageTimeline400JSONResponse ¶
type GetMessageTimeline400JSONResponse struct{ BadRequestJSONResponse }
func (GetMessageTimeline400JSONResponse) VisitGetMessageTimelineResponse ¶
func (response GetMessageTimeline400JSONResponse) VisitGetMessageTimelineResponse(w http.ResponseWriter) error
type GetMessageTimeline401JSONResponse ¶
func (GetMessageTimeline401JSONResponse) VisitGetMessageTimelineResponse ¶
func (response GetMessageTimeline401JSONResponse) VisitGetMessageTimelineResponse(w http.ResponseWriter) error
type GetMessageTimeline403JSONResponse ¶
type GetMessageTimeline403JSONResponse struct{ ForbiddenJSONResponse }
func (GetMessageTimeline403JSONResponse) VisitGetMessageTimelineResponse ¶
func (response GetMessageTimeline403JSONResponse) VisitGetMessageTimelineResponse(w http.ResponseWriter) error
type GetMessageTimeline404JSONResponse ¶
type GetMessageTimeline404JSONResponse struct{ NotFoundJSONResponse }
func (GetMessageTimeline404JSONResponse) VisitGetMessageTimelineResponse ¶
func (response GetMessageTimeline404JSONResponse) VisitGetMessageTimelineResponse(w http.ResponseWriter) error
type GetMessageTimeline502JSONResponse ¶
type GetMessageTimeline502JSONResponse struct{ BadGatewayJSONResponse }
func (GetMessageTimeline502JSONResponse) VisitGetMessageTimelineResponse ¶
func (response GetMessageTimeline502JSONResponse) VisitGetMessageTimelineResponse(w http.ResponseWriter) error
type GetMessageTimelineParams ¶
type GetMessageTimelineParams struct {
// Partition Partition number; -1 = all partitions.
Partition *PartitionQuery `form:"partition,omitempty" json:"partition,omitempty"`
// FromTsMs Inclusive lower timestamp bound in Unix milliseconds.
FromTsMs int64 `form:"from_ts_ms" json:"from_ts_ms"`
// ToTsMs Exclusive upper timestamp bound in Unix milliseconds. Must be greater than `from_ts_ms`.
ToTsMs int64 `form:"to_ts_ms" json:"to_ts_ms"`
// SlotMs Time-slot width in milliseconds (e.g. 3600000 for hourly, 86400000 for daily).
SlotMs int64 `form:"slot_ms" json:"slot_ms"`
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
GetMessageTimelineParams defines parameters for GetMessageTimeline.
type GetMessageTimelineRequestObject ¶
type GetMessageTimelineRequestObject struct {
Cluster Cluster `json:"cluster"`
Topic Topic `json:"topic"`
Params GetMessageTimelineParams
}
type GetMessageTimelineResponseObject ¶
type GetMessageTimelineResponseObject interface {
VisitGetMessageTimelineResponse(w http.ResponseWriter) error
}
type GetOpenApiSpec200ApplicationyamlResponse ¶
func (GetOpenApiSpec200ApplicationyamlResponse) VisitGetOpenApiSpecResponse ¶
func (response GetOpenApiSpec200ApplicationyamlResponse) VisitGetOpenApiSpecResponse(w http.ResponseWriter) error
type GetOpenApiSpec401JSONResponse ¶
func (GetOpenApiSpec401JSONResponse) VisitGetOpenApiSpecResponse ¶
func (response GetOpenApiSpec401JSONResponse) VisitGetOpenApiSpecResponse(w http.ResponseWriter) error
type GetOpenApiSpecRequestObject ¶
type GetOpenApiSpecRequestObject struct {
}
type GetOpenApiSpecResponseObject ¶
type GetOpenApiSpecResponseObject interface {
VisitGetOpenApiSpecResponse(w http.ResponseWriter) error
}
type GetReadiness200JSONResponse ¶
type GetReadiness200JSONResponse ReadinessResponse
func (GetReadiness200JSONResponse) VisitGetReadinessResponse ¶
func (response GetReadiness200JSONResponse) VisitGetReadinessResponse(w http.ResponseWriter) error
type GetReadiness503JSONResponse ¶
type GetReadiness503JSONResponse ReadinessResponse
func (GetReadiness503JSONResponse) VisitGetReadinessResponse ¶
func (response GetReadiness503JSONResponse) VisitGetReadinessResponse(w http.ResponseWriter) error
type GetReadinessRequestObject ¶
type GetReadinessRequestObject struct {
}
type GetReadinessResponseObject ¶
type GetReadinessResponseObject interface {
VisitGetReadinessResponse(w http.ResponseWriter) error
}
type GetSchemaVersion200JSONResponse ¶
type GetSchemaVersion200JSONResponse SchemaVersion
func (GetSchemaVersion200JSONResponse) VisitGetSchemaVersionResponse ¶
func (response GetSchemaVersion200JSONResponse) VisitGetSchemaVersionResponse(w http.ResponseWriter) error
type GetSchemaVersion400JSONResponse ¶
type GetSchemaVersion400JSONResponse struct{ BadRequestJSONResponse }
func (GetSchemaVersion400JSONResponse) VisitGetSchemaVersionResponse ¶
func (response GetSchemaVersion400JSONResponse) VisitGetSchemaVersionResponse(w http.ResponseWriter) error
type GetSchemaVersion401JSONResponse ¶
func (GetSchemaVersion401JSONResponse) VisitGetSchemaVersionResponse ¶
func (response GetSchemaVersion401JSONResponse) VisitGetSchemaVersionResponse(w http.ResponseWriter) error
type GetSchemaVersion403JSONResponse ¶
type GetSchemaVersion403JSONResponse struct{ ForbiddenJSONResponse }
func (GetSchemaVersion403JSONResponse) VisitGetSchemaVersionResponse ¶
func (response GetSchemaVersion403JSONResponse) VisitGetSchemaVersionResponse(w http.ResponseWriter) error
type GetSchemaVersion404JSONResponse ¶
type GetSchemaVersion404JSONResponse struct{ NotFoundJSONResponse }
func (GetSchemaVersion404JSONResponse) VisitGetSchemaVersionResponse ¶
func (response GetSchemaVersion404JSONResponse) VisitGetSchemaVersionResponse(w http.ResponseWriter) error
type GetSchemaVersion502JSONResponse ¶
type GetSchemaVersion502JSONResponse struct{ BadGatewayJSONResponse }
func (GetSchemaVersion502JSONResponse) VisitGetSchemaVersionResponse ¶
func (response GetSchemaVersion502JSONResponse) VisitGetSchemaVersionResponse(w http.ResponseWriter) error
type GetSchemaVersionParams ¶
type GetSchemaVersionParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
GetSchemaVersionParams defines parameters for GetSchemaVersion.
type GetSchemaVersionRequestObject ¶
type GetSchemaVersionRequestObject struct {
Cluster Cluster `json:"cluster"`
Subject Subject `json:"subject"`
Version string `json:"version"`
Params GetSchemaVersionParams
}
type GetSchemaVersionResponseObject ¶
type GetSchemaVersionResponseObject interface {
VisitGetSchemaVersionResponse(w http.ResponseWriter) error
}
type GroupDetail ¶
type GroupDetail = kafka.GroupDetail
GroupDetail GroupInfo fields plus membership and offsets. `members` is the member list here, not the count from GroupInfo.
type GroupMember ¶
type GroupMember struct {
Assignments []MemberAssignment `json:"assignments"`
ClientHost string `json:"client_host"`
ClientId string `json:"client_id"`
// InstanceId Static-membership group.instance.id, if configured.
InstanceId *string `json:"instance_id,omitempty"`
MemberId string `json:"member_id"`
}
GroupMember defines model for GroupMember.
type GroupOffset ¶
type GroupOffset struct {
// AssignedTo Current owner as `<client_id>@<host>`, absent during rebalance.
AssignedTo *string `json:"assigned_to,omitempty"`
Lag int64 `json:"lag"`
LogEnd int64 `json:"log_end"`
Metadata *string `json:"metadata,omitempty"`
Offset int64 `json:"offset"`
Partition int32 `json:"partition"`
Topic string `json:"topic"`
}
GroupOffset defines model for GroupOffset.
type HealthResponse ¶
type HealthResponse struct {
Status HealthResponseStatus `json:"status"`
}
HealthResponse defines model for HealthResponse.
type HealthResponseStatus ¶
type HealthResponseStatus string
HealthResponseStatus defines model for HealthResponse.Status.
const (
HealthResponseStatusOk HealthResponseStatus = "ok"
)
Defines values for HealthResponseStatus.
func (HealthResponseStatus) Valid ¶
func (e HealthResponseStatus) Valid() bool
Valid indicates whether the value is a known member of the HealthResponseStatus enum.
type InfoResponse ¶
InfoResponse defines model for InfoResponse.
type InvalidParamFormatError ¶
func (*InvalidParamFormatError) Error ¶
func (e *InvalidParamFormatError) Error() string
func (*InvalidParamFormatError) Unwrap ¶
func (e *InvalidParamFormatError) Unwrap() error
type ListACLsResponse ¶
ListACLsResponse defines model for ListACLsResponse.
type ListAcls200JSONResponse ¶
type ListAcls200JSONResponse ListACLsResponse
func (ListAcls200JSONResponse) VisitListAclsResponse ¶
func (response ListAcls200JSONResponse) VisitListAclsResponse(w http.ResponseWriter) error
type ListAcls400JSONResponse ¶
type ListAcls400JSONResponse struct{ BadRequestJSONResponse }
func (ListAcls400JSONResponse) VisitListAclsResponse ¶
func (response ListAcls400JSONResponse) VisitListAclsResponse(w http.ResponseWriter) error
type ListAcls401JSONResponse ¶
func (ListAcls401JSONResponse) VisitListAclsResponse ¶
func (response ListAcls401JSONResponse) VisitListAclsResponse(w http.ResponseWriter) error
type ListAcls403JSONResponse ¶
type ListAcls403JSONResponse struct{ ForbiddenJSONResponse }
func (ListAcls403JSONResponse) VisitListAclsResponse ¶
func (response ListAcls403JSONResponse) VisitListAclsResponse(w http.ResponseWriter) error
type ListAcls404JSONResponse ¶
type ListAcls404JSONResponse struct{ NotFoundJSONResponse }
func (ListAcls404JSONResponse) VisitListAclsResponse ¶
func (response ListAcls404JSONResponse) VisitListAclsResponse(w http.ResponseWriter) error
type ListAcls502JSONResponse ¶
type ListAcls502JSONResponse struct{ BadGatewayJSONResponse }
func (ListAcls502JSONResponse) VisitListAclsResponse ¶
func (response ListAcls502JSONResponse) VisitListAclsResponse(w http.ResponseWriter) error
type ListAclsParams ¶
type ListAclsParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
ListAclsParams defines parameters for ListAcls.
type ListAclsRequestObject ¶
type ListAclsRequestObject struct {
Cluster Cluster `json:"cluster"`
Params ListAclsParams
}
type ListAclsResponseObject ¶
type ListAclsResponseObject interface {
VisitListAclsResponse(w http.ResponseWriter) error
}
type ListBrokers200JSONResponse ¶
type ListBrokers200JSONResponse ListBrokersResponse
func (ListBrokers200JSONResponse) VisitListBrokersResponse ¶
func (response ListBrokers200JSONResponse) VisitListBrokersResponse(w http.ResponseWriter) error
type ListBrokers400JSONResponse ¶
type ListBrokers400JSONResponse struct{ BadRequestJSONResponse }
func (ListBrokers400JSONResponse) VisitListBrokersResponse ¶
func (response ListBrokers400JSONResponse) VisitListBrokersResponse(w http.ResponseWriter) error
type ListBrokers401JSONResponse ¶
func (ListBrokers401JSONResponse) VisitListBrokersResponse ¶
func (response ListBrokers401JSONResponse) VisitListBrokersResponse(w http.ResponseWriter) error
type ListBrokers403JSONResponse ¶
type ListBrokers403JSONResponse struct{ ForbiddenJSONResponse }
func (ListBrokers403JSONResponse) VisitListBrokersResponse ¶
func (response ListBrokers403JSONResponse) VisitListBrokersResponse(w http.ResponseWriter) error
type ListBrokers404JSONResponse ¶
type ListBrokers404JSONResponse struct{ NotFoundJSONResponse }
func (ListBrokers404JSONResponse) VisitListBrokersResponse ¶
func (response ListBrokers404JSONResponse) VisitListBrokersResponse(w http.ResponseWriter) error
type ListBrokers502JSONResponse ¶
type ListBrokers502JSONResponse struct{ BadGatewayJSONResponse }
func (ListBrokers502JSONResponse) VisitListBrokersResponse ¶
func (response ListBrokers502JSONResponse) VisitListBrokersResponse(w http.ResponseWriter) error
type ListBrokersParams ¶
type ListBrokersParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
ListBrokersParams defines parameters for ListBrokers.
type ListBrokersRequestObject ¶
type ListBrokersRequestObject struct {
Cluster Cluster `json:"cluster"`
Params ListBrokersParams
}
type ListBrokersResponse ¶
type ListBrokersResponse struct {
Brokers []BrokerInfo `json:"brokers"`
Cluster string `json:"cluster"`
}
ListBrokersResponse defines model for ListBrokersResponse.
type ListBrokersResponseObject ¶
type ListBrokersResponseObject interface {
VisitListBrokersResponse(w http.ResponseWriter) error
}
type ListClusters200JSONResponse ¶
type ListClusters200JSONResponse ListClustersResponse
func (ListClusters200JSONResponse) VisitListClustersResponse ¶
func (response ListClusters200JSONResponse) VisitListClustersResponse(w http.ResponseWriter) error
type ListClusters401JSONResponse ¶
func (ListClusters401JSONResponse) VisitListClustersResponse ¶
func (response ListClusters401JSONResponse) VisitListClustersResponse(w http.ResponseWriter) error
type ListClustersRequestObject ¶
type ListClustersRequestObject struct {
}
type ListClustersResponse ¶
type ListClustersResponse struct {
Clusters []ClusterInfo `json:"clusters"`
}
ListClustersResponse defines model for ListClustersResponse.
type ListClustersResponseObject ¶
type ListClustersResponseObject interface {
VisitListClustersResponse(w http.ResponseWriter) error
}
type ListGroups200JSONResponse ¶
type ListGroups200JSONResponse ListGroupsResponse
func (ListGroups200JSONResponse) VisitListGroupsResponse ¶
func (response ListGroups200JSONResponse) VisitListGroupsResponse(w http.ResponseWriter) error
type ListGroups400JSONResponse ¶
type ListGroups400JSONResponse struct{ BadRequestJSONResponse }
func (ListGroups400JSONResponse) VisitListGroupsResponse ¶
func (response ListGroups400JSONResponse) VisitListGroupsResponse(w http.ResponseWriter) error
type ListGroups401JSONResponse ¶
func (ListGroups401JSONResponse) VisitListGroupsResponse ¶
func (response ListGroups401JSONResponse) VisitListGroupsResponse(w http.ResponseWriter) error
type ListGroups403JSONResponse ¶
type ListGroups403JSONResponse struct{ ForbiddenJSONResponse }
func (ListGroups403JSONResponse) VisitListGroupsResponse ¶
func (response ListGroups403JSONResponse) VisitListGroupsResponse(w http.ResponseWriter) error
type ListGroups404JSONResponse ¶
type ListGroups404JSONResponse struct{ NotFoundJSONResponse }
func (ListGroups404JSONResponse) VisitListGroupsResponse ¶
func (response ListGroups404JSONResponse) VisitListGroupsResponse(w http.ResponseWriter) error
type ListGroups502JSONResponse ¶
type ListGroups502JSONResponse struct{ BadGatewayJSONResponse }
func (ListGroups502JSONResponse) VisitListGroupsResponse ¶
func (response ListGroups502JSONResponse) VisitListGroupsResponse(w http.ResponseWriter) error
type ListGroupsParams ¶
type ListGroupsParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
ListGroupsParams defines parameters for ListGroups.
type ListGroupsRequestObject ¶
type ListGroupsRequestObject struct {
Cluster Cluster `json:"cluster"`
Params ListGroupsParams
}
type ListGroupsResponse ¶
type ListGroupsResponse struct {
Cluster string `json:"cluster"`
Groups []GroupInfo `json:"groups"`
}
ListGroupsResponse defines model for ListGroupsResponse.
type ListGroupsResponseObject ¶
type ListGroupsResponseObject interface {
VisitListGroupsResponse(w http.ResponseWriter) error
}
type ListSCRAMUsersResponse ¶
type ListSCRAMUsersResponse struct {
Cluster string `json:"cluster"`
Users []SCRAMUser `json:"users"`
}
ListSCRAMUsersResponse defines model for ListSCRAMUsersResponse.
type ListSchemaVersions200JSONResponse ¶
type ListSchemaVersions200JSONResponse ListSchemaVersionsResponse
func (ListSchemaVersions200JSONResponse) VisitListSchemaVersionsResponse ¶
func (response ListSchemaVersions200JSONResponse) VisitListSchemaVersionsResponse(w http.ResponseWriter) error
type ListSchemaVersions400JSONResponse ¶
type ListSchemaVersions400JSONResponse struct{ BadRequestJSONResponse }
func (ListSchemaVersions400JSONResponse) VisitListSchemaVersionsResponse ¶
func (response ListSchemaVersions400JSONResponse) VisitListSchemaVersionsResponse(w http.ResponseWriter) error
type ListSchemaVersions401JSONResponse ¶
func (ListSchemaVersions401JSONResponse) VisitListSchemaVersionsResponse ¶
func (response ListSchemaVersions401JSONResponse) VisitListSchemaVersionsResponse(w http.ResponseWriter) error
type ListSchemaVersions403JSONResponse ¶
type ListSchemaVersions403JSONResponse struct{ ForbiddenJSONResponse }
func (ListSchemaVersions403JSONResponse) VisitListSchemaVersionsResponse ¶
func (response ListSchemaVersions403JSONResponse) VisitListSchemaVersionsResponse(w http.ResponseWriter) error
type ListSchemaVersions404JSONResponse ¶
type ListSchemaVersions404JSONResponse struct{ NotFoundJSONResponse }
func (ListSchemaVersions404JSONResponse) VisitListSchemaVersionsResponse ¶
func (response ListSchemaVersions404JSONResponse) VisitListSchemaVersionsResponse(w http.ResponseWriter) error
type ListSchemaVersions502JSONResponse ¶
type ListSchemaVersions502JSONResponse struct{ BadGatewayJSONResponse }
func (ListSchemaVersions502JSONResponse) VisitListSchemaVersionsResponse ¶
func (response ListSchemaVersions502JSONResponse) VisitListSchemaVersionsResponse(w http.ResponseWriter) error
type ListSchemaVersionsParams ¶
type ListSchemaVersionsParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
ListSchemaVersionsParams defines parameters for ListSchemaVersions.
type ListSchemaVersionsRequestObject ¶
type ListSchemaVersionsRequestObject struct {
Cluster Cluster `json:"cluster"`
Subject Subject `json:"subject"`
Params ListSchemaVersionsParams
}
type ListSchemaVersionsResponse ¶
type ListSchemaVersionsResponse struct {
Subject string `json:"subject"`
Versions []int `json:"versions"`
}
ListSchemaVersionsResponse defines model for ListSchemaVersionsResponse.
type ListSchemaVersionsResponseObject ¶
type ListSchemaVersionsResponseObject interface {
VisitListSchemaVersionsResponse(w http.ResponseWriter) error
}
type ListScramUsers200JSONResponse ¶
type ListScramUsers200JSONResponse ListSCRAMUsersResponse
func (ListScramUsers200JSONResponse) VisitListScramUsersResponse ¶
func (response ListScramUsers200JSONResponse) VisitListScramUsersResponse(w http.ResponseWriter) error
type ListScramUsers400JSONResponse ¶
type ListScramUsers400JSONResponse struct{ BadRequestJSONResponse }
func (ListScramUsers400JSONResponse) VisitListScramUsersResponse ¶
func (response ListScramUsers400JSONResponse) VisitListScramUsersResponse(w http.ResponseWriter) error
type ListScramUsers401JSONResponse ¶
func (ListScramUsers401JSONResponse) VisitListScramUsersResponse ¶
func (response ListScramUsers401JSONResponse) VisitListScramUsersResponse(w http.ResponseWriter) error
type ListScramUsers403JSONResponse ¶
type ListScramUsers403JSONResponse struct{ ForbiddenJSONResponse }
func (ListScramUsers403JSONResponse) VisitListScramUsersResponse ¶
func (response ListScramUsers403JSONResponse) VisitListScramUsersResponse(w http.ResponseWriter) error
type ListScramUsers404JSONResponse ¶
type ListScramUsers404JSONResponse struct{ NotFoundJSONResponse }
func (ListScramUsers404JSONResponse) VisitListScramUsersResponse ¶
func (response ListScramUsers404JSONResponse) VisitListScramUsersResponse(w http.ResponseWriter) error
type ListScramUsers502JSONResponse ¶
type ListScramUsers502JSONResponse struct{ BadGatewayJSONResponse }
func (ListScramUsers502JSONResponse) VisitListScramUsersResponse ¶
func (response ListScramUsers502JSONResponse) VisitListScramUsersResponse(w http.ResponseWriter) error
type ListScramUsersParams ¶
type ListScramUsersParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
ListScramUsersParams defines parameters for ListScramUsers.
type ListScramUsersRequestObject ¶
type ListScramUsersRequestObject struct {
Cluster Cluster `json:"cluster"`
Params ListScramUsersParams
}
type ListScramUsersResponseObject ¶
type ListScramUsersResponseObject interface {
VisitListScramUsersResponse(w http.ResponseWriter) error
}
type ListSubjects200JSONResponse ¶
type ListSubjects200JSONResponse ListSubjectsResponse
func (ListSubjects200JSONResponse) VisitListSubjectsResponse ¶
func (response ListSubjects200JSONResponse) VisitListSubjectsResponse(w http.ResponseWriter) error
type ListSubjects400JSONResponse ¶
type ListSubjects400JSONResponse struct{ BadRequestJSONResponse }
func (ListSubjects400JSONResponse) VisitListSubjectsResponse ¶
func (response ListSubjects400JSONResponse) VisitListSubjectsResponse(w http.ResponseWriter) error
type ListSubjects401JSONResponse ¶
func (ListSubjects401JSONResponse) VisitListSubjectsResponse ¶
func (response ListSubjects401JSONResponse) VisitListSubjectsResponse(w http.ResponseWriter) error
type ListSubjects403JSONResponse ¶
type ListSubjects403JSONResponse struct{ ForbiddenJSONResponse }
func (ListSubjects403JSONResponse) VisitListSubjectsResponse ¶
func (response ListSubjects403JSONResponse) VisitListSubjectsResponse(w http.ResponseWriter) error
type ListSubjects404JSONResponse ¶
type ListSubjects404JSONResponse struct{ NotFoundJSONResponse }
func (ListSubjects404JSONResponse) VisitListSubjectsResponse ¶
func (response ListSubjects404JSONResponse) VisitListSubjectsResponse(w http.ResponseWriter) error
type ListSubjects502JSONResponse ¶
type ListSubjects502JSONResponse struct{ BadGatewayJSONResponse }
func (ListSubjects502JSONResponse) VisitListSubjectsResponse ¶
func (response ListSubjects502JSONResponse) VisitListSubjectsResponse(w http.ResponseWriter) error
type ListSubjectsParams ¶
type ListSubjectsParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
ListSubjectsParams defines parameters for ListSubjects.
type ListSubjectsRequestObject ¶
type ListSubjectsRequestObject struct {
Cluster Cluster `json:"cluster"`
Params ListSubjectsParams
}
type ListSubjectsResponse ¶
type ListSubjectsResponse struct {
Cluster string `json:"cluster"`
Subjects []SchemaSubject `json:"subjects"`
}
ListSubjectsResponse defines model for ListSubjectsResponse.
type ListSubjectsResponseObject ¶
type ListSubjectsResponseObject interface {
VisitListSubjectsResponse(w http.ResponseWriter) error
}
type ListTopicConsumers200JSONResponse ¶
type ListTopicConsumers200JSONResponse ListTopicConsumersResponse
func (ListTopicConsumers200JSONResponse) VisitListTopicConsumersResponse ¶
func (response ListTopicConsumers200JSONResponse) VisitListTopicConsumersResponse(w http.ResponseWriter) error
type ListTopicConsumers400JSONResponse ¶
type ListTopicConsumers400JSONResponse struct{ BadRequestJSONResponse }
func (ListTopicConsumers400JSONResponse) VisitListTopicConsumersResponse ¶
func (response ListTopicConsumers400JSONResponse) VisitListTopicConsumersResponse(w http.ResponseWriter) error
type ListTopicConsumers401JSONResponse ¶
func (ListTopicConsumers401JSONResponse) VisitListTopicConsumersResponse ¶
func (response ListTopicConsumers401JSONResponse) VisitListTopicConsumersResponse(w http.ResponseWriter) error
type ListTopicConsumers403JSONResponse ¶
type ListTopicConsumers403JSONResponse struct{ ForbiddenJSONResponse }
func (ListTopicConsumers403JSONResponse) VisitListTopicConsumersResponse ¶
func (response ListTopicConsumers403JSONResponse) VisitListTopicConsumersResponse(w http.ResponseWriter) error
type ListTopicConsumers404JSONResponse ¶
type ListTopicConsumers404JSONResponse struct{ NotFoundJSONResponse }
func (ListTopicConsumers404JSONResponse) VisitListTopicConsumersResponse ¶
func (response ListTopicConsumers404JSONResponse) VisitListTopicConsumersResponse(w http.ResponseWriter) error
type ListTopicConsumers502JSONResponse ¶
type ListTopicConsumers502JSONResponse struct{ BadGatewayJSONResponse }
func (ListTopicConsumers502JSONResponse) VisitListTopicConsumersResponse ¶
func (response ListTopicConsumers502JSONResponse) VisitListTopicConsumersResponse(w http.ResponseWriter) error
type ListTopicConsumers504JSONResponse ¶
type ListTopicConsumers504JSONResponse Error
func (ListTopicConsumers504JSONResponse) VisitListTopicConsumersResponse ¶
func (response ListTopicConsumers504JSONResponse) VisitListTopicConsumersResponse(w http.ResponseWriter) error
type ListTopicConsumersParams ¶
type ListTopicConsumersParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
ListTopicConsumersParams defines parameters for ListTopicConsumers.
type ListTopicConsumersRequestObject ¶
type ListTopicConsumersRequestObject struct {
Cluster Cluster `json:"cluster"`
Topic Topic `json:"topic"`
Params ListTopicConsumersParams
}
type ListTopicConsumersResponse ¶
type ListTopicConsumersResponse struct {
Cluster string `json:"cluster"`
Consumers []TopicConsumer `json:"consumers"`
Topic string `json:"topic"`
}
ListTopicConsumersResponse defines model for ListTopicConsumersResponse.
type ListTopicConsumersResponseObject ¶
type ListTopicConsumersResponseObject interface {
VisitListTopicConsumersResponse(w http.ResponseWriter) error
}
type ListTopics200JSONResponse ¶
type ListTopics200JSONResponse ListTopicsResponse
func (ListTopics200JSONResponse) VisitListTopicsResponse ¶
func (response ListTopics200JSONResponse) VisitListTopicsResponse(w http.ResponseWriter) error
type ListTopics400JSONResponse ¶
type ListTopics400JSONResponse struct{ BadRequestJSONResponse }
func (ListTopics400JSONResponse) VisitListTopicsResponse ¶
func (response ListTopics400JSONResponse) VisitListTopicsResponse(w http.ResponseWriter) error
type ListTopics401JSONResponse ¶
func (ListTopics401JSONResponse) VisitListTopicsResponse ¶
func (response ListTopics401JSONResponse) VisitListTopicsResponse(w http.ResponseWriter) error
type ListTopics403JSONResponse ¶
type ListTopics403JSONResponse struct{ ForbiddenJSONResponse }
func (ListTopics403JSONResponse) VisitListTopicsResponse ¶
func (response ListTopics403JSONResponse) VisitListTopicsResponse(w http.ResponseWriter) error
type ListTopics404JSONResponse ¶
type ListTopics404JSONResponse struct{ NotFoundJSONResponse }
func (ListTopics404JSONResponse) VisitListTopicsResponse ¶
func (response ListTopics404JSONResponse) VisitListTopicsResponse(w http.ResponseWriter) error
type ListTopics502JSONResponse ¶
type ListTopics502JSONResponse struct{ BadGatewayJSONResponse }
func (ListTopics502JSONResponse) VisitListTopicsResponse ¶
func (response ListTopics502JSONResponse) VisitListTopicsResponse(w http.ResponseWriter) error
type ListTopicsParams ¶
type ListTopicsParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
ListTopicsParams defines parameters for ListTopics.
type ListTopicsRequestObject ¶
type ListTopicsRequestObject struct {
Cluster Cluster `json:"cluster"`
Params ListTopicsParams
}
type ListTopicsResponse ¶
type ListTopicsResponse struct {
Cluster string `json:"cluster"`
Topics []TopicInfo `json:"topics"`
}
ListTopicsResponse defines model for ListTopicsResponse.
type ListTopicsResponseObject ¶
type ListTopicsResponseObject interface {
VisitListTopicsResponse(w http.ResponseWriter) error
}
type MaskingRule ¶
type MaskingRule struct {
// Fields JSONPath expressions whose values are replaced.
Fields *[]string `json:"fields,omitempty"`
// Headers Go regex patterns on header keys that restrict the `headers` target to matching headers. Absent or empty = every header.
Headers *[]string `json:"headers,omitempty"`
Regex *[]struct {
Match *string `json:"match,omitempty"`
Replacement *string `json:"replacement,omitempty"`
} `json:"regex,omitempty"`
// Replacement Replacement for `fields`; empty = "***".
Replacement *string `json:"replacement,omitempty"`
// Targets Record parts the rule masks. Absent or empty = `[value]`.
Targets *[]MaskingRuleTargets `json:"targets,omitempty"`
Topics *[]string `json:"topics,omitempty"`
}
MaskingRule defines model for MaskingRule.
type MaskingRuleTargets ¶
type MaskingRuleTargets string
MaskingRuleTargets defines model for MaskingRule.Targets.
const ( MaskingRuleTargetsHeaders MaskingRuleTargets = "headers" MaskingRuleTargetsKey MaskingRuleTargets = "key" MaskingRuleTargetsValue MaskingRuleTargets = "value" )
Defines values for MaskingRuleTargets.
func (MaskingRuleTargets) Valid ¶
func (e MaskingRuleTargets) Valid() bool
Valid indicates whether the value is a known member of the MaskingRuleTargets enum.
type MeResponse ¶
type MeResponse struct {
Anonymous bool `json:"anonymous"`
Email string `json:"email"`
// Jwt True when a validated principal is present.
Jwt bool `json:"jwt"`
// Permissions Map of resource type (or `*`) to allowed actions.
Permissions map[string][]string `json:"permissions"`
// PrivateClusters Whether the caller may use private clusters.
PrivateClusters PrivateClustersStatus `json:"private_clusters"`
RbacEnabled bool `json:"rbac_enabled"`
Roles *[]string `json:"roles"`
Scopes *[]string `json:"scopes"`
Tenant string `json:"tenant"`
// User Resolved RBAC subject; empty when anonymous.
User string `json:"user"`
}
MeResponse defines model for MeResponse.
type MemberAssignment ¶
MemberAssignment defines model for MemberAssignment.
type MessageCountPartition ¶
type MessageCountPartition = kafka.PartitionMessageCount
MessageCountPartition defines model for MessageCountPartition.
type MessageCountResponse ¶
type MessageCountResponse struct {
Cluster string `json:"cluster"`
FromTsMs *int64 `json:"from_ts_ms,omitempty"`
Partitions []MessageCountPartition `json:"partitions"`
ToTsMs *int64 `json:"to_ts_ms,omitempty"`
Topic string `json:"topic"`
TotalApproxCount int64 `json:"total_approx_count"`
}
MessageCountResponse defines model for MessageCountResponse.
type MessageTimelineResponse ¶
type MessageTimelineResponse struct {
Cluster string `json:"cluster"`
FromTsMs int64 `json:"from_ts_ms"`
SlotMs int64 `json:"slot_ms"`
Slots []MessageTimelineSlot `json:"slots"`
ToTsMs int64 `json:"to_ts_ms"`
Topic string `json:"topic"`
}
MessageTimelineResponse defines model for MessageTimelineResponse.
type MessageTimelineSlot ¶
type MessageTimelineSlot = kafka.TimelineSlot
MessageTimelineSlot defines model for MessageTimelineSlot.
type MessagesPage ¶
type MessagesPage struct {
Cluster string `json:"cluster"`
HasMore bool `json:"has_more"`
Messages []Message `json:"messages"`
// NextCursor Opaque cursor for the next page.
NextCursor *string `json:"next_cursor,omitempty"`
// Partial True when a `from=end` page could not fully collect its tail window before the server-side timeout; the newest record(s) may be missing.
Partial *bool `json:"partial,omitempty"`
Topic string `json:"topic"`
}
MessagesPage defines model for MessagesPage.
type NotFoundJSONResponse ¶
type NotFoundJSONResponse Error
type ParseErrorOffset ¶
type ParseErrorOffset struct {
Error string `json:"error"`
Offset int64 `json:"offset"`
Partition int32 `json:"partition"`
}
ParseErrorOffset defines model for ParseErrorOffset.
type PartitionInfo ¶
type PartitionInfo struct {
EndOffset int64 `json:"end_offset"`
Isr []int32 `json:"isr"`
Leader int32 `json:"leader"`
Messages int64 `json:"messages"`
Partition int32 `json:"partition"`
Replicas []int32 `json:"replicas"`
StartOffset int64 `json:"start_offset"`
}
PartitionInfo defines model for PartitionInfo.
type PartitionRange ¶
PartitionRange defines model for PartitionRange.
type PayloadTooLarge ¶
type PayloadTooLarge = Error
PayloadTooLarge Error body emitted by all JSON error paths.
type PayloadTooLargeJSONResponse ¶
type PayloadTooLargeJSONResponse Error
type PrivateClusterHeader ¶
type PrivateClusterHeader = string
PrivateClusterHeader defines model for PrivateClusterHeader.
type PrivateClustersStatus ¶ added in v1.3.0
type PrivateClustersStatus struct {
// Allowed True for mode `on`, false for `off`; for `role`, true when the caller holds the RBAC permission `private_cluster:use`.
Allowed bool `json:"allowed"`
// Mode The server's `private_clusters.mode`.
Mode config.PrivateClusterMode `json:"mode"`
}
PrivateClustersStatus Whether the caller may use private clusters.
type ProdConfirmHeader ¶
type ProdConfirmHeader string
ProdConfirmHeader defines model for ProdConfirmHeader.
const (
ProdConfirmHeaderTrue ProdConfirmHeader = "true"
)
Defines values for ProdConfirmHeader.
func (ProdConfirmHeader) Valid ¶
func (e ProdConfirmHeader) Valid() bool
Valid indicates whether the value is a known member of the ProdConfirmHeader enum.
type ProdConfirmationRequired ¶
type ProdConfirmationRequired = Error
ProdConfirmationRequired Error body emitted by all JSON error paths.
type ProdConfirmationRequiredJSONResponse ¶
type ProdConfirmationRequiredJSONResponse Error
type ProduceMessage200JSONResponse ¶
type ProduceMessage200JSONResponse ProduceResult
func (ProduceMessage200JSONResponse) VisitProduceMessageResponse ¶
func (response ProduceMessage200JSONResponse) VisitProduceMessageResponse(w http.ResponseWriter) error
type ProduceMessage400JSONResponse ¶
type ProduceMessage400JSONResponse struct{ BadRequestJSONResponse }
func (ProduceMessage400JSONResponse) VisitProduceMessageResponse ¶
func (response ProduceMessage400JSONResponse) VisitProduceMessageResponse(w http.ResponseWriter) error
type ProduceMessage401JSONResponse ¶
func (ProduceMessage401JSONResponse) VisitProduceMessageResponse ¶
func (response ProduceMessage401JSONResponse) VisitProduceMessageResponse(w http.ResponseWriter) error
type ProduceMessage403JSONResponse ¶
type ProduceMessage403JSONResponse struct{ ForbiddenJSONResponse }
func (ProduceMessage403JSONResponse) VisitProduceMessageResponse ¶
func (response ProduceMessage403JSONResponse) VisitProduceMessageResponse(w http.ResponseWriter) error
type ProduceMessage404JSONResponse ¶
type ProduceMessage404JSONResponse struct{ NotFoundJSONResponse }
func (ProduceMessage404JSONResponse) VisitProduceMessageResponse ¶
func (response ProduceMessage404JSONResponse) VisitProduceMessageResponse(w http.ResponseWriter) error
type ProduceMessage413JSONResponse ¶
type ProduceMessage413JSONResponse struct{ PayloadTooLargeJSONResponse }
func (ProduceMessage413JSONResponse) VisitProduceMessageResponse ¶
func (response ProduceMessage413JSONResponse) VisitProduceMessageResponse(w http.ResponseWriter) error
type ProduceMessage428JSONResponse ¶
type ProduceMessage428JSONResponse struct {
ProdConfirmationRequiredJSONResponse
}
func (ProduceMessage428JSONResponse) VisitProduceMessageResponse ¶
func (response ProduceMessage428JSONResponse) VisitProduceMessageResponse(w http.ResponseWriter) error
type ProduceMessage502JSONResponse ¶
type ProduceMessage502JSONResponse struct{ BadGatewayJSONResponse }
func (ProduceMessage502JSONResponse) VisitProduceMessageResponse ¶
func (response ProduceMessage502JSONResponse) VisitProduceMessageResponse(w http.ResponseWriter) error
type ProduceMessageJSONRequestBody ¶
type ProduceMessageJSONRequestBody = ProduceRequest
ProduceMessageJSONRequestBody defines body for ProduceMessage for application/json ContentType.
type ProduceMessageParams ¶
type ProduceMessageParams struct {
// XKafkitoConfirmProd Must be `true` when the target cluster is marked `is_prod`; the request is rejected with 428 otherwise. Send only after explicit user confirmation.
XKafkitoConfirmProd *ProduceMessageParamsXKafkitoConfirmProd `json:"X-Kafkito-Confirm-Prod,omitempty"`
// ContentEncoding Set to `gzip` when the JSON body is gzip-compressed.
ContentEncoding *ProduceMessageParamsContentEncoding `json:"Content-Encoding,omitempty"`
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
ProduceMessageParams defines parameters for ProduceMessage.
type ProduceMessageParamsContentEncoding ¶
type ProduceMessageParamsContentEncoding string
ProduceMessageParamsContentEncoding defines parameters for ProduceMessage.
const (
Gzip ProduceMessageParamsContentEncoding = "gzip"
)
Defines values for ProduceMessageParamsContentEncoding.
func (ProduceMessageParamsContentEncoding) Valid ¶
func (e ProduceMessageParamsContentEncoding) Valid() bool
Valid indicates whether the value is a known member of the ProduceMessageParamsContentEncoding enum.
type ProduceMessageParamsXKafkitoConfirmProd ¶
type ProduceMessageParamsXKafkitoConfirmProd string
ProduceMessageParamsXKafkitoConfirmProd defines parameters for ProduceMessage.
const (
ProduceMessageParamsXKafkitoConfirmProdTrue ProduceMessageParamsXKafkitoConfirmProd = "true"
)
Defines values for ProduceMessageParamsXKafkitoConfirmProd.
func (ProduceMessageParamsXKafkitoConfirmProd) Valid ¶
func (e ProduceMessageParamsXKafkitoConfirmProd) Valid() bool
Valid indicates whether the value is a known member of the ProduceMessageParamsXKafkitoConfirmProd enum.
type ProduceMessageRequestObject ¶
type ProduceMessageRequestObject struct {
Cluster Cluster `json:"cluster"`
Topic Topic `json:"topic"`
Params ProduceMessageParams
Body *ProduceMessageJSONRequestBody
}
type ProduceMessageResponseObject ¶
type ProduceMessageResponseObject interface {
VisitProduceMessageResponse(w http.ResponseWriter) error
}
type ProduceRequest ¶
type ProduceRequest = kafka.ProduceRequest
ProduceRequest defines model for ProduceRequest.
type ProduceResult ¶
type ProduceResult = kafka.ProduceResult
ProduceResult defines model for ProduceResult.
type ReadinessResponse ¶
type ReadinessResponse struct {
Clusters []ClusterInfo `json:"clusters"`
// Note Set when no clusters are configured.
Note *string `json:"note,omitempty"`
Status ReadinessResponseStatus `json:"status"`
}
ReadinessResponse defines model for ReadinessResponse.
type ReadinessResponseStatus ¶
type ReadinessResponseStatus string
ReadinessResponseStatus defines model for ReadinessResponse.Status.
const ( ReadinessResponseStatusDegraded ReadinessResponseStatus = "degraded" ReadinessResponseStatusOk ReadinessResponseStatus = "ok" ReadinessResponseStatusReady ReadinessResponseStatus = "ready" )
Defines values for ReadinessResponseStatus.
func (ReadinessResponseStatus) Valid ¶
func (e ReadinessResponseStatus) Valid() bool
Valid indicates whether the value is a known member of the ReadinessResponseStatus enum.
type RefreshCapabilities200JSONResponse ¶
type RefreshCapabilities200JSONResponse CapabilitiesResponse
func (RefreshCapabilities200JSONResponse) VisitRefreshCapabilitiesResponse ¶
func (response RefreshCapabilities200JSONResponse) VisitRefreshCapabilitiesResponse(w http.ResponseWriter) error
type RefreshCapabilities400JSONResponse ¶
type RefreshCapabilities400JSONResponse struct{ BadRequestJSONResponse }
func (RefreshCapabilities400JSONResponse) VisitRefreshCapabilitiesResponse ¶
func (response RefreshCapabilities400JSONResponse) VisitRefreshCapabilitiesResponse(w http.ResponseWriter) error
type RefreshCapabilities401JSONResponse ¶
func (RefreshCapabilities401JSONResponse) VisitRefreshCapabilitiesResponse ¶
func (response RefreshCapabilities401JSONResponse) VisitRefreshCapabilitiesResponse(w http.ResponseWriter) error
type RefreshCapabilities403JSONResponse ¶ added in v1.3.0
type RefreshCapabilities403JSONResponse struct{ ForbiddenJSONResponse }
func (RefreshCapabilities403JSONResponse) VisitRefreshCapabilitiesResponse ¶ added in v1.3.0
func (response RefreshCapabilities403JSONResponse) VisitRefreshCapabilitiesResponse(w http.ResponseWriter) error
type RefreshCapabilities404JSONResponse ¶
type RefreshCapabilities404JSONResponse struct{ NotFoundJSONResponse }
func (RefreshCapabilities404JSONResponse) VisitRefreshCapabilitiesResponse ¶
func (response RefreshCapabilities404JSONResponse) VisitRefreshCapabilitiesResponse(w http.ResponseWriter) error
type RefreshCapabilities502JSONResponse ¶
type RefreshCapabilities502JSONResponse struct{ BadGatewayJSONResponse }
func (RefreshCapabilities502JSONResponse) VisitRefreshCapabilitiesResponse ¶
func (response RefreshCapabilities502JSONResponse) VisitRefreshCapabilitiesResponse(w http.ResponseWriter) error
type RefreshCapabilitiesParams ¶
type RefreshCapabilitiesParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
RefreshCapabilitiesParams defines parameters for RefreshCapabilities.
type RefreshCapabilitiesRequestObject ¶
type RefreshCapabilitiesRequestObject struct {
Cluster Cluster `json:"cluster"`
Params RefreshCapabilitiesParams
}
type RefreshCapabilitiesResponseObject ¶
type RefreshCapabilitiesResponseObject interface {
VisitRefreshCapabilitiesResponse(w http.ResponseWriter) error
}
type RegisterSchema200JSONResponse ¶
type RegisterSchema200JSONResponse RegisterSchemaResponse
func (RegisterSchema200JSONResponse) VisitRegisterSchemaResponse ¶
func (response RegisterSchema200JSONResponse) VisitRegisterSchemaResponse(w http.ResponseWriter) error
type RegisterSchema400JSONResponse ¶
type RegisterSchema400JSONResponse struct{ BadRequestJSONResponse }
func (RegisterSchema400JSONResponse) VisitRegisterSchemaResponse ¶
func (response RegisterSchema400JSONResponse) VisitRegisterSchemaResponse(w http.ResponseWriter) error
type RegisterSchema401JSONResponse ¶
func (RegisterSchema401JSONResponse) VisitRegisterSchemaResponse ¶
func (response RegisterSchema401JSONResponse) VisitRegisterSchemaResponse(w http.ResponseWriter) error
type RegisterSchema403JSONResponse ¶
type RegisterSchema403JSONResponse struct{ ForbiddenJSONResponse }
func (RegisterSchema403JSONResponse) VisitRegisterSchemaResponse ¶
func (response RegisterSchema403JSONResponse) VisitRegisterSchemaResponse(w http.ResponseWriter) error
type RegisterSchema404JSONResponse ¶
type RegisterSchema404JSONResponse struct{ NotFoundJSONResponse }
func (RegisterSchema404JSONResponse) VisitRegisterSchemaResponse ¶
func (response RegisterSchema404JSONResponse) VisitRegisterSchemaResponse(w http.ResponseWriter) error
type RegisterSchema502JSONResponse ¶
type RegisterSchema502JSONResponse struct{ BadGatewayJSONResponse }
func (RegisterSchema502JSONResponse) VisitRegisterSchemaResponse ¶
func (response RegisterSchema502JSONResponse) VisitRegisterSchemaResponse(w http.ResponseWriter) error
type RegisterSchemaJSONRequestBody ¶
type RegisterSchemaJSONRequestBody = RegisterSchemaRequest
RegisterSchemaJSONRequestBody defines body for RegisterSchema for application/json ContentType.
type RegisterSchemaParams ¶
type RegisterSchemaParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
RegisterSchemaParams defines parameters for RegisterSchema.
type RegisterSchemaRequest ¶
type RegisterSchemaRequest = kafka.RegisterSchemaRequest
RegisterSchemaRequest defines model for RegisterSchemaRequest.
type RegisterSchemaRequestObject ¶
type RegisterSchemaRequestObject struct {
Cluster Cluster `json:"cluster"`
Subject Subject `json:"subject"`
Params RegisterSchemaParams
Body *RegisterSchemaJSONRequestBody
}
type RegisterSchemaResponse ¶
type RegisterSchemaResponse = kafka.RegisterSchemaResponse
RegisterSchemaResponse defines model for RegisterSchemaResponse.
type RegisterSchemaResponseObject ¶
type RegisterSchemaResponseObject interface {
VisitRegisterSchemaResponse(w http.ResponseWriter) error
}
type RequiredHeaderError ¶
func (*RequiredHeaderError) Error ¶
func (e *RequiredHeaderError) Error() string
func (*RequiredHeaderError) Unwrap ¶
func (e *RequiredHeaderError) Unwrap() error
type RequiredParamError ¶
type RequiredParamError struct {
ParamName string
}
func (*RequiredParamError) Error ¶
func (e *RequiredParamError) Error() string
type ResetGroupOffsets200JSONResponse ¶
type ResetGroupOffsets200JSONResponse ResetOffsetsResponse
func (ResetGroupOffsets200JSONResponse) VisitResetGroupOffsetsResponse ¶
func (response ResetGroupOffsets200JSONResponse) VisitResetGroupOffsetsResponse(w http.ResponseWriter) error
type ResetGroupOffsets400JSONResponse ¶
type ResetGroupOffsets400JSONResponse struct{ BadRequestJSONResponse }
func (ResetGroupOffsets400JSONResponse) VisitResetGroupOffsetsResponse ¶
func (response ResetGroupOffsets400JSONResponse) VisitResetGroupOffsetsResponse(w http.ResponseWriter) error
type ResetGroupOffsets401JSONResponse ¶
func (ResetGroupOffsets401JSONResponse) VisitResetGroupOffsetsResponse ¶
func (response ResetGroupOffsets401JSONResponse) VisitResetGroupOffsetsResponse(w http.ResponseWriter) error
type ResetGroupOffsets403JSONResponse ¶
type ResetGroupOffsets403JSONResponse struct{ ForbiddenJSONResponse }
func (ResetGroupOffsets403JSONResponse) VisitResetGroupOffsetsResponse ¶
func (response ResetGroupOffsets403JSONResponse) VisitResetGroupOffsetsResponse(w http.ResponseWriter) error
type ResetGroupOffsets404JSONResponse ¶
type ResetGroupOffsets404JSONResponse struct{ NotFoundJSONResponse }
func (ResetGroupOffsets404JSONResponse) VisitResetGroupOffsetsResponse ¶
func (response ResetGroupOffsets404JSONResponse) VisitResetGroupOffsetsResponse(w http.ResponseWriter) error
type ResetGroupOffsets428JSONResponse ¶
type ResetGroupOffsets428JSONResponse struct {
ProdConfirmationRequiredJSONResponse
}
func (ResetGroupOffsets428JSONResponse) VisitResetGroupOffsetsResponse ¶
func (response ResetGroupOffsets428JSONResponse) VisitResetGroupOffsetsResponse(w http.ResponseWriter) error
type ResetGroupOffsets502JSONResponse ¶
type ResetGroupOffsets502JSONResponse struct{ BadGatewayJSONResponse }
func (ResetGroupOffsets502JSONResponse) VisitResetGroupOffsetsResponse ¶
func (response ResetGroupOffsets502JSONResponse) VisitResetGroupOffsetsResponse(w http.ResponseWriter) error
type ResetGroupOffsetsJSONRequestBody ¶
type ResetGroupOffsetsJSONRequestBody = ResetOffsetsRequest
ResetGroupOffsetsJSONRequestBody defines body for ResetGroupOffsets for application/json ContentType.
type ResetGroupOffsetsParams ¶
type ResetGroupOffsetsParams struct {
// XKafkitoConfirmProd Must be `true` when the target cluster is marked `is_prod`; the request is rejected with 428 otherwise. Send only after explicit user confirmation.
XKafkitoConfirmProd *ResetGroupOffsetsParamsXKafkitoConfirmProd `json:"X-Kafkito-Confirm-Prod,omitempty"`
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
ResetGroupOffsetsParams defines parameters for ResetGroupOffsets.
type ResetGroupOffsetsParamsXKafkitoConfirmProd ¶
type ResetGroupOffsetsParamsXKafkitoConfirmProd string
ResetGroupOffsetsParamsXKafkitoConfirmProd defines parameters for ResetGroupOffsets.
const (
ResetGroupOffsetsParamsXKafkitoConfirmProdTrue ResetGroupOffsetsParamsXKafkitoConfirmProd = "true"
)
Defines values for ResetGroupOffsetsParamsXKafkitoConfirmProd.
func (ResetGroupOffsetsParamsXKafkitoConfirmProd) Valid ¶
func (e ResetGroupOffsetsParamsXKafkitoConfirmProd) Valid() bool
Valid indicates whether the value is a known member of the ResetGroupOffsetsParamsXKafkitoConfirmProd enum.
type ResetGroupOffsetsRequestObject ¶
type ResetGroupOffsetsRequestObject struct {
Cluster Cluster `json:"cluster"`
Group Group `json:"group"`
Params ResetGroupOffsetsParams
Body *ResetGroupOffsetsJSONRequestBody
}
type ResetGroupOffsetsResponseObject ¶
type ResetGroupOffsetsResponseObject interface {
VisitResetGroupOffsetsResponse(w http.ResponseWriter) error
}
type ResetOffsetResult ¶
type ResetOffsetResult struct {
// EndOffset Log-end offset, -1 if unknown.
EndOffset int64 `json:"end_offset"`
Error *string `json:"error,omitempty"`
NewOffset int64 `json:"new_offset"`
// OldOffset -1 if no prior commit.
OldOffset int64 `json:"old_offset"`
Partition int32 `json:"partition"`
}
ResetOffsetResult defines model for ResetOffsetResult.
type ResetOffsetsRequest ¶
type ResetOffsetsRequest = kafka.ResetOffsetsRequest
ResetOffsetsRequest defines model for ResetOffsetsRequest.
type ResetOffsetsResponse ¶
type ResetOffsetsResponse = kafka.ResetOffsetsResult
ResetOffsetsResponse defines model for ResetOffsetsResponse.
type SCRAMCredential ¶
type SCRAMCredential struct {
Iterations int32 `json:"iterations"`
Mechanism string `json:"mechanism"`
}
SCRAMCredential defines model for SCRAMCredential.
type SRDecodedMeta ¶
type SRDecodedMeta struct {
// Format `avro`, `protobuf` or `json_schema`.
Format *string `json:"format,omitempty"`
SchemaId *int `json:"schema_id,omitempty"`
Subject *string `json:"subject,omitempty"`
Version *int `json:"version,omitempty"`
}
SRDecodedMeta defines model for SRDecodedMeta.
type SampleMessages200JSONResponse ¶
type SampleMessages200JSONResponse SampleResponse
func (SampleMessages200JSONResponse) VisitSampleMessagesResponse ¶
func (response SampleMessages200JSONResponse) VisitSampleMessagesResponse(w http.ResponseWriter) error
type SampleMessages400JSONResponse ¶
type SampleMessages400JSONResponse struct{ BadRequestJSONResponse }
func (SampleMessages400JSONResponse) VisitSampleMessagesResponse ¶
func (response SampleMessages400JSONResponse) VisitSampleMessagesResponse(w http.ResponseWriter) error
type SampleMessages401JSONResponse ¶
func (SampleMessages401JSONResponse) VisitSampleMessagesResponse ¶
func (response SampleMessages401JSONResponse) VisitSampleMessagesResponse(w http.ResponseWriter) error
type SampleMessages403JSONResponse ¶
type SampleMessages403JSONResponse struct{ ForbiddenJSONResponse }
func (SampleMessages403JSONResponse) VisitSampleMessagesResponse ¶
func (response SampleMessages403JSONResponse) VisitSampleMessagesResponse(w http.ResponseWriter) error
type SampleMessages404JSONResponse ¶
type SampleMessages404JSONResponse struct{ NotFoundJSONResponse }
func (SampleMessages404JSONResponse) VisitSampleMessagesResponse ¶
func (response SampleMessages404JSONResponse) VisitSampleMessagesResponse(w http.ResponseWriter) error
type SampleMessages502JSONResponse ¶
type SampleMessages502JSONResponse struct{ BadGatewayJSONResponse }
func (SampleMessages502JSONResponse) VisitSampleMessagesResponse ¶
func (response SampleMessages502JSONResponse) VisitSampleMessagesResponse(w http.ResponseWriter) error
type SampleMessagesParams ¶
type SampleMessagesParams struct {
// N Sample size; clamped to 1..25.
N *int `form:"n,omitempty" json:"n,omitempty"`
// Partition Partition number; -1 = all partitions.
Partition *PartitionQuery `form:"partition,omitempty" json:"partition,omitempty"`
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
SampleMessagesParams defines parameters for SampleMessages.
type SampleMessagesRequestObject ¶
type SampleMessagesRequestObject struct {
Cluster Cluster `json:"cluster"`
Topic Topic `json:"topic"`
Params SampleMessagesParams
}
type SampleMessagesResponseObject ¶
type SampleMessagesResponseObject interface {
VisitSampleMessagesResponse(w http.ResponseWriter) error
}
type SampleResponse ¶
type SampleResponse struct {
Cluster string `json:"cluster"`
Messages []Message `json:"messages"`
SampledAt int64 `json:"sampled_at"`
Topic string `json:"topic"`
}
SampleResponse defines model for SampleResponse.
type SchemaReference ¶
type SchemaReference struct {
Name string `json:"name"`
Subject string `json:"subject"`
Version int `json:"version"`
}
SchemaReference defines model for SchemaReference.
type SchemaVersion ¶
type SchemaVersion = kafka.SchemaVersion
SchemaVersion defines model for SchemaVersion.
type SearchMessages200JSONResponse ¶
type SearchMessages200JSONResponse SearchResponse
func (SearchMessages200JSONResponse) VisitSearchMessagesResponse ¶
func (response SearchMessages200JSONResponse) VisitSearchMessagesResponse(w http.ResponseWriter) error
type SearchMessages400JSONResponse ¶
type SearchMessages400JSONResponse struct{ BadRequestJSONResponse }
func (SearchMessages400JSONResponse) VisitSearchMessagesResponse ¶
func (response SearchMessages400JSONResponse) VisitSearchMessagesResponse(w http.ResponseWriter) error
type SearchMessages401JSONResponse ¶
func (SearchMessages401JSONResponse) VisitSearchMessagesResponse ¶
func (response SearchMessages401JSONResponse) VisitSearchMessagesResponse(w http.ResponseWriter) error
type SearchMessages403JSONResponse ¶
type SearchMessages403JSONResponse struct{ ForbiddenJSONResponse }
func (SearchMessages403JSONResponse) VisitSearchMessagesResponse ¶
func (response SearchMessages403JSONResponse) VisitSearchMessagesResponse(w http.ResponseWriter) error
type SearchMessages404JSONResponse ¶
type SearchMessages404JSONResponse struct{ NotFoundJSONResponse }
func (SearchMessages404JSONResponse) VisitSearchMessagesResponse ¶
func (response SearchMessages404JSONResponse) VisitSearchMessagesResponse(w http.ResponseWriter) error
type SearchMessages502JSONResponse ¶
type SearchMessages502JSONResponse struct{ BadGatewayJSONResponse }
func (SearchMessages502JSONResponse) VisitSearchMessagesResponse ¶
func (response SearchMessages502JSONResponse) VisitSearchMessagesResponse(w http.ResponseWriter) error
type SearchMessagesJSONRequestBody ¶
type SearchMessagesJSONRequestBody = SearchRequest
SearchMessagesJSONRequestBody defines body for SearchMessages for application/json ContentType.
type SearchMessagesParams ¶
type SearchMessagesParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
SearchMessagesParams defines parameters for SearchMessages.
type SearchMessagesRequestObject ¶
type SearchMessagesRequestObject struct {
Cluster Cluster `json:"cluster"`
Topic Topic `json:"topic"`
Params SearchMessagesParams
Body *SearchMessagesJSONRequestBody
}
type SearchMessagesResponseObject ¶
type SearchMessagesResponseObject interface {
VisitSearchMessagesResponse(w http.ResponseWriter) error
}
type SearchRequest ¶
type SearchRequest struct {
// Budget Maximum number of records a call reads.
Budget *int `json:"budget,omitempty"`
// Cursors Per-partition continuation offsets from `next_cursors`, keyed by partition id.
Cursors *map[string]int64 `json:"cursors,omitempty"`
Direction *SearchRequestDirection `json:"direction,omitempty"`
FromTsMs *int64 `json:"from_ts_ms,omitempty"`
// Limit Page size: the maximum number of matches to return. Matches beyond it are not lost; `next_cursors` stops at the first one, so the next call returns it.
Limit *int `json:"limit,omitempty"`
Mode *SearchRequestMode `json:"mode,omitempty"`
Op *SearchRequestOp `json:"op,omitempty"`
// Partition Absent or -1 = all partitions.
Partition *int32 `json:"partition,omitempty"`
// Path JSONPath or XPath expression for modes `jsonpath` and `xpath`; unused otherwise.
Path *string `json:"path,omitempty"`
// StopOnLimit Return once the first `limit` matches in `direction` order are known: `limit` matches were found and every partition the call still reads has read past the last of them. A lagging partition can keep the call waiting up to its timeout. Without it the call reads on until every partition holds `limit` matches or is done. Either way the budget or the timeout can end the call earlier, and the page is then not guaranteed to be the first in order; it returns at most `limit` matches and the cursors keep the rest reachable.
StopOnLimit *bool `json:"stop_on_limit,omitempty"`
ToTsMs *int64 `json:"to_ts_ms,omitempty"`
// Value Search text for mode `contains`, comparison value for `jsonpath` and `xpath` (not needed with op `exists`), JS filter source for mode `js`.
Value *string `json:"value,omitempty"`
Zones *[]SearchRequestZones `json:"zones,omitempty"`
}
SearchRequest All fields are optional; server-side defaults apply.
type SearchRequestDirection ¶
type SearchRequestDirection string
SearchRequestDirection defines model for SearchRequest.Direction.
const ( NewestFirst SearchRequestDirection = "newest_first" OldestFirst SearchRequestDirection = "oldest_first" )
Defines values for SearchRequestDirection.
func (SearchRequestDirection) Valid ¶
func (e SearchRequestDirection) Valid() bool
Valid indicates whether the value is a known member of the SearchRequestDirection enum.
type SearchRequestMode ¶
type SearchRequestMode string
SearchRequestMode defines model for SearchRequest.Mode.
const ( SearchRequestModeContains SearchRequestMode = "contains" SearchRequestModeJs SearchRequestMode = "js" SearchRequestModeJsonpath SearchRequestMode = "jsonpath" SearchRequestModeXpath SearchRequestMode = "xpath" )
Defines values for SearchRequestMode.
func (SearchRequestMode) Valid ¶
func (e SearchRequestMode) Valid() bool
Valid indicates whether the value is a known member of the SearchRequestMode enum.
type SearchRequestOp ¶
type SearchRequestOp string
SearchRequestOp defines model for SearchRequest.Op.
const ( SearchRequestOpContains SearchRequestOp = "contains" SearchRequestOpEq SearchRequestOp = "eq" SearchRequestOpExists SearchRequestOp = "exists" SearchRequestOpGt SearchRequestOp = "gt" SearchRequestOpGte SearchRequestOp = "gte" SearchRequestOpLt SearchRequestOp = "lt" SearchRequestOpLte SearchRequestOp = "lte" SearchRequestOpNe SearchRequestOp = "ne" SearchRequestOpRegex SearchRequestOp = "regex" )
Defines values for SearchRequestOp.
func (SearchRequestOp) Valid ¶
func (e SearchRequestOp) Valid() bool
Valid indicates whether the value is a known member of the SearchRequestOp enum.
type SearchRequestZones ¶
type SearchRequestZones string
SearchRequestZones defines model for SearchRequest.Zones.
const ( SearchRequestZonesHeaders SearchRequestZones = "headers" SearchRequestZonesKey SearchRequestZones = "key" SearchRequestZonesValue SearchRequestZones = "value" )
Defines values for SearchRequestZones.
func (SearchRequestZones) Valid ¶
func (e SearchRequestZones) Valid() bool
Valid indicates whether the value is a known member of the SearchRequestZones enum.
type SearchResponse ¶
type SearchResponse struct {
Cluster string `json:"cluster"`
Messages *[]Message `json:"messages"`
// Search Scan statistics of one search call. `scanned`, `matched` and `parse_errors` count only what lies behind `next_cursors`, i.e. what a follow-up call does not read again, so their sums across a chain of calls are exact totals.
Search SearchStats `json:"search"`
Topic string `json:"topic"`
}
SearchResponse defines model for SearchResponse.
type SearchStats ¶
type SearchStats = kafka.SearchStats
SearchStats Scan statistics of one search call. `scanned`, `matched` and `parse_errors` count only what lies behind `next_cursors`, i.e. what a follow-up call does not read again, so their sums across a chain of calls are exact totals.
type ServerInterface ¶
type ServerInterface interface {
// ListClusters List configured clusters with reachability, capabilities and metrics.
// (GET /api/v1/clusters)
ListClusters(w http.ResponseWriter, r *http.Request)
// TestCluster Probe an ad-hoc cluster definition without storing it.
// (POST /api/v1/clusters/_test)
TestCluster(w http.ResponseWriter, r *http.Request, params TestClusterParams)
// DeleteAcl Delete ACL(s) matching a filter.
// (DELETE /api/v1/clusters/{cluster}/acls)
DeleteAcl(w http.ResponseWriter, r *http.Request, cluster Cluster, params DeleteAclParams)
// ListAcls List ACLs.
// (GET /api/v1/clusters/{cluster}/acls)
ListAcls(w http.ResponseWriter, r *http.Request, cluster Cluster, params ListAclsParams)
// CreateAcl Create an ACL.
// (POST /api/v1/clusters/{cluster}/acls)
CreateAcl(w http.ResponseWriter, r *http.Request, cluster Cluster, params CreateAclParams)
// ListBrokers List the brokers of a cluster.
// (GET /api/v1/clusters/{cluster}/brokers)
ListBrokers(w http.ResponseWriter, r *http.Request, cluster Cluster, params ListBrokersParams)
// GetCapabilities Cached capabilities (permissions probed against the broker).
// (GET /api/v1/clusters/{cluster}/capabilities)
GetCapabilities(w http.ResponseWriter, r *http.Request, cluster Cluster, params GetCapabilitiesParams)
// RefreshCapabilities Re-probe capabilities (clears the cache).
// (POST /api/v1/clusters/{cluster}/capabilities/refresh)
RefreshCapabilities(w http.ResponseWriter, r *http.Request, cluster Cluster, params RefreshCapabilitiesParams)
// ListGroups List consumer groups (filtered by RBAC view permission).
// (GET /api/v1/clusters/{cluster}/groups)
ListGroups(w http.ResponseWriter, r *http.Request, cluster Cluster, params ListGroupsParams)
// CreateGroup Create a consumer group bound to a topic.
// (POST /api/v1/clusters/{cluster}/groups)
CreateGroup(w http.ResponseWriter, r *http.Request, cluster Cluster, params CreateGroupParams)
// DeleteGroup Delete a consumer group. Must be empty.
// (DELETE /api/v1/clusters/{cluster}/groups/{group})
DeleteGroup(w http.ResponseWriter, r *http.Request, cluster Cluster, group Group, params DeleteGroupParams)
// DescribeGroup Describe a consumer group (members, offsets, lag).
// (GET /api/v1/clusters/{cluster}/groups/{group})
DescribeGroup(w http.ResponseWriter, r *http.Request, cluster Cluster, group Group, params DescribeGroupParams)
// ResetGroupOffsets Reset committed offsets of a group.
// (POST /api/v1/clusters/{cluster}/groups/{group}/reset-offsets)
ResetGroupOffsets(w http.ResponseWriter, r *http.Request, cluster Cluster, group Group, params ResetGroupOffsetsParams)
// ListSubjects List Schema Registry subjects with their versions (filtered by RBAC view permission).
// (GET /api/v1/clusters/{cluster}/schemas/subjects)
ListSubjects(w http.ResponseWriter, r *http.Request, cluster Cluster, params ListSubjectsParams)
// DeleteSubject Delete a subject (soft by default).
// (DELETE /api/v1/clusters/{cluster}/schemas/subjects/{subject})
DeleteSubject(w http.ResponseWriter, r *http.Request, cluster Cluster, subject Subject, params DeleteSubjectParams)
// ListSchemaVersions List versions of a subject.
// (GET /api/v1/clusters/{cluster}/schemas/subjects/{subject}/versions)
ListSchemaVersions(w http.ResponseWriter, r *http.Request, cluster Cluster, subject Subject, params ListSchemaVersionsParams)
// RegisterSchema Register a new version for a subject.
// (POST /api/v1/clusters/{cluster}/schemas/subjects/{subject}/versions)
RegisterSchema(w http.ResponseWriter, r *http.Request, cluster Cluster, subject Subject, params RegisterSchemaParams)
// GetSchemaVersion Get a specific subject version (or `latest`).
// (GET /api/v1/clusters/{cluster}/schemas/subjects/{subject}/versions/{version})
GetSchemaVersion(w http.ResponseWriter, r *http.Request, cluster Cluster, subject Subject, version string, params GetSchemaVersionParams)
// ListTopics List topics (filtered by RBAC view permission).
// (GET /api/v1/clusters/{cluster}/topics)
ListTopics(w http.ResponseWriter, r *http.Request, cluster Cluster, params ListTopicsParams)
// CreateTopic Create a topic.
// (POST /api/v1/clusters/{cluster}/topics)
CreateTopic(w http.ResponseWriter, r *http.Request, cluster Cluster, params CreateTopicParams)
// DeleteTopic Delete a topic.
// (DELETE /api/v1/clusters/{cluster}/topics/{topic})
DeleteTopic(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params DeleteTopicParams)
// DescribeTopic Describe a single topic (partitions, offsets, configs).
// (GET /api/v1/clusters/{cluster}/topics/{topic})
DescribeTopic(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params DescribeTopicParams)
// AlterTopicConfigs Incrementally set and/or delete topic config entries.
// (PATCH /api/v1/clusters/{cluster}/topics/{topic}/configs)
AlterTopicConfigs(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params AlterTopicConfigsParams)
// ListTopicConsumers Consumer groups that have committed offsets on, or are assigned to, this topic.
// (GET /api/v1/clusters/{cluster}/topics/{topic}/consumers)
ListTopicConsumers(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params ListTopicConsumersParams)
// CopyMessages Bulk-copy messages into another topic (SSE progress stream).
// (POST /api/v1/clusters/{cluster}/topics/{topic}/copy)
CopyMessages(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params CopyMessagesParams)
// ConsumeMessages Browse a bounded page of messages.
// (GET /api/v1/clusters/{cluster}/topics/{topic}/messages)
ConsumeMessages(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params ConsumeMessagesParams)
// ProduceMessage Produce a single record.
// (POST /api/v1/clusters/{cluster}/topics/{topic}/messages)
ProduceMessage(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params ProduceMessageParams)
// CountMessages Approximate message volume for a topic range.
// (GET /api/v1/clusters/{cluster}/topics/{topic}/messages/count)
CountMessages(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params CountMessagesParams)
// SearchMessages Bounded, budget-limited content search across partitions.
// (POST /api/v1/clusters/{cluster}/topics/{topic}/messages/search)
SearchMessages(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params SearchMessagesParams)
// GetMessageTimeline Time-sliced message volume over a time range for a topic.
// (GET /api/v1/clusters/{cluster}/topics/{topic}/messages/timeline)
GetMessageTimeline(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params GetMessageTimelineParams)
// DownloadMessageRaw Download the full value of a single record.
// (GET /api/v1/clusters/{cluster}/topics/{topic}/messages/{partition}/{offset}/raw)
DownloadMessageRaw(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, partition int32, offset int64, params DownloadMessageRawParams)
// DeleteRecords Delete records up to an offset per partition (low-watermark bump).
// (DELETE /api/v1/clusters/{cluster}/topics/{topic}/records)
DeleteRecords(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params DeleteRecordsParams)
// SampleMessages Sample the last n decoded messages from a topic.
// (GET /api/v1/clusters/{cluster}/topics/{topic}/sample)
SampleMessages(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params SampleMessagesParams)
// ListScramUsers List SCRAM users (filtered by RBAC view permission).
// (GET /api/v1/clusters/{cluster}/users)
ListScramUsers(w http.ResponseWriter, r *http.Request, cluster Cluster, params ListScramUsersParams)
// UpsertScramUser Create or update a SCRAM user.
// (POST /api/v1/clusters/{cluster}/users)
UpsertScramUser(w http.ResponseWriter, r *http.Request, cluster Cluster, params UpsertScramUserParams)
// DeleteScramUser Delete a SCRAM user's credentials.
// (DELETE /api/v1/clusters/{cluster}/users/{user})
DeleteScramUser(w http.ResponseWriter, r *http.Request, cluster Cluster, user string, params DeleteScramUserParams)
// GetInfo Build info.
// (GET /api/v1/info)
GetInfo(w http.ResponseWriter, r *http.Request)
// GetMe Resolved caller identity and effective permissions.
// (GET /api/v1/me)
GetMe(w http.ResponseWriter, r *http.Request)
// GetOpenApiSpec This OpenAPI document.
// (GET /api/v1/openapi.yaml)
GetOpenApiSpec(w http.ResponseWriter, r *http.Request)
// GetHealth Liveness probe.
// (GET /healthz)
GetHealth(w http.ResponseWriter, r *http.Request)
// GetReadiness Readiness probe. 503 if any configured cluster is unreachable.
// (GET /readyz)
GetReadiness(w http.ResponseWriter, r *http.Request)
}
ServerInterface represents all server handlers.
func NewStrictHandler ¶
func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface
func NewStrictHandlerWithOptions ¶
func NewStrictHandlerWithOptions(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc, options StrictHTTPServerOptions) ServerInterface
type ServerInterfaceWrapper ¶
type ServerInterfaceWrapper struct {
Handler ServerInterface
HandlerMiddlewares []MiddlewareFunc
ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
ServerInterfaceWrapper converts contexts to parameters.
func (*ServerInterfaceWrapper) AlterTopicConfigs ¶
func (siw *ServerInterfaceWrapper) AlterTopicConfigs(w http.ResponseWriter, r *http.Request)
AlterTopicConfigs operation middleware
func (*ServerInterfaceWrapper) ConsumeMessages ¶
func (siw *ServerInterfaceWrapper) ConsumeMessages(w http.ResponseWriter, r *http.Request)
ConsumeMessages operation middleware
func (*ServerInterfaceWrapper) CopyMessages ¶
func (siw *ServerInterfaceWrapper) CopyMessages(w http.ResponseWriter, r *http.Request)
CopyMessages operation middleware
func (*ServerInterfaceWrapper) CountMessages ¶
func (siw *ServerInterfaceWrapper) CountMessages(w http.ResponseWriter, r *http.Request)
CountMessages operation middleware
func (*ServerInterfaceWrapper) CreateAcl ¶
func (siw *ServerInterfaceWrapper) CreateAcl(w http.ResponseWriter, r *http.Request)
CreateAcl operation middleware
func (*ServerInterfaceWrapper) CreateGroup ¶
func (siw *ServerInterfaceWrapper) CreateGroup(w http.ResponseWriter, r *http.Request)
CreateGroup operation middleware
func (*ServerInterfaceWrapper) CreateTopic ¶
func (siw *ServerInterfaceWrapper) CreateTopic(w http.ResponseWriter, r *http.Request)
CreateTopic operation middleware
func (*ServerInterfaceWrapper) DeleteAcl ¶
func (siw *ServerInterfaceWrapper) DeleteAcl(w http.ResponseWriter, r *http.Request)
DeleteAcl operation middleware
func (*ServerInterfaceWrapper) DeleteGroup ¶
func (siw *ServerInterfaceWrapper) DeleteGroup(w http.ResponseWriter, r *http.Request)
DeleteGroup operation middleware
func (*ServerInterfaceWrapper) DeleteRecords ¶
func (siw *ServerInterfaceWrapper) DeleteRecords(w http.ResponseWriter, r *http.Request)
DeleteRecords operation middleware
func (*ServerInterfaceWrapper) DeleteScramUser ¶
func (siw *ServerInterfaceWrapper) DeleteScramUser(w http.ResponseWriter, r *http.Request)
DeleteScramUser operation middleware
func (*ServerInterfaceWrapper) DeleteSubject ¶
func (siw *ServerInterfaceWrapper) DeleteSubject(w http.ResponseWriter, r *http.Request)
DeleteSubject operation middleware
func (*ServerInterfaceWrapper) DeleteTopic ¶
func (siw *ServerInterfaceWrapper) DeleteTopic(w http.ResponseWriter, r *http.Request)
DeleteTopic operation middleware
func (*ServerInterfaceWrapper) DescribeGroup ¶
func (siw *ServerInterfaceWrapper) DescribeGroup(w http.ResponseWriter, r *http.Request)
DescribeGroup operation middleware
func (*ServerInterfaceWrapper) DescribeTopic ¶
func (siw *ServerInterfaceWrapper) DescribeTopic(w http.ResponseWriter, r *http.Request)
DescribeTopic operation middleware
func (*ServerInterfaceWrapper) DownloadMessageRaw ¶
func (siw *ServerInterfaceWrapper) DownloadMessageRaw(w http.ResponseWriter, r *http.Request)
DownloadMessageRaw operation middleware
func (*ServerInterfaceWrapper) GetCapabilities ¶
func (siw *ServerInterfaceWrapper) GetCapabilities(w http.ResponseWriter, r *http.Request)
GetCapabilities operation middleware
func (*ServerInterfaceWrapper) GetHealth ¶
func (siw *ServerInterfaceWrapper) GetHealth(w http.ResponseWriter, r *http.Request)
GetHealth operation middleware
func (*ServerInterfaceWrapper) GetInfo ¶
func (siw *ServerInterfaceWrapper) GetInfo(w http.ResponseWriter, r *http.Request)
GetInfo operation middleware
func (*ServerInterfaceWrapper) GetMe ¶
func (siw *ServerInterfaceWrapper) GetMe(w http.ResponseWriter, r *http.Request)
GetMe operation middleware
func (*ServerInterfaceWrapper) GetMessageTimeline ¶
func (siw *ServerInterfaceWrapper) GetMessageTimeline(w http.ResponseWriter, r *http.Request)
GetMessageTimeline operation middleware
func (*ServerInterfaceWrapper) GetOpenApiSpec ¶
func (siw *ServerInterfaceWrapper) GetOpenApiSpec(w http.ResponseWriter, r *http.Request)
GetOpenApiSpec operation middleware
func (*ServerInterfaceWrapper) GetReadiness ¶
func (siw *ServerInterfaceWrapper) GetReadiness(w http.ResponseWriter, r *http.Request)
GetReadiness operation middleware
func (*ServerInterfaceWrapper) GetSchemaVersion ¶
func (siw *ServerInterfaceWrapper) GetSchemaVersion(w http.ResponseWriter, r *http.Request)
GetSchemaVersion operation middleware
func (*ServerInterfaceWrapper) ListAcls ¶
func (siw *ServerInterfaceWrapper) ListAcls(w http.ResponseWriter, r *http.Request)
ListAcls operation middleware
func (*ServerInterfaceWrapper) ListBrokers ¶
func (siw *ServerInterfaceWrapper) ListBrokers(w http.ResponseWriter, r *http.Request)
ListBrokers operation middleware
func (*ServerInterfaceWrapper) ListClusters ¶
func (siw *ServerInterfaceWrapper) ListClusters(w http.ResponseWriter, r *http.Request)
ListClusters operation middleware
func (*ServerInterfaceWrapper) ListGroups ¶
func (siw *ServerInterfaceWrapper) ListGroups(w http.ResponseWriter, r *http.Request)
ListGroups operation middleware
func (*ServerInterfaceWrapper) ListSchemaVersions ¶
func (siw *ServerInterfaceWrapper) ListSchemaVersions(w http.ResponseWriter, r *http.Request)
ListSchemaVersions operation middleware
func (*ServerInterfaceWrapper) ListScramUsers ¶
func (siw *ServerInterfaceWrapper) ListScramUsers(w http.ResponseWriter, r *http.Request)
ListScramUsers operation middleware
func (*ServerInterfaceWrapper) ListSubjects ¶
func (siw *ServerInterfaceWrapper) ListSubjects(w http.ResponseWriter, r *http.Request)
ListSubjects operation middleware
func (*ServerInterfaceWrapper) ListTopicConsumers ¶
func (siw *ServerInterfaceWrapper) ListTopicConsumers(w http.ResponseWriter, r *http.Request)
ListTopicConsumers operation middleware
func (*ServerInterfaceWrapper) ListTopics ¶
func (siw *ServerInterfaceWrapper) ListTopics(w http.ResponseWriter, r *http.Request)
ListTopics operation middleware
func (*ServerInterfaceWrapper) ProduceMessage ¶
func (siw *ServerInterfaceWrapper) ProduceMessage(w http.ResponseWriter, r *http.Request)
ProduceMessage operation middleware
func (*ServerInterfaceWrapper) RefreshCapabilities ¶
func (siw *ServerInterfaceWrapper) RefreshCapabilities(w http.ResponseWriter, r *http.Request)
RefreshCapabilities operation middleware
func (*ServerInterfaceWrapper) RegisterSchema ¶
func (siw *ServerInterfaceWrapper) RegisterSchema(w http.ResponseWriter, r *http.Request)
RegisterSchema operation middleware
func (*ServerInterfaceWrapper) ResetGroupOffsets ¶
func (siw *ServerInterfaceWrapper) ResetGroupOffsets(w http.ResponseWriter, r *http.Request)
ResetGroupOffsets operation middleware
func (*ServerInterfaceWrapper) SampleMessages ¶
func (siw *ServerInterfaceWrapper) SampleMessages(w http.ResponseWriter, r *http.Request)
SampleMessages operation middleware
func (*ServerInterfaceWrapper) SearchMessages ¶
func (siw *ServerInterfaceWrapper) SearchMessages(w http.ResponseWriter, r *http.Request)
SearchMessages operation middleware
func (*ServerInterfaceWrapper) TestCluster ¶
func (siw *ServerInterfaceWrapper) TestCluster(w http.ResponseWriter, r *http.Request)
TestCluster operation middleware
func (*ServerInterfaceWrapper) UpsertScramUser ¶
func (siw *ServerInterfaceWrapper) UpsertScramUser(w http.ResponseWriter, r *http.Request)
UpsertScramUser operation middleware
type StrictHTTPServerOptions ¶
type StrictHTTPServerOptions struct {
RequestErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
ResponseErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
type StrictHandlerFunc ¶
type StrictMiddlewareFunc ¶
type StrictMiddlewareFunc func(f StrictHandlerFunc, operationID string) StrictHandlerFunc
type StrictServerInterface ¶
type StrictServerInterface interface {
// ListClusters List configured clusters with reachability, capabilities and metrics.
// (GET /api/v1/clusters)
ListClusters(ctx context.Context, request ListClustersRequestObject) (ListClustersResponseObject, error)
// TestCluster Probe an ad-hoc cluster definition without storing it.
// (POST /api/v1/clusters/_test)
TestCluster(ctx context.Context, request TestClusterRequestObject) (TestClusterResponseObject, error)
// DeleteAcl Delete ACL(s) matching a filter.
// (DELETE /api/v1/clusters/{cluster}/acls)
DeleteAcl(ctx context.Context, request DeleteAclRequestObject) (DeleteAclResponseObject, error)
// ListAcls List ACLs.
// (GET /api/v1/clusters/{cluster}/acls)
ListAcls(ctx context.Context, request ListAclsRequestObject) (ListAclsResponseObject, error)
// CreateAcl Create an ACL.
// (POST /api/v1/clusters/{cluster}/acls)
CreateAcl(ctx context.Context, request CreateAclRequestObject) (CreateAclResponseObject, error)
// ListBrokers List the brokers of a cluster.
// (GET /api/v1/clusters/{cluster}/brokers)
ListBrokers(ctx context.Context, request ListBrokersRequestObject) (ListBrokersResponseObject, error)
// GetCapabilities Cached capabilities (permissions probed against the broker).
// (GET /api/v1/clusters/{cluster}/capabilities)
GetCapabilities(ctx context.Context, request GetCapabilitiesRequestObject) (GetCapabilitiesResponseObject, error)
// RefreshCapabilities Re-probe capabilities (clears the cache).
// (POST /api/v1/clusters/{cluster}/capabilities/refresh)
RefreshCapabilities(ctx context.Context, request RefreshCapabilitiesRequestObject) (RefreshCapabilitiesResponseObject, error)
// ListGroups List consumer groups (filtered by RBAC view permission).
// (GET /api/v1/clusters/{cluster}/groups)
ListGroups(ctx context.Context, request ListGroupsRequestObject) (ListGroupsResponseObject, error)
// CreateGroup Create a consumer group bound to a topic.
// (POST /api/v1/clusters/{cluster}/groups)
CreateGroup(ctx context.Context, request CreateGroupRequestObject) (CreateGroupResponseObject, error)
// DeleteGroup Delete a consumer group. Must be empty.
// (DELETE /api/v1/clusters/{cluster}/groups/{group})
DeleteGroup(ctx context.Context, request DeleteGroupRequestObject) (DeleteGroupResponseObject, error)
// DescribeGroup Describe a consumer group (members, offsets, lag).
// (GET /api/v1/clusters/{cluster}/groups/{group})
DescribeGroup(ctx context.Context, request DescribeGroupRequestObject) (DescribeGroupResponseObject, error)
// ResetGroupOffsets Reset committed offsets of a group.
// (POST /api/v1/clusters/{cluster}/groups/{group}/reset-offsets)
ResetGroupOffsets(ctx context.Context, request ResetGroupOffsetsRequestObject) (ResetGroupOffsetsResponseObject, error)
// ListSubjects List Schema Registry subjects with their versions (filtered by RBAC view permission).
// (GET /api/v1/clusters/{cluster}/schemas/subjects)
ListSubjects(ctx context.Context, request ListSubjectsRequestObject) (ListSubjectsResponseObject, error)
// DeleteSubject Delete a subject (soft by default).
// (DELETE /api/v1/clusters/{cluster}/schemas/subjects/{subject})
DeleteSubject(ctx context.Context, request DeleteSubjectRequestObject) (DeleteSubjectResponseObject, error)
// ListSchemaVersions List versions of a subject.
// (GET /api/v1/clusters/{cluster}/schemas/subjects/{subject}/versions)
ListSchemaVersions(ctx context.Context, request ListSchemaVersionsRequestObject) (ListSchemaVersionsResponseObject, error)
// RegisterSchema Register a new version for a subject.
// (POST /api/v1/clusters/{cluster}/schemas/subjects/{subject}/versions)
RegisterSchema(ctx context.Context, request RegisterSchemaRequestObject) (RegisterSchemaResponseObject, error)
// GetSchemaVersion Get a specific subject version (or `latest`).
// (GET /api/v1/clusters/{cluster}/schemas/subjects/{subject}/versions/{version})
GetSchemaVersion(ctx context.Context, request GetSchemaVersionRequestObject) (GetSchemaVersionResponseObject, error)
// ListTopics List topics (filtered by RBAC view permission).
// (GET /api/v1/clusters/{cluster}/topics)
ListTopics(ctx context.Context, request ListTopicsRequestObject) (ListTopicsResponseObject, error)
// CreateTopic Create a topic.
// (POST /api/v1/clusters/{cluster}/topics)
CreateTopic(ctx context.Context, request CreateTopicRequestObject) (CreateTopicResponseObject, error)
// DeleteTopic Delete a topic.
// (DELETE /api/v1/clusters/{cluster}/topics/{topic})
DeleteTopic(ctx context.Context, request DeleteTopicRequestObject) (DeleteTopicResponseObject, error)
// DescribeTopic Describe a single topic (partitions, offsets, configs).
// (GET /api/v1/clusters/{cluster}/topics/{topic})
DescribeTopic(ctx context.Context, request DescribeTopicRequestObject) (DescribeTopicResponseObject, error)
// AlterTopicConfigs Incrementally set and/or delete topic config entries.
// (PATCH /api/v1/clusters/{cluster}/topics/{topic}/configs)
AlterTopicConfigs(ctx context.Context, request AlterTopicConfigsRequestObject) (AlterTopicConfigsResponseObject, error)
// ListTopicConsumers Consumer groups that have committed offsets on, or are assigned to, this topic.
// (GET /api/v1/clusters/{cluster}/topics/{topic}/consumers)
ListTopicConsumers(ctx context.Context, request ListTopicConsumersRequestObject) (ListTopicConsumersResponseObject, error)
// CopyMessages Bulk-copy messages into another topic (SSE progress stream).
// (POST /api/v1/clusters/{cluster}/topics/{topic}/copy)
CopyMessages(ctx context.Context, request CopyMessagesRequestObject) (CopyMessagesResponseObject, error)
// ConsumeMessages Browse a bounded page of messages.
// (GET /api/v1/clusters/{cluster}/topics/{topic}/messages)
ConsumeMessages(ctx context.Context, request ConsumeMessagesRequestObject) (ConsumeMessagesResponseObject, error)
// ProduceMessage Produce a single record.
// (POST /api/v1/clusters/{cluster}/topics/{topic}/messages)
ProduceMessage(ctx context.Context, request ProduceMessageRequestObject) (ProduceMessageResponseObject, error)
// CountMessages Approximate message volume for a topic range.
// (GET /api/v1/clusters/{cluster}/topics/{topic}/messages/count)
CountMessages(ctx context.Context, request CountMessagesRequestObject) (CountMessagesResponseObject, error)
// SearchMessages Bounded, budget-limited content search across partitions.
// (POST /api/v1/clusters/{cluster}/topics/{topic}/messages/search)
SearchMessages(ctx context.Context, request SearchMessagesRequestObject) (SearchMessagesResponseObject, error)
// GetMessageTimeline Time-sliced message volume over a time range for a topic.
// (GET /api/v1/clusters/{cluster}/topics/{topic}/messages/timeline)
GetMessageTimeline(ctx context.Context, request GetMessageTimelineRequestObject) (GetMessageTimelineResponseObject, error)
// DownloadMessageRaw Download the full value of a single record.
// (GET /api/v1/clusters/{cluster}/topics/{topic}/messages/{partition}/{offset}/raw)
DownloadMessageRaw(ctx context.Context, request DownloadMessageRawRequestObject) (DownloadMessageRawResponseObject, error)
// DeleteRecords Delete records up to an offset per partition (low-watermark bump).
// (DELETE /api/v1/clusters/{cluster}/topics/{topic}/records)
DeleteRecords(ctx context.Context, request DeleteRecordsRequestObject) (DeleteRecordsResponseObject, error)
// SampleMessages Sample the last n decoded messages from a topic.
// (GET /api/v1/clusters/{cluster}/topics/{topic}/sample)
SampleMessages(ctx context.Context, request SampleMessagesRequestObject) (SampleMessagesResponseObject, error)
// ListScramUsers List SCRAM users (filtered by RBAC view permission).
// (GET /api/v1/clusters/{cluster}/users)
ListScramUsers(ctx context.Context, request ListScramUsersRequestObject) (ListScramUsersResponseObject, error)
// UpsertScramUser Create or update a SCRAM user.
// (POST /api/v1/clusters/{cluster}/users)
UpsertScramUser(ctx context.Context, request UpsertScramUserRequestObject) (UpsertScramUserResponseObject, error)
// DeleteScramUser Delete a SCRAM user's credentials.
// (DELETE /api/v1/clusters/{cluster}/users/{user})
DeleteScramUser(ctx context.Context, request DeleteScramUserRequestObject) (DeleteScramUserResponseObject, error)
// GetInfo Build info.
// (GET /api/v1/info)
GetInfo(ctx context.Context, request GetInfoRequestObject) (GetInfoResponseObject, error)
// GetMe Resolved caller identity and effective permissions.
// (GET /api/v1/me)
GetMe(ctx context.Context, request GetMeRequestObject) (GetMeResponseObject, error)
// GetOpenApiSpec This OpenAPI document.
// (GET /api/v1/openapi.yaml)
GetOpenApiSpec(ctx context.Context, request GetOpenApiSpecRequestObject) (GetOpenApiSpecResponseObject, error)
// GetHealth Liveness probe.
// (GET /healthz)
GetHealth(ctx context.Context, request GetHealthRequestObject) (GetHealthResponseObject, error)
// GetReadiness Readiness probe. 503 if any configured cluster is unreachable.
// (GET /readyz)
GetReadiness(ctx context.Context, request GetReadinessRequestObject) (GetReadinessResponseObject, error)
}
StrictServerInterface represents all server handlers.
type TestCluster200JSONResponse ¶
type TestCluster200JSONResponse ClusterInfo
func (TestCluster200JSONResponse) VisitTestClusterResponse ¶
func (response TestCluster200JSONResponse) VisitTestClusterResponse(w http.ResponseWriter) error
type TestCluster400JSONResponse ¶
type TestCluster400JSONResponse struct{ BadRequestJSONResponse }
func (TestCluster400JSONResponse) VisitTestClusterResponse ¶
func (response TestCluster400JSONResponse) VisitTestClusterResponse(w http.ResponseWriter) error
type TestCluster401JSONResponse ¶
func (TestCluster401JSONResponse) VisitTestClusterResponse ¶
func (response TestCluster401JSONResponse) VisitTestClusterResponse(w http.ResponseWriter) error
type TestCluster403JSONResponse ¶ added in v1.3.0
type TestCluster403JSONResponse struct{ ForbiddenJSONResponse }
func (TestCluster403JSONResponse) VisitTestClusterResponse ¶ added in v1.3.0
func (response TestCluster403JSONResponse) VisitTestClusterResponse(w http.ResponseWriter) error
type TestCluster429JSONResponse ¶ added in v1.3.0
type TestCluster429JSONResponse struct {
Body Error
Headers TestCluster429ResponseHeaders
}
func (TestCluster429JSONResponse) VisitTestClusterResponse ¶ added in v1.3.0
func (response TestCluster429JSONResponse) VisitTestClusterResponse(w http.ResponseWriter) error
type TestCluster429ResponseHeaders ¶ added in v1.3.0
type TestCluster429ResponseHeaders struct {
RetryAfter int
}
type TestClusterJSONRequestBody ¶
type TestClusterJSONRequestBody = ClusterConfig
TestClusterJSONRequestBody defines body for TestCluster for application/json ContentType.
type TestClusterParams ¶
type TestClusterParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
TestClusterParams defines parameters for TestCluster.
type TestClusterRequestObject ¶
type TestClusterRequestObject struct {
Params TestClusterParams
Body *TestClusterJSONRequestBody
}
type TestClusterResponseObject ¶
type TestClusterResponseObject interface {
VisitTestClusterResponse(w http.ResponseWriter) error
}
type TooManyValuesForParamError ¶
func (*TooManyValuesForParamError) Error ¶
func (e *TooManyValuesForParamError) Error() string
type TopicConfigEntry ¶
type TopicConfigEntry struct {
IsDefault bool `json:"is_default"`
Name string `json:"name"`
Sensitive bool `json:"sensitive"`
Source *string `json:"source,omitempty"`
Value string `json:"value"`
}
TopicConfigEntry defines model for TopicConfigEntry.
type TopicConsumer ¶
type TopicConsumer = kafka.TopicConsumer
TopicConsumer defines model for TopicConsumer.
type Unauthorized ¶
type Unauthorized = Error
Unauthorized Error body emitted by all JSON error paths.
type UnauthorizedJSONResponse ¶
type UnauthorizedJSONResponse struct {
}
type UnauthorizedResponseHeaders ¶
type UnauthorizedResponseHeaders struct {
}
type UnescapedCookieParamError ¶
func (*UnescapedCookieParamError) Error ¶
func (e *UnescapedCookieParamError) Error() string
func (*UnescapedCookieParamError) Unwrap ¶
func (e *UnescapedCookieParamError) Unwrap() error
type Unimplemented ¶
type Unimplemented struct{}
func (Unimplemented) AlterTopicConfigs ¶
func (_ Unimplemented) AlterTopicConfigs(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params AlterTopicConfigsParams)
AlterTopicConfigs Incrementally set and/or delete topic config entries. (PATCH /api/v1/clusters/{cluster}/topics/{topic}/configs)
func (Unimplemented) ConsumeMessages ¶
func (_ Unimplemented) ConsumeMessages(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params ConsumeMessagesParams)
ConsumeMessages Browse a bounded page of messages. (GET /api/v1/clusters/{cluster}/topics/{topic}/messages)
func (Unimplemented) CopyMessages ¶
func (_ Unimplemented) CopyMessages(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params CopyMessagesParams)
CopyMessages Bulk-copy messages into another topic (SSE progress stream). (POST /api/v1/clusters/{cluster}/topics/{topic}/copy)
func (Unimplemented) CountMessages ¶
func (_ Unimplemented) CountMessages(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params CountMessagesParams)
CountMessages Approximate message volume for a topic range. (GET /api/v1/clusters/{cluster}/topics/{topic}/messages/count)
func (Unimplemented) CreateAcl ¶
func (_ Unimplemented) CreateAcl(w http.ResponseWriter, r *http.Request, cluster Cluster, params CreateAclParams)
CreateAcl Create an ACL. (POST /api/v1/clusters/{cluster}/acls)
func (Unimplemented) CreateGroup ¶
func (_ Unimplemented) CreateGroup(w http.ResponseWriter, r *http.Request, cluster Cluster, params CreateGroupParams)
CreateGroup Create a consumer group bound to a topic. (POST /api/v1/clusters/{cluster}/groups)
func (Unimplemented) CreateTopic ¶
func (_ Unimplemented) CreateTopic(w http.ResponseWriter, r *http.Request, cluster Cluster, params CreateTopicParams)
CreateTopic Create a topic. (POST /api/v1/clusters/{cluster}/topics)
func (Unimplemented) DeleteAcl ¶
func (_ Unimplemented) DeleteAcl(w http.ResponseWriter, r *http.Request, cluster Cluster, params DeleteAclParams)
DeleteAcl Delete ACL(s) matching a filter. (DELETE /api/v1/clusters/{cluster}/acls)
func (Unimplemented) DeleteGroup ¶
func (_ Unimplemented) DeleteGroup(w http.ResponseWriter, r *http.Request, cluster Cluster, group Group, params DeleteGroupParams)
DeleteGroup Delete a consumer group. Must be empty. (DELETE /api/v1/clusters/{cluster}/groups/{group})
func (Unimplemented) DeleteRecords ¶
func (_ Unimplemented) DeleteRecords(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params DeleteRecordsParams)
DeleteRecords Delete records up to an offset per partition (low-watermark bump). (DELETE /api/v1/clusters/{cluster}/topics/{topic}/records)
func (Unimplemented) DeleteScramUser ¶
func (_ Unimplemented) DeleteScramUser(w http.ResponseWriter, r *http.Request, cluster Cluster, user string, params DeleteScramUserParams)
DeleteScramUser Delete a SCRAM user's credentials. (DELETE /api/v1/clusters/{cluster}/users/{user})
func (Unimplemented) DeleteSubject ¶
func (_ Unimplemented) DeleteSubject(w http.ResponseWriter, r *http.Request, cluster Cluster, subject Subject, params DeleteSubjectParams)
DeleteSubject Delete a subject (soft by default). (DELETE /api/v1/clusters/{cluster}/schemas/subjects/{subject})
func (Unimplemented) DeleteTopic ¶
func (_ Unimplemented) DeleteTopic(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params DeleteTopicParams)
DeleteTopic Delete a topic. (DELETE /api/v1/clusters/{cluster}/topics/{topic})
func (Unimplemented) DescribeGroup ¶
func (_ Unimplemented) DescribeGroup(w http.ResponseWriter, r *http.Request, cluster Cluster, group Group, params DescribeGroupParams)
DescribeGroup Describe a consumer group (members, offsets, lag). (GET /api/v1/clusters/{cluster}/groups/{group})
func (Unimplemented) DescribeTopic ¶
func (_ Unimplemented) DescribeTopic(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params DescribeTopicParams)
DescribeTopic Describe a single topic (partitions, offsets, configs). (GET /api/v1/clusters/{cluster}/topics/{topic})
func (Unimplemented) DownloadMessageRaw ¶
func (_ Unimplemented) DownloadMessageRaw(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, partition int32, offset int64, params DownloadMessageRawParams)
DownloadMessageRaw Download the full value of a single record. (GET /api/v1/clusters/{cluster}/topics/{topic}/messages/{partition}/{offset}/raw)
func (Unimplemented) GetCapabilities ¶
func (_ Unimplemented) GetCapabilities(w http.ResponseWriter, r *http.Request, cluster Cluster, params GetCapabilitiesParams)
GetCapabilities Cached capabilities (permissions probed against the broker). (GET /api/v1/clusters/{cluster}/capabilities)
func (Unimplemented) GetHealth ¶
func (_ Unimplemented) GetHealth(w http.ResponseWriter, r *http.Request)
GetHealth Liveness probe. (GET /healthz)
func (Unimplemented) GetInfo ¶
func (_ Unimplemented) GetInfo(w http.ResponseWriter, r *http.Request)
GetInfo Build info. (GET /api/v1/info)
func (Unimplemented) GetMe ¶
func (_ Unimplemented) GetMe(w http.ResponseWriter, r *http.Request)
GetMe Resolved caller identity and effective permissions. (GET /api/v1/me)
func (Unimplemented) GetMessageTimeline ¶
func (_ Unimplemented) GetMessageTimeline(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params GetMessageTimelineParams)
GetMessageTimeline Time-sliced message volume over a time range for a topic. (GET /api/v1/clusters/{cluster}/topics/{topic}/messages/timeline)
func (Unimplemented) GetOpenApiSpec ¶
func (_ Unimplemented) GetOpenApiSpec(w http.ResponseWriter, r *http.Request)
GetOpenApiSpec This OpenAPI document. (GET /api/v1/openapi.yaml)
func (Unimplemented) GetReadiness ¶
func (_ Unimplemented) GetReadiness(w http.ResponseWriter, r *http.Request)
GetReadiness Readiness probe. 503 if any configured cluster is unreachable. (GET /readyz)
func (Unimplemented) GetSchemaVersion ¶
func (_ Unimplemented) GetSchemaVersion(w http.ResponseWriter, r *http.Request, cluster Cluster, subject Subject, version string, params GetSchemaVersionParams)
GetSchemaVersion Get a specific subject version (or `latest`). (GET /api/v1/clusters/{cluster}/schemas/subjects/{subject}/versions/{version})
func (Unimplemented) ListAcls ¶
func (_ Unimplemented) ListAcls(w http.ResponseWriter, r *http.Request, cluster Cluster, params ListAclsParams)
ListAcls List ACLs. (GET /api/v1/clusters/{cluster}/acls)
func (Unimplemented) ListBrokers ¶
func (_ Unimplemented) ListBrokers(w http.ResponseWriter, r *http.Request, cluster Cluster, params ListBrokersParams)
ListBrokers List the brokers of a cluster. (GET /api/v1/clusters/{cluster}/brokers)
func (Unimplemented) ListClusters ¶
func (_ Unimplemented) ListClusters(w http.ResponseWriter, r *http.Request)
ListClusters List configured clusters with reachability, capabilities and metrics. (GET /api/v1/clusters)
func (Unimplemented) ListGroups ¶
func (_ Unimplemented) ListGroups(w http.ResponseWriter, r *http.Request, cluster Cluster, params ListGroupsParams)
ListGroups List consumer groups (filtered by RBAC view permission). (GET /api/v1/clusters/{cluster}/groups)
func (Unimplemented) ListSchemaVersions ¶
func (_ Unimplemented) ListSchemaVersions(w http.ResponseWriter, r *http.Request, cluster Cluster, subject Subject, params ListSchemaVersionsParams)
ListSchemaVersions List versions of a subject. (GET /api/v1/clusters/{cluster}/schemas/subjects/{subject}/versions)
func (Unimplemented) ListScramUsers ¶
func (_ Unimplemented) ListScramUsers(w http.ResponseWriter, r *http.Request, cluster Cluster, params ListScramUsersParams)
ListScramUsers List SCRAM users (filtered by RBAC view permission). (GET /api/v1/clusters/{cluster}/users)
func (Unimplemented) ListSubjects ¶
func (_ Unimplemented) ListSubjects(w http.ResponseWriter, r *http.Request, cluster Cluster, params ListSubjectsParams)
ListSubjects List Schema Registry subjects with their versions (filtered by RBAC view permission). (GET /api/v1/clusters/{cluster}/schemas/subjects)
func (Unimplemented) ListTopicConsumers ¶
func (_ Unimplemented) ListTopicConsumers(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params ListTopicConsumersParams)
ListTopicConsumers Consumer groups that have committed offsets on, or are assigned to, this topic. (GET /api/v1/clusters/{cluster}/topics/{topic}/consumers)
func (Unimplemented) ListTopics ¶
func (_ Unimplemented) ListTopics(w http.ResponseWriter, r *http.Request, cluster Cluster, params ListTopicsParams)
ListTopics List topics (filtered by RBAC view permission). (GET /api/v1/clusters/{cluster}/topics)
func (Unimplemented) ProduceMessage ¶
func (_ Unimplemented) ProduceMessage(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params ProduceMessageParams)
ProduceMessage Produce a single record. (POST /api/v1/clusters/{cluster}/topics/{topic}/messages)
func (Unimplemented) RefreshCapabilities ¶
func (_ Unimplemented) RefreshCapabilities(w http.ResponseWriter, r *http.Request, cluster Cluster, params RefreshCapabilitiesParams)
RefreshCapabilities Re-probe capabilities (clears the cache). (POST /api/v1/clusters/{cluster}/capabilities/refresh)
func (Unimplemented) RegisterSchema ¶
func (_ Unimplemented) RegisterSchema(w http.ResponseWriter, r *http.Request, cluster Cluster, subject Subject, params RegisterSchemaParams)
RegisterSchema Register a new version for a subject. (POST /api/v1/clusters/{cluster}/schemas/subjects/{subject}/versions)
func (Unimplemented) ResetGroupOffsets ¶
func (_ Unimplemented) ResetGroupOffsets(w http.ResponseWriter, r *http.Request, cluster Cluster, group Group, params ResetGroupOffsetsParams)
ResetGroupOffsets Reset committed offsets of a group. (POST /api/v1/clusters/{cluster}/groups/{group}/reset-offsets)
func (Unimplemented) SampleMessages ¶
func (_ Unimplemented) SampleMessages(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params SampleMessagesParams)
SampleMessages Sample the last n decoded messages from a topic. (GET /api/v1/clusters/{cluster}/topics/{topic}/sample)
func (Unimplemented) SearchMessages ¶
func (_ Unimplemented) SearchMessages(w http.ResponseWriter, r *http.Request, cluster Cluster, topic Topic, params SearchMessagesParams)
SearchMessages Bounded, budget-limited content search across partitions. (POST /api/v1/clusters/{cluster}/topics/{topic}/messages/search)
func (Unimplemented) TestCluster ¶
func (_ Unimplemented) TestCluster(w http.ResponseWriter, r *http.Request, params TestClusterParams)
TestCluster Probe an ad-hoc cluster definition without storing it. (POST /api/v1/clusters/_test)
func (Unimplemented) UpsertScramUser ¶
func (_ Unimplemented) UpsertScramUser(w http.ResponseWriter, r *http.Request, cluster Cluster, params UpsertScramUserParams)
UpsertScramUser Create or update a SCRAM user. (POST /api/v1/clusters/{cluster}/users)
type UnmarshalingParamError ¶
func (*UnmarshalingParamError) Error ¶
func (e *UnmarshalingParamError) Error() string
func (*UnmarshalingParamError) Unwrap ¶
func (e *UnmarshalingParamError) Unwrap() error
type UpsertSCRAMUserRequest ¶
type UpsertSCRAMUserRequest struct {
// Iterations 0 = server default.
Iterations *int32 `json:"iterations,omitempty"`
Mechanism UpsertSCRAMUserRequestMechanism `json:"mechanism"`
Password string `json:"password"`
User string `json:"user"`
}
UpsertSCRAMUserRequest defines model for UpsertSCRAMUserRequest.
type UpsertSCRAMUserRequestMechanism ¶
type UpsertSCRAMUserRequestMechanism string
UpsertSCRAMUserRequestMechanism defines model for UpsertSCRAMUserRequest.Mechanism.
const ( UpsertSCRAMUserRequestMechanismSCRAMSHA256 UpsertSCRAMUserRequestMechanism = "SCRAM-SHA-256" UpsertSCRAMUserRequestMechanismSCRAMSHA512 UpsertSCRAMUserRequestMechanism = "SCRAM-SHA-512" )
Defines values for UpsertSCRAMUserRequestMechanism.
func (UpsertSCRAMUserRequestMechanism) Valid ¶
func (e UpsertSCRAMUserRequestMechanism) Valid() bool
Valid indicates whether the value is a known member of the UpsertSCRAMUserRequestMechanism enum.
type UpsertSCRAMUserResponse ¶
type UpsertSCRAMUserResponse struct {
Mechanism string `json:"mechanism"`
Ok bool `json:"ok"`
User string `json:"user"`
}
UpsertSCRAMUserResponse defines model for UpsertSCRAMUserResponse.
type UpsertScramUser200JSONResponse ¶
type UpsertScramUser200JSONResponse UpsertSCRAMUserResponse
func (UpsertScramUser200JSONResponse) VisitUpsertScramUserResponse ¶
func (response UpsertScramUser200JSONResponse) VisitUpsertScramUserResponse(w http.ResponseWriter) error
type UpsertScramUser400JSONResponse ¶
type UpsertScramUser400JSONResponse struct{ BadRequestJSONResponse }
func (UpsertScramUser400JSONResponse) VisitUpsertScramUserResponse ¶
func (response UpsertScramUser400JSONResponse) VisitUpsertScramUserResponse(w http.ResponseWriter) error
type UpsertScramUser401JSONResponse ¶
func (UpsertScramUser401JSONResponse) VisitUpsertScramUserResponse ¶
func (response UpsertScramUser401JSONResponse) VisitUpsertScramUserResponse(w http.ResponseWriter) error
type UpsertScramUser403JSONResponse ¶
type UpsertScramUser403JSONResponse struct{ ForbiddenJSONResponse }
func (UpsertScramUser403JSONResponse) VisitUpsertScramUserResponse ¶
func (response UpsertScramUser403JSONResponse) VisitUpsertScramUserResponse(w http.ResponseWriter) error
type UpsertScramUser404JSONResponse ¶
type UpsertScramUser404JSONResponse struct{ NotFoundJSONResponse }
func (UpsertScramUser404JSONResponse) VisitUpsertScramUserResponse ¶
func (response UpsertScramUser404JSONResponse) VisitUpsertScramUserResponse(w http.ResponseWriter) error
type UpsertScramUser502JSONResponse ¶
type UpsertScramUser502JSONResponse struct{ BadGatewayJSONResponse }
func (UpsertScramUser502JSONResponse) VisitUpsertScramUserResponse ¶
func (response UpsertScramUser502JSONResponse) VisitUpsertScramUserResponse(w http.ResponseWriter) error
type UpsertScramUserJSONRequestBody ¶
type UpsertScramUserJSONRequestBody = UpsertSCRAMUserRequest
UpsertScramUserJSONRequestBody defines body for UpsertScramUser for application/json ContentType.
type UpsertScramUserParams ¶
type UpsertScramUserParams struct {
// XKafkitoCluster Base64-encoded JSON `ClusterConfig` of a private (browser-stored) cluster, max 8 KiB decoded and at most 50 brokers. Honoured when the `{cluster}` path segment is `__private__` (required then). A malformed header or a definition that fails validation is rejected with 400; the message names the field and a fixed reason, a broker by its 1-based position, and never repeats a value from the header. SASL/PLAIN without TLS is rejected with 400 `plain_without_tls` unless the operator sets `private_clusters.allow_plain_without_tls`. When `private_clusters.mode` does not allow the caller private clusters, the header is never read: a `__private__` request gets 403 (`private_clusters_disabled` or `private_clusters_forbidden`), and any other request ignores it. On an allowed request kafkito's RBAC does not apply to the private cluster; the broker's ACLs do.
XKafkitoCluster *PrivateClusterHeader `json:"X-Kafkito-Cluster,omitempty"`
}
UpsertScramUserParams defines parameters for UpsertScramUser.
type UpsertScramUserRequestObject ¶
type UpsertScramUserRequestObject struct {
Cluster Cluster `json:"cluster"`
Params UpsertScramUserParams
Body *UpsertScramUserJSONRequestBody
}
type UpsertScramUserResponseObject ¶
type UpsertScramUserResponseObject interface {
VisitUpsertScramUserResponse(w http.ResponseWriter) error
}