Documentation
¶
Index ¶
- func CurrentDeploymentStatusTypeChoices() []string
- type ApplicationOut
- type ApplicationVersionIn
- type ApplicationVersionOut
- type ColumnOut
- type CurrentDeploymentOut
- type CurrentDeploymentStatusType
- type FlinkApplicationHandler
- func (h *FlinkApplicationHandler) ServiceFlinkCreateApplication(ctx context.Context, project string, serviceName string, ...) (*ServiceFlinkCreateApplicationOut, error)
- func (h *FlinkApplicationHandler) ServiceFlinkDeleteApplication(ctx context.Context, project string, serviceName string, applicationId string) (*ServiceFlinkDeleteApplicationOut, error)
- func (h *FlinkApplicationHandler) ServiceFlinkGetApplication(ctx context.Context, project string, serviceName string, applicationId string) (*ServiceFlinkGetApplicationOut, error)
- func (h *FlinkApplicationHandler) ServiceFlinkListApplications(ctx context.Context, project string, serviceName string) ([]ApplicationOut, error)
- func (h *FlinkApplicationHandler) ServiceFlinkUpdateApplication(ctx context.Context, project string, serviceName string, applicationId string, ...) (*ServiceFlinkUpdateApplicationOut, error)
- type Handler
- type ServiceFlinkCreateApplicationIn
- type ServiceFlinkCreateApplicationOut
- type ServiceFlinkDeleteApplicationOut
- type ServiceFlinkGetApplicationOut
- type ServiceFlinkUpdateApplicationIn
- type ServiceFlinkUpdateApplicationOut
- type SinkIn
- type SinkOut
- type SourceIn
- type SourceOut
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CurrentDeploymentStatusTypeChoices ¶ added in v0.3.0
func CurrentDeploymentStatusTypeChoices() []string
Types ¶
type ApplicationOut ¶
type ApplicationOut struct {
CreatedAt *time.Time `json:"created_at,omitempty"` // Created at
CreatedBy *string `json:"created_by,omitempty"` // Created by
Id string `json:"id"` // Application ID
Name string `json:"name"` // Application name
UpdatedAt *time.Time `json:"updated_at,omitempty"` // Updated at
UpdatedBy *string `json:"updated_by,omitempty"` // Updated by
}
type ApplicationVersionIn ¶
type ApplicationVersionIn struct {
Sinks []SinkIn `json:"sinks"`
Sources []SourceIn `json:"sources"`
Statement string `json:"statement"` // Job SQL statement
}
ApplicationVersionIn Flink ApplicationVersion
type ApplicationVersionOut ¶
type ApplicationVersionOut struct {
CreatedAt time.Time `json:"created_at"` // Created at
CreatedBy string `json:"created_by"` // Created by
Id string `json:"id"` // ApplicationVersion ID
Sinks []SinkOut `json:"sinks"`
Sources []SourceOut `json:"sources"`
Statement string `json:"statement"` // Job SQL statement
Version int `json:"version"` // Version number
}
type ColumnOut ¶
type ColumnOut struct {
DataType string `json:"data_type"` // The data type of the column
Extras *string `json:"extras,omitempty"` // Column extra information
Key *string `json:"key,omitempty"` // The key info of the column
Name string `json:"name"` // The name of the column
Nullable bool `json:"nullable"` // Whether the column is nullable, i.e. if true, the column is NOT NULL
Watermark *string `json:"watermark,omitempty"` // Information of the watermark if the column is used for watermark.
}
type CurrentDeploymentOut ¶
type CurrentDeploymentOut struct {
CreatedAt time.Time `json:"created_at"` // Created at
CreatedBy string `json:"created_by"` // Created by
ErrorMsg *string `json:"error_msg,omitempty"` // Deployment error
Id string `json:"id"` // Deployment ID
JobId *string `json:"job_id,omitempty"` // Job ID
LastSavepoint *string `json:"last_savepoint,omitempty"` // Job savepoint
Parallelism int `json:"parallelism"` // Flink Job parallelism
RestartEnabled bool `json:"restart_enabled"` // Specifies whether a Flink Job is restarted in case it fails
StartingSavepoint *string `json:"starting_savepoint,omitempty"` // Job savepoint
Status CurrentDeploymentStatusType `json:"status"` // Deployment status
VersionId string `json:"version_id"` // ApplicationVersion ID
}
CurrentDeploymentOut Flink ApplicationDeployment
type CurrentDeploymentStatusType ¶ added in v0.3.0
type CurrentDeploymentStatusType string
const ( CurrentDeploymentStatusTypeInitializing CurrentDeploymentStatusType = "INITIALIZING" CurrentDeploymentStatusTypeCreated CurrentDeploymentStatusType = "CREATED" CurrentDeploymentStatusTypeRunning CurrentDeploymentStatusType = "RUNNING" CurrentDeploymentStatusTypeFailing CurrentDeploymentStatusType = "FAILING" CurrentDeploymentStatusTypeFailed CurrentDeploymentStatusType = "FAILED" CurrentDeploymentStatusTypeSaving CurrentDeploymentStatusType = "SAVING" CurrentDeploymentStatusTypeCancellingRequested CurrentDeploymentStatusType = "CANCELLING_REQUESTED" CurrentDeploymentStatusTypeCancelling CurrentDeploymentStatusType = "CANCELLING" CurrentDeploymentStatusTypeCanceled CurrentDeploymentStatusType = "CANCELED" CurrentDeploymentStatusTypeSavingAndStopRequested CurrentDeploymentStatusType = "SAVING_AND_STOP_REQUESTED" CurrentDeploymentStatusTypeSavingAndStop CurrentDeploymentStatusType = "SAVING_AND_STOP" CurrentDeploymentStatusTypeFinished CurrentDeploymentStatusType = "FINISHED" CurrentDeploymentStatusTypeRestarting CurrentDeploymentStatusType = "RESTARTING" CurrentDeploymentStatusTypeSuspended CurrentDeploymentStatusType = "SUSPENDED" CurrentDeploymentStatusTypeDeleteRequested CurrentDeploymentStatusType = "DELETE_REQUESTED" CurrentDeploymentStatusTypeDeleting CurrentDeploymentStatusType = "DELETING" CurrentDeploymentStatusTypeReconciling CurrentDeploymentStatusType = "RECONCILING" )
type FlinkApplicationHandler ¶
type FlinkApplicationHandler struct {
// contains filtered or unexported fields
}
func NewHandler ¶
func NewHandler(doer doer) FlinkApplicationHandler
func (*FlinkApplicationHandler) ServiceFlinkCreateApplication ¶
func (h *FlinkApplicationHandler) ServiceFlinkCreateApplication(ctx context.Context, project string, serviceName string, in *ServiceFlinkCreateApplicationIn) (*ServiceFlinkCreateApplicationOut, error)
func (*FlinkApplicationHandler) ServiceFlinkDeleteApplication ¶
func (h *FlinkApplicationHandler) ServiceFlinkDeleteApplication(ctx context.Context, project string, serviceName string, applicationId string) (*ServiceFlinkDeleteApplicationOut, error)
func (*FlinkApplicationHandler) ServiceFlinkGetApplication ¶
func (h *FlinkApplicationHandler) ServiceFlinkGetApplication(ctx context.Context, project string, serviceName string, applicationId string) (*ServiceFlinkGetApplicationOut, error)
func (*FlinkApplicationHandler) ServiceFlinkListApplications ¶
func (h *FlinkApplicationHandler) ServiceFlinkListApplications(ctx context.Context, project string, serviceName string) ([]ApplicationOut, error)
func (*FlinkApplicationHandler) ServiceFlinkUpdateApplication ¶
func (h *FlinkApplicationHandler) ServiceFlinkUpdateApplication(ctx context.Context, project string, serviceName string, applicationId string, in *ServiceFlinkUpdateApplicationIn) (*ServiceFlinkUpdateApplicationOut, error)
type Handler ¶
type Handler interface {
// ServiceFlinkCreateApplication create a Flink Application
// POST /v1/project/{project}/service/{service_name}/flink/application
// https://api.aiven.io/doc/#tag/Service:_Flink/operation/ServiceFlinkCreateApplication
ServiceFlinkCreateApplication(ctx context.Context, project string, serviceName string, in *ServiceFlinkCreateApplicationIn) (*ServiceFlinkCreateApplicationOut, error)
// ServiceFlinkDeleteApplication delete a Flink Application
// DELETE /v1/project/{project}/service/{service_name}/flink/application/{application_id}
// https://api.aiven.io/doc/#tag/Service:_Flink/operation/ServiceFlinkDeleteApplication
ServiceFlinkDeleteApplication(ctx context.Context, project string, serviceName string, applicationId string) (*ServiceFlinkDeleteApplicationOut, error)
// ServiceFlinkGetApplication get a Flink Application
// GET /v1/project/{project}/service/{service_name}/flink/application/{application_id}
// https://api.aiven.io/doc/#tag/Service:_Flink/operation/ServiceFlinkGetApplication
ServiceFlinkGetApplication(ctx context.Context, project string, serviceName string, applicationId string) (*ServiceFlinkGetApplicationOut, error)
// ServiceFlinkListApplications get all Flink Applications
// GET /v1/project/{project}/service/{service_name}/flink/application
// https://api.aiven.io/doc/#tag/Service:_Flink/operation/ServiceFlinkListApplications
ServiceFlinkListApplications(ctx context.Context, project string, serviceName string) ([]ApplicationOut, error)
// ServiceFlinkUpdateApplication update a Flink Application
// PUT /v1/project/{project}/service/{service_name}/flink/application/{application_id}
// https://api.aiven.io/doc/#tag/Service:_Flink/operation/ServiceFlinkUpdateApplication
ServiceFlinkUpdateApplication(ctx context.Context, project string, serviceName string, applicationId string, in *ServiceFlinkUpdateApplicationIn) (*ServiceFlinkUpdateApplicationOut, error)
}
type ServiceFlinkCreateApplicationIn ¶
type ServiceFlinkCreateApplicationIn struct {
ApplicationVersion *ApplicationVersionIn `json:"application_version,omitempty"` // Flink ApplicationVersion
Name string `json:"name"` // Application name
}
ServiceFlinkCreateApplicationIn ServiceFlinkCreateApplicationRequestBody
type ServiceFlinkCreateApplicationOut ¶
type ServiceFlinkCreateApplicationOut struct {
ApplicationVersions []ApplicationVersionOut `json:"application_versions"`
CreatedAt time.Time `json:"created_at"` // Created at
CreatedBy string `json:"created_by"` // Created by
CurrentDeployment *CurrentDeploymentOut `json:"current_deployment,omitempty"` // Flink ApplicationDeployment
Id string `json:"id"` // Application ID
Name string `json:"name"` // Application name
UpdatedAt time.Time `json:"updated_at"` // Updated at
UpdatedBy string `json:"updated_by"` // Updated by
}
ServiceFlinkCreateApplicationOut ServiceFlinkCreateApplicationResponse
type ServiceFlinkDeleteApplicationOut ¶
type ServiceFlinkDeleteApplicationOut struct {
ApplicationVersions []ApplicationVersionOut `json:"application_versions"`
CreatedAt time.Time `json:"created_at"` // Created at
CreatedBy string `json:"created_by"` // Created by
CurrentDeployment *CurrentDeploymentOut `json:"current_deployment,omitempty"` // Flink ApplicationDeployment
Id string `json:"id"` // Application ID
Name string `json:"name"` // Application name
UpdatedAt time.Time `json:"updated_at"` // Updated at
UpdatedBy string `json:"updated_by"` // Updated by
}
ServiceFlinkDeleteApplicationOut ServiceFlinkDeleteApplicationResponse
type ServiceFlinkGetApplicationOut ¶
type ServiceFlinkGetApplicationOut struct {
ApplicationVersions []ApplicationVersionOut `json:"application_versions"`
CreatedAt time.Time `json:"created_at"` // Created at
CreatedBy string `json:"created_by"` // Created by
CurrentDeployment *CurrentDeploymentOut `json:"current_deployment,omitempty"` // Flink ApplicationDeployment
Id string `json:"id"` // Application ID
Name string `json:"name"` // Application name
UpdatedAt time.Time `json:"updated_at"` // Updated at
UpdatedBy string `json:"updated_by"` // Updated by
}
ServiceFlinkGetApplicationOut ServiceFlinkGetApplicationResponse
type ServiceFlinkUpdateApplicationIn ¶
type ServiceFlinkUpdateApplicationIn struct {
Name string `json:"name"` // Application name
}
ServiceFlinkUpdateApplicationIn ServiceFlinkUpdateApplicationRequestBody
type ServiceFlinkUpdateApplicationOut ¶
type ServiceFlinkUpdateApplicationOut struct {
ApplicationVersions []ApplicationVersionOut `json:"application_versions"`
CreatedAt time.Time `json:"created_at"` // Created at
CreatedBy string `json:"created_by"` // Created by
CurrentDeployment *CurrentDeploymentOut `json:"current_deployment,omitempty"` // Flink ApplicationDeployment
Id string `json:"id"` // Application ID
Name string `json:"name"` // Application name
UpdatedAt time.Time `json:"updated_at"` // Updated at
UpdatedBy string `json:"updated_by"` // Updated by
}
ServiceFlinkUpdateApplicationOut ServiceFlinkUpdateApplicationResponse
type SinkOut ¶
type SinkOut struct {
Columns []ColumnOut `json:"columns"`
CreateTable string `json:"create_table"` // The CREATE TABLE statement
IntegrationId *string `json:"integration_id,omitempty"` // Integration ID
Options map[string]any `json:"options"` // Option
TableId string `json:"table_id"` // Sink ID
TableName string `json:"table_name"` // Table name
}
type SourceOut ¶
type SourceOut struct {
Columns []ColumnOut `json:"columns"`
CreateTable string `json:"create_table"` // The CREATE TABLE statement
IntegrationId *string `json:"integration_id,omitempty"` // Integration ID
Options map[string]any `json:"options"` // Option
TableId string `json:"table_id"` // Source ID
TableName string `json:"table_name"` // Table name
}
Click to show internal directories.
Click to hide internal directories.