flinkapplicationdeployment

package
v0.84.0 Latest Latest
Warning

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

Go to latest
Published: Feb 5, 2025 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DeploymentStatusTypeChoices added in v0.3.0

func DeploymentStatusTypeChoices() []string

func ServiceFlinkApplicationDeploymentStatusTypeChoices added in v0.3.0

func ServiceFlinkApplicationDeploymentStatusTypeChoices() []string

Types

type DeploymentOut

type DeploymentOut struct {
	CreatedAt         time.Time            `json:"created_at"`                   // The creation timestamp of this entity in ISO 8601 format, always in UTC
	CreatedBy         string               `json:"created_by"`                   // The creator of this entity
	ErrorMsg          *string              `json:"error_msg,omitempty"`          // Error message describing what caused deployment to fail
	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"`                  // Reading of Flink parallel execution documentation is recommended before setting this value to other than 1. Please do not set this value higher than (total number of nodes x number_of_task_slots), or every new job created will fail.
	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            DeploymentStatusType `json:"status"`                       // Deployment status
	VersionId         string               `json:"version_id"`                   // ApplicationVersion ID
}

type DeploymentStatusType added in v0.3.0

type DeploymentStatusType string
const (
	DeploymentStatusTypeCanceled               DeploymentStatusType = "CANCELED"
	DeploymentStatusTypeCancelling             DeploymentStatusType = "CANCELLING"
	DeploymentStatusTypeCancellingRequested    DeploymentStatusType = "CANCELLING_REQUESTED"
	DeploymentStatusTypeCreated                DeploymentStatusType = "CREATED"
	DeploymentStatusTypeDeleteRequested        DeploymentStatusType = "DELETE_REQUESTED"
	DeploymentStatusTypeDeleting               DeploymentStatusType = "DELETING"
	DeploymentStatusTypeFailed                 DeploymentStatusType = "FAILED"
	DeploymentStatusTypeFailing                DeploymentStatusType = "FAILING"
	DeploymentStatusTypeFinished               DeploymentStatusType = "FINISHED"
	DeploymentStatusTypeInitializing           DeploymentStatusType = "INITIALIZING"
	DeploymentStatusTypeReconciling            DeploymentStatusType = "RECONCILING"
	DeploymentStatusTypeRestarting             DeploymentStatusType = "RESTARTING"
	DeploymentStatusTypeRunning                DeploymentStatusType = "RUNNING"
	DeploymentStatusTypeSaving                 DeploymentStatusType = "SAVING"
	DeploymentStatusTypeSavingAndStop          DeploymentStatusType = "SAVING_AND_STOP"
	DeploymentStatusTypeSavingAndStopRequested DeploymentStatusType = "SAVING_AND_STOP_REQUESTED"
	DeploymentStatusTypeSuspended              DeploymentStatusType = "SUSPENDED"
)

type FlinkApplicationDeploymentHandler

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

func NewHandler

func NewHandler(doer doer) FlinkApplicationDeploymentHandler

func (*FlinkApplicationDeploymentHandler) ServiceFlinkCancelApplicationDeployment

func (h *FlinkApplicationDeploymentHandler) ServiceFlinkCancelApplicationDeployment(ctx context.Context, project string, serviceName string, applicationId string, deploymentId string) (*ServiceFlinkCancelApplicationDeploymentOut, error)

func (*FlinkApplicationDeploymentHandler) ServiceFlinkCreateApplicationDeployment

func (h *FlinkApplicationDeploymentHandler) ServiceFlinkCreateApplicationDeployment(ctx context.Context, project string, serviceName string, applicationId string, in *ServiceFlinkCreateApplicationDeploymentIn) (*ServiceFlinkCreateApplicationDeploymentOut, error)

func (*FlinkApplicationDeploymentHandler) ServiceFlinkDeleteApplicationDeployment

func (h *FlinkApplicationDeploymentHandler) ServiceFlinkDeleteApplicationDeployment(ctx context.Context, project string, serviceName string, applicationId string, deploymentId string) (*ServiceFlinkDeleteApplicationDeploymentOut, error)

func (*FlinkApplicationDeploymentHandler) ServiceFlinkGetApplicationDeployment

