Documentation
¶
Index ¶
- func PermissionTypeChoices() []string
- type AclOut
- type Handler
- type HourlyOut
- type KafkaHandler
- func (h *KafkaHandler) ServiceKafkaAclAdd(ctx context.Context, project string, serviceName string, ...) ([]AclOut, error)
- func (h *KafkaHandler) ServiceKafkaAclDelete(ctx context.Context, project string, serviceName string, kafkaAclId string) ([]AclOut, error)
- func (h *KafkaHandler) ServiceKafkaAclList(ctx context.Context, project string, serviceName string) ([]AclOut, error)
- func (h *KafkaHandler) ServiceKafkaQuotaCreate(ctx context.Context, project string, serviceName string, ...) error
- func (h *KafkaHandler) ServiceKafkaQuotaDelete(ctx context.Context, project string, serviceName string) error
- func (h *KafkaHandler) ServiceKafkaQuotaDescribe(ctx context.Context, project string, serviceName string) (*ServiceKafkaQuotaDescribeOut, error)
- func (h *KafkaHandler) ServiceKafkaQuotaList(ctx context.Context, project string, serviceName string) ([]QuotaOut, error)
- func (h *KafkaHandler) ServiceKafkaTieredStorageStorageUsageByTopic(ctx context.Context, project string, serviceName string) (map[string]any, error)
- func (h *KafkaHandler) ServiceKafkaTieredStorageStorageUsageTotal(ctx context.Context, project string, serviceName string) (int, error)
- func (h *KafkaHandler) ServiceKafkaTieredStorageSummary(ctx context.Context, project string, serviceName string) (*ServiceKafkaTieredStorageSummaryOut, error)
- type PermissionType
- type QuotaOut
- type ServiceKafkaAclAddIn
- type ServiceKafkaQuotaCreateIn
- type ServiceKafkaQuotaDescribeOut
- type ServiceKafkaTieredStorageSummaryOut
- type StorageUsageHistoryOut
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PermissionTypeChoices ¶
func PermissionTypeChoices() []string
Types ¶
type AclOut ¶
type AclOut struct {
Id string `json:"id,omitempty"`
Permission PermissionType `json:"permission"`
Topic string `json:"topic"`
Username string `json:"username"`
}
type Handler ¶
type Handler interface {
// ServiceKafkaAclAdd add a Kafka ACL entry
// POST /v1/project/{project}/service/{service_name}/acl
// https://api.aiven.io/doc/#tag/Service:_Kafka/operation/ServiceKafkaAclAdd
ServiceKafkaAclAdd(ctx context.Context, project string, serviceName string, in *ServiceKafkaAclAddIn) ([]AclOut, error)
// ServiceKafkaAclDelete delete a Kafka ACL entry
// DELETE /v1/project/{project}/service/{service_name}/acl/{kafka_acl_id}
// https://api.aiven.io/doc/#tag/Service:_Kafka/operation/ServiceKafkaAclDelete
ServiceKafkaAclDelete(ctx context.Context, project string, serviceName string, kafkaAclId string) ([]AclOut, error)
// ServiceKafkaAclList list Kafka ACL entries
// GET /v1/project/{project}/service/{service_name}/acl
// https://api.aiven.io/doc/#tag/Service:_Kafka/operation/ServiceKafkaAclList
ServiceKafkaAclList(ctx context.Context, project string, serviceName string) ([]AclOut, error)
// ServiceKafkaQuotaCreate create Kafka quota
// POST /v1/project/{project}/service/{service_name}/quota
// https://api.aiven.io/doc/#tag/Service:_Kafka/operation/ServiceKafkaQuotaCreate
ServiceKafkaQuotaCreate(ctx context.Context, project string, serviceName string, in *ServiceKafkaQuotaCreateIn) error
// ServiceKafkaQuotaDelete delete Kafka quota
// DELETE /v1/project/{project}/service/{service_name}/quota
// https://api.aiven.io/doc/#tag/Service:_Kafka/operation/ServiceKafkaQuotaDelete
ServiceKafkaQuotaDelete(ctx context.Context, project string, serviceName string) error
// ServiceKafkaQuotaDescribe describe Specific Kafka quotas
// GET /v1/project/{project}/service/{service_name}/quota/describe
// https://api.aiven.io/doc/#tag/Service:_Kafka/operation/ServiceKafkaQuotaDescribe
ServiceKafkaQuotaDescribe(ctx context.Context, project string, serviceName string) (*ServiceKafkaQuotaDescribeOut, error)
// ServiceKafkaQuotaList list Kafka quotas
// GET /v1/project/{project}/service/{service_name}/quota
// https://api.aiven.io/doc/#tag/Service:_Kafka/operation/ServiceKafkaQuotaList
ServiceKafkaQuotaList(ctx context.Context, project string, serviceName string) ([]QuotaOut, error)
// ServiceKafkaTieredStorageStorageUsageByTopic get the Kafka tiered storage object storage usage by topic
// GET /v1/project/{project}/service/{service_name}/kafka/tiered-storage/storage-usage/by-topic
// https://api.aiven.io/doc/#tag/Service:_Kafka/operation/ServiceKafkaTieredStorageStorageUsageByTopic
ServiceKafkaTieredStorageStorageUsageByTopic(ctx context.Context, project string, serviceName string) (map[string]any, error)
// ServiceKafkaTieredStorageStorageUsageTotal get the Kafka tiered storage total object storage usage
// GET /v1/project/{project}/service/{service_name}/kafka/tiered-storage/storage-usage/total
// https://api.aiven.io/doc/#tag/Service:_Kafka/operation/ServiceKafkaTieredStorageStorageUsageTotal
ServiceKafkaTieredStorageStorageUsageTotal(ctx context.Context, project string, serviceName string) (int, error)
// ServiceKafkaTieredStorageSummary get the Kafka tiered storage summary
// GET /v1/project/{project}/service/{service_name}/kafka/tiered-storage/summary
// https://api.aiven.io/doc/#tag/Service:_Kafka/operation/ServiceKafkaTieredStorageSummary
ServiceKafkaTieredStorageSummary(ctx context.Context, project string, serviceName string) (*ServiceKafkaTieredStorageSummaryOut, error)
}
type KafkaHandler ¶
type KafkaHandler struct {
// contains filtered or unexported fields
}
func NewHandler ¶
func NewHandler(doer doer) KafkaHandler
func (*KafkaHandler) ServiceKafkaAclAdd ¶
func (h *KafkaHandler) ServiceKafkaAclAdd(ctx context.Context, project string, serviceName string, in *ServiceKafkaAclAddIn) ([]AclOut, error)
func (*KafkaHandler) ServiceKafkaAclDelete ¶
func (*KafkaHandler) ServiceKafkaAclList ¶
func (*KafkaHandler) ServiceKafkaQuotaCreate ¶
func (h *KafkaHandler) ServiceKafkaQuotaCreate(ctx context.Context, project string, serviceName string, in *ServiceKafkaQuotaCreateIn) error
func (*KafkaHandler) ServiceKafkaQuotaDelete ¶
func (*KafkaHandler) ServiceKafkaQuotaDescribe ¶
func (h *KafkaHandler) ServiceKafkaQuotaDescribe(ctx context.Context, project string, serviceName string) (*ServiceKafkaQuotaDescribeOut, error)
func (*KafkaHandler) ServiceKafkaQuotaList ¶
func (*KafkaHandler) ServiceKafkaTieredStorageStorageUsageByTopic ¶
func (*KafkaHandler) ServiceKafkaTieredStorageStorageUsageTotal ¶
func (*KafkaHandler) ServiceKafkaTieredStorageSummary ¶
func (h *KafkaHandler) ServiceKafkaTieredStorageSummary(ctx context.Context, project string, serviceName string) (*ServiceKafkaTieredStorageSummaryOut, error)
type PermissionType ¶
type PermissionType string
const ( PermissionTypeAdmin PermissionType = "admin" PermissionTypeRead PermissionType = "read" PermissionTypeReadwrite PermissionType = "readwrite" PermissionTypeWrite PermissionType = "write" )
type ServiceKafkaAclAddIn ¶
type ServiceKafkaAclAddIn struct {
Permission PermissionType `json:"permission"`
Topic string `json:"topic"`
Username string `json:"username"`
}
type ServiceKafkaQuotaCreateIn ¶
type ServiceKafkaQuotaCreateIn struct {
ClientId string `json:"client-id,omitempty"`
ConsumerByteRate *float64 `json:"consumer_byte_rate,omitempty"`
ProducerByteRate *float64 `json:"producer_byte_rate,omitempty"`
RequestPercentage *float64 `json:"request_percentage,omitempty"`
User string `json:"user,omitempty"`
}
type ServiceKafkaTieredStorageSummaryOut ¶
type ServiceKafkaTieredStorageSummaryOut struct {
CurrentCost string `json:"current_cost"`
ForecastedCost string `json:"forecasted_cost"`
ForecastedRate string `json:"forecasted_rate,omitempty"`
StorageUsageHistory StorageUsageHistoryOut `json:"storage_usage_history"`
TotalStorageUsage int `json:"total_storage_usage"`
}
type StorageUsageHistoryOut ¶
type StorageUsageHistoryOut struct {
Hourly []HourlyOut `json:"hourly"`
}
Click to show internal directories.
Click to hide internal directories.