kafkaconnect

package
v0.36.0 Latest Latest
Warning

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

 Go to latest Published: Oct 4, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ConfigurationSchemaTypeChoices added in v0.3.0 

func ConfigurationSchemaTypeChoices() []string

func ImportanceTypeChoices added in v0.3.0 

func ImportanceTypeChoices() []string

func PluginTypeChoices added in v0.3.0 

func PluginTypeChoices() []string

func ServiceKafkaConnectConnectorStateTypeChoices added in v0.3.0 

func ServiceKafkaConnectConnectorStateTypeChoices() []string

func TaskStateTypeChoices added in v0.3.0 

func TaskStateTypeChoices() []string

func WidthTypeChoices added in v0.3.0 

func WidthTypeChoices() []string

Types

type ConfigOut 

type ConfigOut struct {
	ConnectorClass *string `json:"connector.class,omitempty"` // The Java class for the connector
	Name           string  `json:"name"`                      // Unique name for the connector
}

ConfigOut Connector configuration parameters

type ConfigurationSchemaOut 

type ConfigurationSchemaOut struct {
	DefaultValue  string                  `json:"default_value"` // Default value to be set if field omitted in configuration
	DisplayName   string                  `json:"display_name"`  // Human friendly name of the field
	Documentation string                  `json:"documentation"` // Assisting help text
	Group         string                  `json:"group"`         // Name of the field group to which the field belongs to
	Importance    ImportanceType          `json:"importance"`    // How important is the field
	Name          string                  `json:"name"`          // Machine friendly name of the field
	Order         int                     `json:"order"`         // Position of the field in the configuration form
	Required      bool                    `json:"required"`      // Defines if the field value is mandatory or not
	Type          ConfigurationSchemaType `json:"type"`          // Configuration value type
	Width         WidthType               `json:"width"`         // Expected length of the input value
}

type ConfigurationSchemaType added in v0.3.0 

type ConfigurationSchemaType string
const (
	ConfigurationSchemaTypeString   ConfigurationSchemaType = "STRING"
	ConfigurationSchemaTypeInt      ConfigurationSchemaType = "INT"
	ConfigurationSchemaTypeShort    ConfigurationSchemaType = "SHORT"
	ConfigurationSchemaTypeLong     ConfigurationSchemaType = "LONG"
	ConfigurationSchemaTypeDouble   ConfigurationSchemaType = "DOUBLE"
	ConfigurationSchemaTypeBoolean  ConfigurationSchemaType = "BOOLEAN"
	ConfigurationSchemaTypeList     ConfigurationSchemaType = "LIST"
	ConfigurationSchemaTypeClass    ConfigurationSchemaType = "CLASS"
	ConfigurationSchemaTypePassword ConfigurationSchemaType = "PASSWORD"
)

type ConnectorOut 

type ConnectorOut struct {
	Config ConfigOut `json:"config"` // Connector configuration parameters
	Name   string    `json:"name"`   // Connector name
	Plugin PluginOut `json:"plugin"` // Kafka Connector plugin information
	Tasks  []TaskOut `json:"tasks"`  // List of tasks of a connector
}

type Handler 