func (h *FlinkApplicationDeploymentHandler) ServiceFlinkGetApplicationDeployment(ctx context.Context, project string, serviceName string, applicationId string, deploymentId string) (*ServiceFlinkGetApplicationDeploymentOut, error)

func (*FlinkApplicationDeploymentHandler) ServiceFlinkListApplicationDeployments

func (h *FlinkApplicationDeploymentHandler) ServiceFlinkListApplicationDeployments(ctx context.Context, project string, serviceName string, applicationId string) ([]DeploymentOut, error)

func (*FlinkApplicationDeploymentHandler) ServiceFlinkStopApplicationDeployment

func (h *FlinkApplicationDeploymentHandler) ServiceFlinkStopApplicationDeployment(ctx context.Context, project string, serviceName string, applicationId string, deploymentId string) (*ServiceFlinkStopApplicationDeploymentOut, error)

type Handler

type Handler interface {
	// ServiceFlinkCancelApplicationDeployment cancel an ApplicationDeployment
	// POST /v1/project/{project}/service/{service_name}/flink/application/{application_id}/deployment/{deployment_id}/cancel
	// https://api.aiven.io/doc/#tag/Service:_Flink/operation/ServiceFlinkCancelApplicationDeployment
	ServiceFlinkCancelApplicationDeployment(ctx context.Context, project string, serviceName string, applicationId string, deploymentId string) (*ServiceFlinkCancelApplicationDeploymentOut, error)

	// ServiceFlinkCreateApplicationDeployment create an ApplicationDeployment
	// POST /v1/project/{project}/service/{service_name}/flink/application/{application_id}/deployment
	// https://api.aiven.io/doc/#tag/Service:_Flink/operation/ServiceFlinkCreateApplicationDeployment
	ServiceFlinkCreateApplicationDeployment(ctx context.Context, project string, serviceName string, applicationId string, in *ServiceFlinkCreateApplicationDeploymentIn) (*ServiceFlinkCreateApplicationDeploymentOut, error)

	// ServiceFlinkDeleteApplicationDeployment delete an ApplicationDeployment
	// DELETE /v1/project/{project}/service/{service_name}/flink/application/{application_id}/deployment/{deployment_id}
	// https://api.aiven.io/doc/#tag/Service:_Flink/operation/ServiceFlinkDeleteApplicationDeployment
	ServiceFlinkDeleteApplicationDeployment(ctx context.Context, project string, serviceName string, applicationId string, deploymentId string) (*ServiceFlinkDeleteApplicationDeploymentOut, error)

	// ServiceFlinkGetApplicationDeployment get an ApplicationDeployment
	// GET /v1/project/{project}/service/{service_name}/flink/application/{application_id}/deployment/{deployment_id}
	// https://api.aiven.io/doc/#tag/Service:_Flink/operation/ServiceFlinkGetApplicationDeployment
	ServiceFlinkGetApplicationDeployment(ctx context.Context, project string, serviceName string, applicationId string, deploymentId string) (*ServiceFlinkGetApplicationDeploymentOut, error)

	// ServiceFlinkListApplicationDeployments get all ApplicationDeployments
	// GET /v1/project/{project}/service/{service_name}/flink/application/{application_id}/deployment
	// https://api.aiven.io/doc/#tag/Service:_Flink/operation/ServiceFlinkListApplicationDeployments
	ServiceFlinkListApplicationDeployments(ctx context.Context, project string, serviceName string, applicationId string) ([]DeploymentOut, error)

	// ServiceFlinkStopApplicationDeployment stop an ApplicationDeployment
	// POST /v1/project/{project}/service/{service_name}/flink/application/{application_id}/deployment/{deployment_id}/stop
	// https://api.aiven.io/doc/#tag/Service:_Flink/operation/ServiceFlinkStopApplicationDeployment
	ServiceFlinkStopApplicationDeployment(ctx context.Context, project string, serviceName string, applicationId string, deploymentId string) (*ServiceFlinkStopApplicationDeploymentOut, error)
}

type ServiceFlinkApplicationDeploymentStatusType added in v0.3.0

