local

Documentation

Overview

Package local provides a client to interact with the local webserver endpoints.

Index

• type BackupClient
• type CacheClient
• type Client
  • func NewClient() Client
• type ClusterClient

Types

type BackupClient

type BackupClient interface {
	StatusWithErrors(ctx context.Context, pod *corev1.Pod) (*webserver.Response[webserver.BackupResultData], error)
	Start(
		ctx context.Context,
		pod *corev1.Pod,
		sbq webserver.StartBackupRequest,
	) (*webserver.Response[webserver.BackupResultData], error)
	Stop(
		ctx context.Context,
		pod *corev1.Pod,
		sbq webserver.StopBackupRequest,
	) (*webserver.Response[webserver.BackupResultData], error)
}

BackupClient is the interface to interact with the backup endpoints

type CacheClient

type CacheClient interface {
	GetCluster() (*apiv1.Cluster, error)
	GetEnv(key string) ([]string, error)
}

CacheClient is the interface to interact with the cache endpoints

type Client

type Client interface {
	Backup() BackupClient
	Cache() CacheClient
	Cluster() ClusterClient
}

Client is an entity capable of interacting with the local webserver endpoints

func NewClient

func NewClient() Client

NewClient returns a new instance of Client

type ClusterClient

type ClusterClient interface {
	// SetWALArchiveStatusCondition sets the wal-archive status condition.
	// An empty errMessage means that the archive process was successful.
	// Returns any error encountered during the request.
	SetWALArchiveStatusCondition(ctx context.Context, errMessage string) error
}

ClusterClient is the interface to interact with the uncategorized endpoints