type Handler interface {
	// ServiceKafkaConnectCreateConnector create a Kafka Connect connector
	// POST /v1/project/{project}/service/{service_name}/connectors
	// https://api.aiven.io/doc/#tag/Service:_Kafka/operation/ServiceKafkaConnectCreateConnector
	ServiceKafkaConnectCreateConnector(ctx context.Context, project string, serviceName string, in *ServiceKafkaConnectCreateConnectorIn) (*ServiceKafkaConnectCreateConnectorOut, error)

	// ServiceKafkaConnectDeleteConnector delete Kafka Connect connector
	// DELETE /v1/project/{project}/service/{service_name}/connectors/{connector_name}
	// https://api.aiven.io/doc/#tag/Service:_Kafka/operation/ServiceKafkaConnectDeleteConnector
	ServiceKafkaConnectDeleteConnector(ctx context.Context, project string, serviceName string, connectorName string) error

	// ServiceKafkaConnectEditConnector edit Kafka Connect connector
	// PUT /v1/project/{project}/service/{service_name}/connectors/{connector_name}
	// https://api.aiven.io/doc/#tag/Service:_Kafka/operation/ServiceKafkaConnectEditConnector
	ServiceKafkaConnectEditConnector(ctx context.Context, project string, serviceName string, connectorName string, in *ServiceKafkaConnectEditConnectorIn) (*ServiceKafkaConnectEditConnectorOut, error)

	// ServiceKafkaConnectGetAvailableConnectors get available Kafka Connect connectors
	// GET /v1/project/{project}/service/{service_name}/available-connectors
	// https://api.aiven.io/doc/#tag/Service:_Kafka/operation/ServiceKafkaConnectGetAvailableConnectors
	ServiceKafkaConnectGetAvailableConnectors(ctx context.Context, project string, serviceName string) ([]ServiceKafkaConnectGetAvailableConnectorsOut, error)

	// ServiceKafkaConnectGetConnectorConfiguration get Kafka Connect connector configuration schema
	// GET /v1/project/{project}/service/{service_name}/connector-plugins/{connector_name}/configuration
	// https://api.aiven.io/doc/#tag/Service:_Kafka/operation/ServiceKafkaConnectGetConnectorConfiguration
	ServiceKafkaConnectGetConnectorConfiguration(ctx context.Context, project string, serviceName string, connectorName string) ([]ConfigurationSchemaOut, error)

	// ServiceKafkaConnectGetConnectorStatus get a Kafka Connect Connector status
	// GET /v1/project/{project}/service/{service_name}/connectors/{connector_name}/status
	// https://api.aiven.io/doc/#tag/Service:_Kafka/operation/ServiceKafkaConnectGetConnectorStatus
	ServiceKafkaConnectGetConnectorStatus(ctx context.Context, project string, serviceName string, connectorName string) (*ServiceKafkaConnectGetConnectorStatusOut, error)

	// ServiceKafkaConnectList lists Kafka connectors
	// GET /v1/project/{project}/service/{service_name}/connectors
	// https://api.aiven.io/doc/#tag/Service:_Kafka/operation/ServiceKafkaConnectList
	ServiceKafkaConnectList(ctx context.Context, project string, serviceName string) ([]ConnectorOut, error)

	// ServiceKafkaConnectPauseConnector pause a Kafka Connect Connector
	// POST /v1/project/{project}/service/{service_name}/connectors/{connector_name}/pause
	// https://api.aiven.io/doc/#tag/Service:_Kafka/operation/ServiceKafkaConnectPauseConnector
	ServiceKafkaConnectPauseConnector(ctx context.Context, project string, serviceName string, connectorName string) error

	// ServiceKafkaConnectRestartConnector restart a Kafka Connect Connector
	// POST /v1/project/{project}/service/{service_name}/connectors/{connector_name}/restart
	// https://api.aiven.io/doc/#tag/Service:_Kafka/operation/ServiceKafkaConnectRestartConnector
	ServiceKafkaConnectRestartConnector(ctx context.Context, project string, serviceName string, connectorName string) error

	// ServiceKafkaConnectRestartConnectorTask restart a Kafka Connect Connector task
	// POST /v1/project/{project}/service/{service_name}/connectors/{connector_name}/tasks/{task_id}/restart
	// https://api.aiven.io/doc/#tag/Service:_Kafka/operation/ServiceKafkaConnectRestartConnectorTask
	ServiceKafkaConnectRestartConnectorTask(ctx context.Context, project string, serviceName string, connectorName string, taskId string) error

	// ServiceKafkaConnectResumeConnector resume a Kafka Connect Connector
	// POST /v1/project/{project}/service/{service_name}/connectors/{connector_name}/resume
	// https://api.aiven.io/doc/#tag/Service:_Kafka/operation/ServiceKafkaConnectResumeConnector
	ServiceKafkaConnectResumeConnector(ctx context.Context, project string, serviceName string, connectorName string) error
}

type ImportanceType added in v0.3.0 

type ImportanceType string
const (
	ImportanceTypeLow    ImportanceType = "LOW"
	ImportanceTypeMedium ImportanceType = "MEDIUM"
	ImportanceTypeHigh   ImportanceType = "HIGH"
)

type KafkaConnectHandler 

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

func NewHandler 

func NewHandler(doer doer) KafkaConnectHandler

func (*KafkaConnectHandler) ServiceKafkaConnectCreateConnector 