type ServiceFlinkApplicationDeploymentStatusType string
const (
	ServiceFlinkApplicationDeploymentStatusTypeCanceled               ServiceFlinkApplicationDeploymentStatusType = "CANCELED"
	ServiceFlinkApplicationDeploymentStatusTypeCancelling             ServiceFlinkApplicationDeploymentStatusType = "CANCELLING"
	ServiceFlinkApplicationDeploymentStatusTypeCancellingRequested    ServiceFlinkApplicationDeploymentStatusType = "CANCELLING_REQUESTED"
	ServiceFlinkApplicationDeploymentStatusTypeCreated                ServiceFlinkApplicationDeploymentStatusType = "CREATED"
	ServiceFlinkApplicationDeploymentStatusTypeDeleteRequested        ServiceFlinkApplicationDeploymentStatusType = "DELETE_REQUESTED"
	ServiceFlinkApplicationDeploymentStatusTypeDeleting               ServiceFlinkApplicationDeploymentStatusType = "DELETING"
	ServiceFlinkApplicationDeploymentStatusTypeFailed                 ServiceFlinkApplicationDeploymentStatusType = "FAILED"
	ServiceFlinkApplicationDeploymentStatusTypeFailing                ServiceFlinkApplicationDeploymentStatusType = "FAILING"
	ServiceFlinkApplicationDeploymentStatusTypeFinished               ServiceFlinkApplicationDeploymentStatusType = "FINISHED"
	ServiceFlinkApplicationDeploymentStatusTypeInitializing           ServiceFlinkApplicationDeploymentStatusType = "INITIALIZING"
	ServiceFlinkApplicationDeploymentStatusTypeReconciling            ServiceFlinkApplicationDeploymentStatusType = "RECONCILING"
	ServiceFlinkApplicationDeploymentStatusTypeRestarting             ServiceFlinkApplicationDeploymentStatusType = "RESTARTING"
	ServiceFlinkApplicationDeploymentStatusTypeRunning                ServiceFlinkApplicationDeploymentStatusType = "RUNNING"
	ServiceFlinkApplicationDeploymentStatusTypeSaving                 ServiceFlinkApplicationDeploymentStatusType = "SAVING"
	ServiceFlinkApplicationDeploymentStatusTypeSavingAndStop          ServiceFlinkApplicationDeploymentStatusType = "SAVING_AND_STOP"
	ServiceFlinkApplicationDeploymentStatusTypeSavingAndStopRequested ServiceFlinkApplicationDeploymentStatusType = "SAVING_AND_STOP_REQUESTED"
	ServiceFlinkApplicationDeploymentStatusTypeSuspended              ServiceFlinkApplicationDeploymentStatusType = "SUSPENDED"
)

type ServiceFlinkCancelApplicationDeploymentOut

type ServiceFlinkCancelApplicationDeploymentOut struct {
	CreatedAt         time.Time                                   `json:"created_at"`                   // The creation timestamp of this entity in ISO 8601 format, always in UTC
	CreatedBy         string                                      `json:"created_by"`                   // The creator of this entity
	ErrorMsg          *string                                     `json:"error_msg,omitempty"`          // Error message describing what caused deployment to fail
	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"`                  // Reading of Flink parallel execution documentation is recommended before setting this value to other than 1. Please do not set this value higher than (total number of nodes x number_of_task_slots), or every new job created will fail.
	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            ServiceFlinkApplicationDeploymentStatusType `json:"status"`                       // Deployment status
	VersionId         string                                      `json:"version_id"`                   // ApplicationVersion ID
}

ServiceFlinkCancelApplicationDeploymentOut ServiceFlinkCancelApplicationDeploymentResponse

type ServiceFlinkCreateApplicationDeploymentIn

type ServiceFlinkCreateApplicationDeploymentIn struct {
	Parallelism       *int    `json:"parallelism,omitempty"`        // Reading of Flink parallel execution documentation is recommended before setting this value to other than 1. Please do not set this value higher than (total number of nodes x number_of_task_slots), or every new job created will fail.
	RestartEnabled    *bool   `json:"restart_enabled,omitempty"`    // Specifies whether a Flink Job is restarted in case it fails
	StartingSavepoint *string `json:"starting_savepoint,omitempty"` // Job savepoint
	VersionId         string  `json:"version_id"`                   // ApplicationVersion ID
}

