types

type CreateProvisionRequest struct {
	EdgeClusterID string
	ClusterSecret string
}

type CreateProvisionResponse struct {
}

type DeleteProvisionRequest struct {
	EdgeClusterID string
}

type DeleteProvisionResponse struct {
}

type EdgeClusterFactoryContract interface {
	// Create instantiates a new edge cluster provisioner of a requested edge cluster type and returns
	// it to the caller.
	// ctx: Mandatory The reference to the context
	// clusterType: Mandatory. The type of edge cluster provisioner to be instantiated
	// Returns either the result of instantiating a edge cluster provisioner or error if something goes wrong.
	Create(
		ctx context.Context,
		clusterType models.ClusterType) (EdgeClusterProvisionerContract, error)
}

type EdgeClusterProvisionerContract interface {
	// CreateProvision provisions a new edge cluster.
	// ctx: Mandatory The reference to the context
	// request: Mandatory. The request to provision a new edge cluster
	// Returns either the result of provisioning new edge cluster or error if something goes wrong.
	CreateProvision(
		ctx context.Context,
		request *CreateProvisionRequest) (*CreateProvisionResponse, error)

	// UpdateProvisionWithRetry updates an existing provision.
	// ctx: Mandatory The reference to the context
	// request: Mandatory. The request to update an existing provision
	// Returns either the result of updating an existing provision or error if something goes wrong.
	UpdateProvisionWithRetry(
		ctx context.Context,
		request *UpdateProvisionRequest) (*UpdateProvisionResponse, error)

	// DeleteProvision deletes an existing provision.
	// ctx: Mandatory The reference to the context
	// request: Mandatory. The request to delete an existing provision
	// Returns either the result of deleting an existing provision or error if something goes wrong.
	DeleteProvision(
		ctx context.Context,
		request *DeleteProvisionRequest) (*DeleteProvisionResponse, error)

	// GetProvisionDetails retrieves information on an existing provision.
	// ctx: Mandatory The reference to the context
	// request: Mandatory. The request to retrieve information on an existing provision
	// Returns either the result of retrieving information on an provision or error if something goes wrong.
	GetProvisionDetails(
		ctx context.Context,
		request *GetProvisionDetailsRequest) (*GetProvisionDetailsResponse, error)

	// ListNodes lists an existing edge cluster nodes details
	// ctx: Mandatory The reference to the context
	// request: Mandatory. The request to list an existing edge cluster nodes details
	// Returns an existing edge cluster nodes details or error if something goes wrong.
	ListNodes(
		ctx context.Context,
		request *ListNodesRequest) (*ListNodesResponse, error)

	// ListPods lists an existing edge cluster pods that matchs the given search criteria
	// ctx: Mandatory The reference to the context
	// request: Mandatory. The request that contains the search criteria to filter the pods
	// Returns the list of running pods that matchs the given search criteria or error if something goes wrong.
	ListPods(
		ctx context.Context,
		request *ListPodsRequest) (*ListPodsResponse, error)

	// ListServices lists an existing edge cluster services that matchs the given search criteria
	// ctx: Mandatory The reference to the context
	// request: Mandatory. The request that contains the search criteria to filter services
	// Returns the list of services that matchs the given search criteria or error if something goes wrong.
	ListServices(
		ctx context.Context,
		request *ListServicesRequest) (*ListServicesResponse, error)
}

type EdgeClusterTypeNotSupportedError struct {
	ClusterType models.ClusterType
	Err         error
}

type GetProvisionDetailsRequest struct {
	EdgeClusterID string
}

type GetProvisionDetailsResponse struct {
	ProvisionDetails models.ProvisionDetails
}

type ListNodesRequest struct {
	EdgeClusterID string
}

type ListNodesResponse struct {
	Nodes []models.EdgeClusterNode
}

type ListPodsRequest struct {
	EdgeClusterID string
	Namespace     string
	NodeName      string
}

type ListPodsResponse struct {
	Pods []models.EdgeClusterPod
}

type ListServicesRequest struct {
	EdgeClusterID string
	Namespace     string
}

type ListServicesResponse struct {
	Services []models.EdgeClusterService
}

type UnknownError struct {
	Message string
	Err     error
}

type UpdateProvisionRequest struct {
	EdgeClusterID string
	ClusterSecret string
}

type UpdateProvisionResponse struct {
}