func (h *KafkaConnectHandler) ServiceKafkaConnectCreateConnector(ctx context.Context, project string, serviceName string, in *ServiceKafkaConnectCreateConnectorIn) (*ServiceKafkaConnectCreateConnectorOut, error)

func (*KafkaConnectHandler) ServiceKafkaConnectDeleteConnector 

func (h *KafkaConnectHandler) ServiceKafkaConnectDeleteConnector(ctx context.Context, project string, serviceName string, connectorName string) error

func (*KafkaConnectHandler) ServiceKafkaConnectEditConnector 

func (h *KafkaConnectHandler) ServiceKafkaConnectEditConnector(ctx context.Context, project string, serviceName string, connectorName string, in *ServiceKafkaConnectEditConnectorIn) (*ServiceKafkaConnectEditConnectorOut, error)

func (*KafkaConnectHandler) ServiceKafkaConnectGetAvailableConnectors 

func (h *KafkaConnectHandler) ServiceKafkaConnectGetAvailableConnectors(ctx context.Context, project string, serviceName string) ([]ServiceKafkaConnectGetAvailableConnectorsOut, error)

func (*KafkaConnectHandler) ServiceKafkaConnectGetConnectorConfiguration 

func (h *KafkaConnectHandler) ServiceKafkaConnectGetConnectorConfiguration(ctx context.Context, project string, serviceName string, connectorName string) ([]ConfigurationSchemaOut, error)

func (*KafkaConnectHandler) ServiceKafkaConnectGetConnectorStatus 

func (h *KafkaConnectHandler) ServiceKafkaConnectGetConnectorStatus(ctx context.Context, project string, serviceName string, connectorName string) (*ServiceKafkaConnectGetConnectorStatusOut, error)

func (*KafkaConnectHandler) ServiceKafkaConnectList 

func (h *KafkaConnectHandler) ServiceKafkaConnectList(ctx context.Context, project string, serviceName string) ([]ConnectorOut, error)

func (*KafkaConnectHandler) ServiceKafkaConnectPauseConnector 

func (h *KafkaConnectHandler) ServiceKafkaConnectPauseConnector(ctx context.Context, project string, serviceName string, connectorName string) error

func (*KafkaConnectHandler) ServiceKafkaConnectRestartConnector 

func (h *KafkaConnectHandler) ServiceKafkaConnectRestartConnector(ctx context.Context, project string, serviceName string, connectorName string) error

func (*KafkaConnectHandler) ServiceKafkaConnectRestartConnectorTask 

func (h *KafkaConnectHandler) ServiceKafkaConnectRestartConnectorTask(ctx context.Context, project string, serviceName string, connectorName string, taskId string) error

func (*KafkaConnectHandler) ServiceKafkaConnectResumeConnector 

func (h *KafkaConnectHandler) ServiceKafkaConnectResumeConnector(ctx context.Context, project string, serviceName string, connectorName string) error

type PluginOut 

type PluginOut struct {
	Author      string     `json:"author"`                 // Connector author name
	Class       string     `json:"class"`                  // Connector class name
	DocUrl      string     `json:"docURL"`                 // Connector documentation URL
	Preview     *bool      `json:"preview,omitempty"`      // Describes if connector is in beta
	PreviewInfo *string    `json:"preview_info,omitempty"` // Information about beta stage of connector
	Title       string     `json:"title"`                  // Descriptive human readable name defined by Aiven
	Type        PluginType `json:"type"`                   // Describes whether data flows from or to Kafka
	Version     string     `json:"version"`                // Connector version number
}

PluginOut Kafka Connector plugin information

type PluginType added in v0.3.0 

type PluginType string
const (
	PluginTypeSink    PluginType = "sink"
	PluginTypeSource  PluginType = "source"
	PluginTypeUnknown PluginType = "unknown"
)

type ServiceKafkaConnectConnectorStateType added in v0.3.0 

type ServiceKafkaConnectConnectorStateType string
const (
	ServiceKafkaConnectConnectorStateTypeFailed     ServiceKafkaConnectConnectorStateType = "FAILED"
	ServiceKafkaConnectConnectorStateTypePaused     ServiceKafkaConnectConnectorStateType = "PAUSED"
	ServiceKafkaConnectConnectorStateTypeRunning    ServiceKafkaConnectConnectorStateType = "RUNNING"
	ServiceKafkaConnectConnectorStateTypeUnassigned ServiceKafkaConnectConnectorStateType = "UNASSIGNED"
)