ServiceFlinkCreateApplicationDeploymentIn ServiceFlinkCreateApplicationDeploymentRequestBody

type ServiceFlinkCreateApplicationDeploymentOut

type ServiceFlinkCreateApplicationDeploymentOut struct {
	CreatedAt         time.Time                                   `json:"created_at"`                   // The creation timestamp of this entity in ISO 8601 format, always in UTC
	CreatedBy         string                                      `json:"created_by"`                   // The creator of this entity
	ErrorMsg          *string                                     `json:"error_msg,omitempty"`          // Error message describing what caused deployment to fail
	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"`                  // Reading of Flink parallel execution documentation is recommended before setting this value to other than 1. Please do not set this value higher than (total number of nodes x number_of_task_slots), or every new job created will fail.
	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            ServiceFlinkApplicationDeploymentStatusType `json:"status"`                       // Deployment status
	VersionId         string                                      `json:"version_id"`                   // ApplicationVersion ID
}

ServiceFlinkCreateApplicationDeploymentOut ServiceFlinkCreateApplicationDeploymentResponse

type ServiceFlinkDeleteApplicationDeploymentOut

type ServiceFlinkDeleteApplicationDeploymentOut struct {
	CreatedAt         time.Time                                   `json:"created_at"`                   // The creation timestamp of this entity in ISO 8601 format, always in UTC
	CreatedBy         string                                      `json:"created_by"`                   // The creator of this entity
	ErrorMsg          *string                                     `json:"error_msg,omitempty"`          // Error message describing what caused deployment to fail
	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"`                  // Reading of Flink parallel execution documentation is recommended before setting this value to other than 1. Please do not set this value higher than (total number of nodes x number_of_task_slots), or every new job created will fail.
	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            ServiceFlinkApplicationDeploymentStatusType `json:"status"`                       // Deployment status
	VersionId         string                                      `json:"version_id"`                   // ApplicationVersion ID
}

ServiceFlinkDeleteApplicationDeploymentOut ServiceFlinkDeleteApplicationDeploymentResponse

type ServiceFlinkGetApplicationDeploymentOut

type ServiceFlinkGetApplicationDeploymentOut struct {
	CreatedAt         time.Time                                   `json:"created_at"`                   // The creation timestamp of this entity in ISO 8601 format, always in UTC
	CreatedBy         string                                      `json:"created_by"`                   // The creator of this entity
	ErrorMsg          *string                                     `json:"error_msg,omitempty"`          // Error message describing what caused deployment to fail
	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"`                  // Reading of Flink parallel execution documentation is recommended before setting this value to other than 1. Please do not set this value higher than (total number of nodes x number_of_task_slots), or every new job created will fail.
	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            ServiceFlinkApplicationDeploymentStatusType `json:"status"`                       // Deployment status
	VersionId         string                                      `json:"version_id"`                   // ApplicationVersion ID
}

ServiceFlinkGetApplicationDeploymentOut ServiceFlinkGetApplicationDeploymentResponse

type ServiceFlinkStopApplicationDeploymentOut

type ServiceFlinkStopApplicationDeploymentOut struct {
	CreatedAt         time.Time                                   `json:"created_at"`                   // The creation timestamp of this entity in ISO 8601 format, always in UTC
	CreatedBy         string                                      `json:"created_by"`                   // The creator of this entity
	ErrorMsg          *string                                     `json:"error_msg,omitempty"`          // Error message describing what caused deployment to fail
	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"`                  // Reading of Flink parallel execution documentation is recommended before setting this value to other than 1. Please do not set this value higher than (total number of nodes x number_of_task_slots), or every new job created will fail.
	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            ServiceFlinkApplicationDeploymentStatusType `json:"status"`                       // Deployment status
	VersionId         string                                      `json:"version_id"`                   // ApplicationVersion ID
}

ServiceFlinkStopApplicationDeploymentOut ServiceFlinkStopApplicationDeploymentResponse

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL