api

package
v1.19.0 Latest Latest
Warning

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

Go to latest
Published: Jan 16, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source
const (
	XtrabackupService_GetCurrentBackupConfig_FullMethodName = "/api.XtrabackupService/GetCurrentBackupConfig"
	XtrabackupService_CreateBackup_FullMethodName           = "/api.XtrabackupService/CreateBackup"
	XtrabackupService_DeleteBackup_FullMethodName           = "/api.XtrabackupService/DeleteBackup"
	XtrabackupService_GetLogs_FullMethodName                = "/api.XtrabackupService/GetLogs"
)

Variables

View Source
var (
	BackupStorageType_name = map[int32]string{
		0: "S3",
		1: "AZURE",
		2: "GCS",
	}
	BackupStorageType_value = map[string]int32{
		"S3":    0,
		"AZURE": 1,
		"GCS":   2,
	}
)

Enum value maps for BackupStorageType.

View Source
var XtrabackupService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "api.XtrabackupService",
	HandlerType: (*XtrabackupServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetCurrentBackupConfig",
			Handler:    _XtrabackupService_GetCurrentBackupConfig_Handler,
		},
		{
			MethodName: "DeleteBackup",
			Handler:    _XtrabackupService_DeleteBackup_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "CreateBackup",
			Handler:       _XtrabackupService_CreateBackup_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "GetLogs",
			Handler:       _XtrabackupService_GetLogs_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "app.proto",
}

XtrabackupService_ServiceDesc is the grpc.ServiceDesc for XtrabackupService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterXtrabackupServiceServer

func RegisterXtrabackupServiceServer(s grpc.ServiceRegistrar, srv XtrabackupServiceServer)

Types

type AzureConfig

type AzureConfig struct {
	ContainerName  string `protobuf:"bytes,1,opt,name=container_name,json=containerName,proto3" json:"container_name,omitempty"`
	EndpointUrl    string `protobuf:"bytes,2,opt,name=endpoint_url,json=endpointUrl,proto3" json:"endpoint_url,omitempty"`
	StorageClass   string `protobuf:"bytes,3,opt,name=storage_class,json=storageClass,proto3" json:"storage_class,omitempty"`
	StorageAccount string `protobuf:"bytes,4,opt,name=storage_account,json=storageAccount,proto3" json:"storage_account,omitempty"`
	AccessKey      string `protobuf:"bytes,5,opt,name=access_key,json=accessKey,proto3" json:"access_key,omitempty"`
	// contains filtered or unexported fields
}

func (*AzureConfig) Descriptor deprecated

func (*AzureConfig) Descriptor() ([]byte, []int)

Deprecated: Use AzureConfig.ProtoReflect.Descriptor instead.

func (*AzureConfig) GetAccessKey

func (x *AzureConfig) GetAccessKey() string

func (*AzureConfig) GetContainerName

func (x *AzureConfig) GetContainerName() string

func (*AzureConfig) GetEndpointUrl

func (x *AzureConfig) GetEndpointUrl() string

func (*AzureConfig) GetStorageAccount

func (x *AzureConfig) GetStorageAccount() string

func (*AzureConfig) GetStorageClass

func (x *AzureConfig) GetStorageClass() string

func (*AzureConfig) ProtoMessage

func (*AzureConfig) ProtoMessage()

func (*AzureConfig) ProtoReflect

func (x *AzureConfig) ProtoReflect() protoreflect.Message

func (*AzureConfig) Reset

func (x *AzureConfig) Reset()

func (*AzureConfig) String

func (x *AzureConfig) String() string

type BackupConfig

type BackupConfig struct {
	Destination      string            `protobuf:"bytes,1,opt,name=destination,proto3" json:"destination,omitempty"`
	Type             BackupStorageType `protobuf:"varint,2,opt,name=type,proto3,enum=api.BackupStorageType" json:"type,omitempty"`
	VerifyTls        bool              `protobuf:"varint,3,opt,name=verify_tls,json=verifyTls,proto3" json:"verify_tls,omitempty"`
	ContainerOptions *ContainerOptions `protobuf:"bytes,4,opt,name=container_options,json=containerOptions,proto3" json:"container_options,omitempty"`
	S3               *S3Config         `protobuf:"bytes,5,opt,name=s3,proto3,oneof" json:"s3,omitempty"`
	Gcs              *GCSConfig        `protobuf:"bytes,6,opt,name=gcs,proto3,oneof" json:"gcs,omitempty"`
	Azure            *AzureConfig      `protobuf:"bytes,7,opt,name=azure,proto3,oneof" json:"azure,omitempty"`
	// contains filtered or unexported fields
}

func (*BackupConfig) Descriptor deprecated

func (*BackupConfig) Descriptor() ([]byte, []int)

Deprecated: Use BackupConfig.ProtoReflect.Descriptor instead.

func (*BackupConfig) GetAzure

func (x *BackupConfig) GetAzure() *AzureConfig

func (*BackupConfig) GetContainerOptions

func (x *BackupConfig) GetContainerOptions() *ContainerOptions

func (*BackupConfig) GetDestination

func (x *BackupConfig) GetDestination() string

func (*BackupConfig) GetGcs

func (x *BackupConfig) GetGcs() *GCSConfig

func (*BackupConfig) GetS3

func (x *BackupConfig) GetS3() *S3Config

func (*BackupConfig) GetType

func (x *BackupConfig) GetType() BackupStorageType

func (*BackupConfig) GetVerifyTls

func (x *BackupConfig) GetVerifyTls() bool

func (*BackupConfig) NewXbcloudCmd

func (cfg *BackupConfig) NewXbcloudCmd(ctx context.Context, action XBCloudAction, in io.Reader) *exec.Cmd

NewXbcloudCmd creates a new xbcloud command

func (*BackupConfig) NewXtrabackupCmd

func (cfg *BackupConfig) NewXtrabackupCmd(
	ctx context.Context,
	user,
	password string,
	mysqlVersion *goversion.Version,
	withTablespaceEncryption bool) *exec.Cmd

NewXtrabackupCmd creates a new xtrabackup command

func (*BackupConfig) ProtoMessage

func (*BackupConfig) ProtoMessage()

func (*BackupConfig) ProtoReflect

func (x *BackupConfig) ProtoReflect() protoreflect.Message

func (*BackupConfig) Reset

func (x *BackupConfig) Reset()

func (*BackupConfig) String

func (x *BackupConfig) String() string

type BackupContainerArgs

type BackupContainerArgs struct {
	Xtrabackup []string `protobuf:"bytes,1,rep,name=xtrabackup,proto3" json:"xtrabackup,omitempty"`
	Xbcloud    []string `protobuf:"bytes,2,rep,name=xbcloud,proto3" json:"xbcloud,omitempty"`
	Xbstream   []string `protobuf:"bytes,3,rep,name=xbstream,proto3" json:"xbstream,omitempty"`
	// contains filtered or unexported fields
}

func (*BackupContainerArgs) Descriptor deprecated

func (*BackupContainerArgs) Descriptor() ([]byte, []int)

Deprecated: Use BackupContainerArgs.ProtoReflect.Descriptor instead.

func (*BackupContainerArgs) GetXbcloud

func (x *BackupContainerArgs) GetXbcloud() []string

func (*BackupContainerArgs) GetXbstream

func (x *BackupContainerArgs) GetXbstream() []string

func (*BackupContainerArgs) GetXtrabackup

func (x *BackupContainerArgs) GetXtrabackup() []string

func (*BackupContainerArgs) ProtoMessage

func (*BackupContainerArgs) ProtoMessage()

func (*BackupContainerArgs) ProtoReflect

func (x *BackupContainerArgs) ProtoReflect() protoreflect.Message

func (*BackupContainerArgs) Reset

func (x *BackupContainerArgs) Reset()

func (*BackupContainerArgs) String

func (x *BackupContainerArgs) String() string

type BackupStorageType

type BackupStorageType int32
const (
	BackupStorageType_S3    BackupStorageType = 0
	BackupStorageType_AZURE BackupStorageType = 1
	BackupStorageType_GCS   BackupStorageType = 2
)

func (BackupStorageType) Descriptor

func (BackupStorageType) Enum

func (BackupStorageType) EnumDescriptor deprecated

func (BackupStorageType) EnumDescriptor() ([]byte, []int)

Deprecated: Use BackupStorageType.Descriptor instead.

func (BackupStorageType) Number

func (BackupStorageType) String

func (x BackupStorageType) String() string

func (BackupStorageType) Type

type ContainerOptions

type ContainerOptions struct {
	Env  []*EnvVar            `protobuf:"bytes,1,rep,name=env,proto3" json:"env,omitempty"`
	Args *BackupContainerArgs `protobuf:"bytes,2,opt,name=args,proto3" json:"args,omitempty"`
	// contains filtered or unexported fields
}

func (*ContainerOptions) Descriptor deprecated