type ServiceKafkaConnectCreateConnectorIn 

type ServiceKafkaConnectCreateConnectorIn struct {
	ConnectorClass *string `json:"connector.class,omitempty"` // The Java class for the connector
	Name           string  `json:"name"`                      // Unique name for the connector
}

ServiceKafkaConnectCreateConnectorIn ServiceKafkaConnectCreateConnectorRequestBody

type ServiceKafkaConnectCreateConnectorOut 

type ServiceKafkaConnectCreateConnectorOut struct {
	Config ConfigOut `json:"config"` // Connector configuration parameters
	Name   string    `json:"name"`   // Connector name
	Plugin PluginOut `json:"plugin"` // Kafka Connector plugin information
	Tasks  []TaskOut `json:"tasks"`  // List of tasks of a connector
}

ServiceKafkaConnectCreateConnectorOut Kafka connector information

type ServiceKafkaConnectEditConnectorIn 

type ServiceKafkaConnectEditConnectorIn struct {
	ConnectorClass *string `json:"connector.class,omitempty"` // The Java class for the connector
	Name           string  `json:"name"`                      // Unique name for the connector
}

ServiceKafkaConnectEditConnectorIn ServiceKafkaConnectEditConnectorRequestBody

type ServiceKafkaConnectEditConnectorOut 

type ServiceKafkaConnectEditConnectorOut struct {
	Config ConfigOut `json:"config"` // Connector configuration parameters
	Name   string    `json:"name"`   // Connector name
	Plugin PluginOut `json:"plugin"` // Kafka Connector plugin information
	Tasks  []TaskOut `json:"tasks"`  // List of tasks of a connector
}

ServiceKafkaConnectEditConnectorOut Kafka connector information

type ServiceKafkaConnectGetAvailableConnectorsOut added in v0.36.0 

type ServiceKafkaConnectGetAvailableConnectorsOut struct {
	Author      string     `json:"author"`                 // Connector author name
	Class       string     `json:"class"`                  // Connector class name
	DocUrl      string     `json:"docURL"`                 // Connector documentation URL
	Preview     *bool      `json:"preview,omitempty"`      // Describes if connector is in beta
	PreviewInfo *string    `json:"preview_info,omitempty"` // Information about beta stage of connector
	Title       string     `json:"title"`                  // Descriptive human readable name defined by Aiven
	Type        PluginType `json:"type"`                   // Describes whether data flows from or to Kafka
	Version     string     `json:"version"`                // Connector version number
}

type ServiceKafkaConnectGetConnectorStatusOut 

type ServiceKafkaConnectGetConnectorStatusOut struct {
	State ServiceKafkaConnectConnectorStateType          `json:"state"` // Current status of the connector
	Tasks []ServiceKafkaConnectGetConnectorStatusTaskOut `json:"tasks"` // List of tasks currently running for the connector
}

ServiceKafkaConnectGetConnectorStatusOut Connector status information

type ServiceKafkaConnectGetConnectorStatusTaskOut added in v0.36.0 

type ServiceKafkaConnectGetConnectorStatusTaskOut struct {
	Id    int           `json:"id"`    // Task identifier
	State TaskStateType `json:"state"` // Current status of the task
	Trace string        `json:"trace"` // Task error information
}

type TaskOut 

type TaskOut struct {
	Connector string `json:"connector"` // Related connector name
	Task      int    `json:"task"`      // Task id / number
}

type TaskStateType added in v0.3.0 

type TaskStateType string
const (
	TaskStateTypeFailed     TaskStateType = "FAILED"
	TaskStateTypePaused     TaskStateType = "PAUSED"
	TaskStateTypeRunning    TaskStateType = "RUNNING"
	TaskStateTypeUnassigned TaskStateType = "UNASSIGNED"
)

type WidthType added in v0.3.0 

type WidthType string
const (
	WidthTypeNone   WidthType = "NONE"
	WidthTypeShort  WidthType = "SHORT"
	WidthTypeMedium WidthType = "MEDIUM"
	WidthTypeLong   WidthType = "LONG"
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

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