func (*ContainerOptions) Descriptor() ([]byte, []int)

Deprecated: Use ContainerOptions.ProtoReflect.Descriptor instead.

func (*ContainerOptions) GetArgs

func (x *ContainerOptions) GetArgs() *BackupContainerArgs

func (*ContainerOptions) GetEnv

func (x *ContainerOptions) GetEnv() []*EnvVar

func (*ContainerOptions) ProtoMessage

func (*ContainerOptions) ProtoMessage()

func (*ContainerOptions) ProtoReflect

func (x *ContainerOptions) ProtoReflect() protoreflect.Message

func (*ContainerOptions) Reset

func (x *ContainerOptions) Reset()

func (*ContainerOptions) String

func (x *ContainerOptions) String() string

type CreateBackupRequest

type CreateBackupRequest struct {
	BackupName   string        `protobuf:"bytes,1,opt,name=backup_name,json=backupName,proto3" json:"backup_name,omitempty"`
	BackupConfig *BackupConfig `protobuf:"bytes,2,opt,name=backup_config,json=backupConfig,proto3" json:"backup_config,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateBackupRequest) Descriptor deprecated

func (*CreateBackupRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateBackupRequest.ProtoReflect.Descriptor instead.

func (*CreateBackupRequest) GetBackupConfig

func (x *CreateBackupRequest) GetBackupConfig() *BackupConfig

func (*CreateBackupRequest) GetBackupName

func (x *CreateBackupRequest) GetBackupName() string

func (*CreateBackupRequest) ProtoMessage

func (*CreateBackupRequest) ProtoMessage()

func (*CreateBackupRequest) ProtoReflect

func (x *CreateBackupRequest) ProtoReflect() protoreflect.Message

func (*CreateBackupRequest) Reset

func (x *CreateBackupRequest) Reset()

func (*CreateBackupRequest) String

func (x *CreateBackupRequest) String() string

type CreateBackupResponse

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

func (*CreateBackupResponse) Descriptor deprecated

func (*CreateBackupResponse) Descriptor() ([]byte, []int)

Deprecated: Use CreateBackupResponse.ProtoReflect.Descriptor instead.

func (*CreateBackupResponse) ProtoMessage

func (*CreateBackupResponse) ProtoMessage()

func (*CreateBackupResponse) ProtoReflect

func (x *CreateBackupResponse) ProtoReflect() protoreflect.Message

func (*CreateBackupResponse) Reset

func (x *CreateBackupResponse) Reset()

func (*CreateBackupResponse) String

func (x *CreateBackupResponse) String() string

type DeleteBackupRequest

type DeleteBackupRequest struct {
	BackupName   string        `protobuf:"bytes,1,opt,name=backup_name,json=backupName,proto3" json:"backup_name,omitempty"`
	BackupConfig *BackupConfig `protobuf:"bytes,2,opt,name=backup_config,json=backupConfig,proto3" json:"backup_config,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteBackupRequest) Descriptor deprecated

func (*DeleteBackupRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteBackupRequest.ProtoReflect.Descriptor instead.

func (*DeleteBackupRequest) GetBackupConfig

func (x *DeleteBackupRequest) GetBackupConfig() *BackupConfig

func (*DeleteBackupRequest) GetBackupName

func (x *DeleteBackupRequest) GetBackupName() string

func (*DeleteBackupRequest) ProtoMessage

func (*DeleteBackupRequest) ProtoMessage()

func (*DeleteBackupRequest) ProtoReflect

func (x *DeleteBackupRequest) ProtoReflect() protoreflect.Message

func (*DeleteBackupRequest) Reset

func (x *DeleteBackupRequest) Reset()

func (*DeleteBackupRequest) String

func (x *DeleteBackupRequest) String() string

type DeleteBackupResponse

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

func (*DeleteBackupResponse) Descriptor deprecated

func (*DeleteBackupResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeleteBackupResponse.ProtoReflect.Descriptor instead.

func (*DeleteBackupResponse) ProtoMessage

func (*DeleteBackupResponse) ProtoMessage()

func (*DeleteBackupResponse) ProtoReflect

func (x *DeleteBackupResponse) ProtoReflect() protoreflect.Message

func (*DeleteBackupResponse) Reset

func (x *DeleteBackupResponse) Reset()

func (*DeleteBackupResponse) String

func (x *DeleteBackupResponse) String() string

type EnvVar

type EnvVar struct {
	Key   string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*EnvVar) Descriptor deprecated

func (*EnvVar) Descriptor() ([]byte, []int)

Deprecated: Use EnvVar.ProtoReflect.Descriptor instead.

func (*EnvVar) GetKey

func (x *EnvVar) GetKey() string

func (*EnvVar) GetValue

func (x *EnvVar) GetValue() string

func (*EnvVar) ProtoMessage

func (*EnvVar) ProtoMessage()

func (*EnvVar) ProtoReflect

func (x *EnvVar) ProtoReflect() protoreflect.Message

func (*EnvVar) Reset

func (x *EnvVar) Reset()

func (*EnvVar) String

func (x *EnvVar) String() string

type GCSConfig

type GCSConfig struct {
	Bucket       string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
	EndpointUrl  string `protobuf:"bytes,2,opt,name=endpoint_url,json=endpointUrl,proto3" json:"endpoint_url,omitempty"`
	StorageClass string `protobuf:"bytes,3,opt,name=storage_class,json=storageClass,proto3" json:"storage_class,omitempty"`
	AccessKey    string `protobuf:"bytes,4,opt,name=access_key,json=accessKey,proto3" json:"access_key,omitempty"`
	SecretKey    string `protobuf:"bytes,5,opt,name=secret_key,json=secretKey,proto3" json:"secret_key,omitempty"`
	// contains filtered or unexported fields
}

func (*GCSConfig) Descriptor deprecated

func (*GCSConfig) Descriptor() ([]byte, []int)

Deprecated: Use GCSConfig.ProtoReflect.Descriptor instead.

func (*GCSConfig) GetAccessKey

func (x *GCSConfig) GetAccessKey() string

func (*GCSConfig) GetBucket

func (x *GCSConfig) GetBucket() string

func (*GCSConfig) GetEndpointUrl

func (x *GCSConfig) GetEndpointUrl() string

func (*GCSConfig) GetSecretKey

func (x *GCSConfig) GetSecretKey() string

func (*GCSConfig) GetStorageClass

func (x *GCSConfig) GetStorageClass() string

func (*GCSConfig) ProtoMessage

func (*GCSConfig) ProtoMessage()

func (*GCSConfig) ProtoReflect

func (x *GCSConfig) ProtoReflect() protoreflect.Message

func (*GCSConfig) Reset

func (x *GCSConfig) Reset()

func (*GCSConfig) String

func (x *GCSConfig) String() string

type GetCurrentBackupConfigRequest

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

func (*GetCurrentBackupConfigRequest) Descriptor deprecated

func (*GetCurrentBackupConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetCurrentBackupConfigRequest.ProtoReflect.Descriptor instead.

func (*GetCurrentBackupConfigRequest) ProtoMessage

func (*GetCurrentBackupConfigRequest) ProtoMessage()

func (*GetCurrentBackupConfigRequest) ProtoReflect

func (*GetCurrentBackupConfigRequest) Reset

func (x *GetCurrentBackupConfigRequest) Reset()

func (*GetCurrentBackupConfigRequest) String

type GetLogsRequest

type GetLogsRequest struct {
	BackupName string `protobuf:"bytes,1,opt,name=backup_name,json=backupName,proto3" json:"backup_name,omitempty"`
	// contains filtered or unexported fields
}

func (*GetLogsRequest) Descriptor deprecated

func (*GetLogsRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetLogsRequest.ProtoReflect.Descriptor instead.

func (*GetLogsRequest) GetBackupName

func (x *GetLogsRequest) GetBackupName() string

func (*GetLogsRequest) ProtoMessage

func (*GetLogsRequest) ProtoMessage()

func (*GetLogsRequest) ProtoReflect

func (x *GetLogsRequest) ProtoReflect() protoreflect.Message

func (*GetLogsRequest) Reset

func (x *GetLogsRequest) Reset()

func (*GetLogsRequest) String

func (x *GetLogsRequest) String() string

type LogChunk

type LogChunk struct {
	Log string `protobuf:"bytes,1,opt,name=log,proto3" json:"log,omitempty"`
	// contains filtered or unexported fields
}

func (*LogChunk) Descriptor deprecated

func (*LogChunk) Descriptor() ([]byte, []int)

Deprecated: Use LogChunk.ProtoReflect.Descriptor instead.

func (*LogChunk) GetLog

func (x *LogChunk) GetLog() string

func (*LogChunk) ProtoMessage

func (*LogChunk) ProtoMessage()

func (*LogChunk) ProtoReflect

func (x *LogChunk) ProtoReflect() protoreflect.Message

func (*LogChunk) Reset

func (x *LogChunk) Reset()

func (*LogChunk) String

func (x *LogChunk) String() string

type S3Config

type S3Config struct {
	Bucket       string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
	Region       string `protobuf:"bytes,2,opt,name=region,proto3" json:"region,omitempty"`
	EndpointUrl  string `protobuf:"bytes,3,opt,name=endpoint_url,json=endpointUrl,proto3" json:"endpoint_url,omitempty"`
	AccessKey    string `protobuf:"bytes,4,opt,name=access_key,json=accessKey,proto3" json:"access_key,omitempty"`
	SecretKey    string `protobuf:"bytes,5,opt,name=secret_key,json=secretKey,proto3" json:"secret_key,omitempty"`
	StorageClass string `protobuf:"bytes,6,opt,name=storage_class,json=storageClass,proto3" json:"storage_class,omitempty"`
	// contains filtered or unexported fields
}

func (*S3Config) Descriptor deprecated

func (*S3Config) Descriptor() ([]byte, []int)

Deprecated: Use S3Config.ProtoReflect.Descriptor instead.

func (*S3Config) GetAccessKey

func (x *S3Config) GetAccessKey() string

func (*S3Config) GetBucket

func (x *S3Config) GetBucket() string

func (*S3Config) GetEndpointUrl

func (x *S3Config) GetEndpointUrl() string

func (*S3Config) GetRegion

func (x *S3Config) GetRegion() string

func (*S3Config) GetSecretKey

func (x *S3Config) GetSecretKey() string

func (*S3Config) GetStorageClass

func (x *S3Config) GetStorageClass() string

func (*S3Config) ProtoMessage

func (*S3Config) ProtoMessage()

func (*S3Config) ProtoReflect

func (x *S3Config) ProtoReflect() protoreflect.Message

func (*S3Config) Reset

func (x *S3Config) Reset()

func (*S3Config) String

func (x *S3Config) String() string

type UnimplementedXtrabackupServiceServer

type UnimplementedXtrabackupServiceServer struct{}

UnimplementedXtrabackupServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedXtrabackupServiceServer) DeleteBackup

func (UnimplementedXtrabackupServiceServer) GetCurrentBackupConfig

func (UnimplementedXtrabackupServiceServer) GetLogs

type UnsafeXtrabackupServiceServer

type UnsafeXtrabackupServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeXtrabackupServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to XtrabackupServiceServer will result in compilation errors.

type XBCloudAction

type XBCloudAction string
const (
	XBCloudActionPut    XBCloudAction = "put"
	XBCloudActionDelete XBCloudAction = "delete"
)

type XtrabackupServiceClient

type XtrabackupServiceClient interface {
	GetCurrentBackupConfig(ctx context.Context, in *GetCurrentBackupConfigRequest, opts ...grpc.CallOption) (*BackupConfig, error)
	CreateBackup(ctx context.Context, in *CreateBackupRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[CreateBackupResponse], error)
	DeleteBackup(ctx context.Context, in *DeleteBackupRequest, opts ...grpc.CallOption) (*DeleteBackupResponse, error)
	GetLogs(ctx context.Context, in *GetLogsRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[LogChunk], error)
}

XtrabackupServiceClient is the client API for XtrabackupService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

type XtrabackupServiceServer

type XtrabackupServiceServer interface {
	GetCurrentBackupConfig(context.Context, *GetCurrentBackupConfigRequest) (*BackupConfig, error)
	CreateBackup(*CreateBackupRequest, grpc.ServerStreamingServer[CreateBackupResponse]) error
	DeleteBackup(context.Context, *DeleteBackupRequest) (*DeleteBackupResponse, error)
	GetLogs(*GetLogsRequest, grpc.ServerStreamingServer[LogChunk]) error
	// contains filtered or unexported methods
}

XtrabackupServiceServer is the server API for XtrabackupService service. All implementations must embed UnimplementedXtrabackupServiceServer for forward compatibility.

type XtrabackupService_CreateBackupClient

type XtrabackupService_CreateBackupClient = grpc.ServerStreamingClient[CreateBackupResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type XtrabackupService_CreateBackupServer

type XtrabackupService_CreateBackupServer = grpc.ServerStreamingServer[CreateBackupResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type XtrabackupService_GetLogsClient

type XtrabackupService_GetLogsClient = grpc.ServerStreamingClient[LogChunk]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type XtrabackupService_GetLogsServer

type XtrabackupService_GetLogsServer = grpc.ServerStreamingServer[LogChunk]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

Jump to

Keyboard shortcuts

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