job

package
v0.5.0 Latest Latest
Warning

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

Go to latest
Published: Mar 31, 2026 License: Apache-2.0 Imports: 9 Imported by: 1

Documentation

Index

Constants

View Source
const (
	RestoreJobHooks_GetCapabilities_FullMethodName = "/cnpgi.wal.v1.RestoreJobHooks/GetCapabilities"
	RestoreJobHooks_Restore_FullMethodName         = "/cnpgi.wal.v1.RestoreJobHooks/Restore"
)

Variables

View Source
var (
	RestoreJobHooksCapability_Kind_name = map[int32]string{
		0: "KIND_UNSPECIFIED",
		1: "KIND_RESTORE",
	}
	RestoreJobHooksCapability_Kind_value = map[string]int32{
		"KIND_UNSPECIFIED": 0,
		"KIND_RESTORE":     1,
	}
)

Enum value maps for RestoreJobHooksCapability_Kind.

View Source
var File_proto_restore_job_proto protoreflect.FileDescriptor
View Source
var RestoreJobHooks_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "cnpgi.wal.v1.RestoreJobHooks",
	HandlerType: (*RestoreJobHooksServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetCapabilities",
			Handler:    _RestoreJobHooks_GetCapabilities_Handler,
		},
		{
			MethodName: "Restore",
			Handler:    _RestoreJobHooks_Restore_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "proto/restore_job.proto",
}

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

Functions

func RegisterRestoreJobHooksServer

func RegisterRestoreJobHooksServer(s grpc.ServiceRegistrar, srv RestoreJobHooksServer)

Types

type RestoreJobHooksCapabilitiesRequest

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

func (*RestoreJobHooksCapabilitiesRequest) Descriptor deprecated

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

Deprecated: Use RestoreJobHooksCapabilitiesRequest.ProtoReflect.Descriptor instead.

func (*RestoreJobHooksCapabilitiesRequest) ProtoMessage

func (*RestoreJobHooksCapabilitiesRequest) ProtoMessage()

func (*RestoreJobHooksCapabilitiesRequest) ProtoReflect

func (*RestoreJobHooksCapabilitiesRequest) Reset

func (*RestoreJobHooksCapabilitiesRequest) String

type RestoreJobHooksCapabilitiesResult

type RestoreJobHooksCapabilitiesResult struct {

	// This field is REQUIRED and contains the describe capability
	Capabilities []*RestoreJobHooksCapability `protobuf:"bytes,1,rep,name=capabilities,proto3" json:"capabilities,omitempty"`
	// contains filtered or unexported fields
}

func (*RestoreJobHooksCapabilitiesResult) Descriptor deprecated

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

Deprecated: Use RestoreJobHooksCapabilitiesResult.ProtoReflect.Descriptor instead.

func (*RestoreJobHooksCapabilitiesResult) GetCapabilities

func (*RestoreJobHooksCapabilitiesResult) ProtoMessage

func (*RestoreJobHooksCapabilitiesResult) ProtoMessage()

func (*RestoreJobHooksCapabilitiesResult) ProtoReflect

func (*RestoreJobHooksCapabilitiesResult) Reset

func (*RestoreJobHooksCapabilitiesResult) String

type RestoreJobHooksCapability

type RestoreJobHooksCapability struct {
	Kind RestoreJobHooksCapability_Kind `protobuf:"varint,1,opt,name=kind,proto3,enum=cnpgi.wal.v1.RestoreJobHooksCapability_Kind" json:"kind,omitempty"`
	// contains filtered or unexported fields
}

func (*RestoreJobHooksCapability) Descriptor deprecated

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

Deprecated: Use RestoreJobHooksCapability.ProtoReflect.Descriptor instead.

func (*RestoreJobHooksCapability) GetKind

func (*RestoreJobHooksCapability) ProtoMessage

func (*RestoreJobHooksCapability) ProtoMessage()

func (*RestoreJobHooksCapability) ProtoReflect

func (*RestoreJobHooksCapability) Reset

func (x *RestoreJobHooksCapability) Reset()

func (*RestoreJobHooksCapability) String

func (x *RestoreJobHooksCapability) String() string

type RestoreJobHooksCapability_Kind

type RestoreJobHooksCapability_Kind int32
const (
	RestoreJobHooksCapability_KIND_UNSPECIFIED RestoreJobHooksCapability_Kind = 0
	// KIND_RESTORE means that the plugin is able to handle
	// Restore requests
	RestoreJobHooksCapability_KIND_RESTORE RestoreJobHooksCapability_Kind = 1
)

func (RestoreJobHooksCapability_Kind) Descriptor

func (RestoreJobHooksCapability_Kind) Enum

func (RestoreJobHooksCapability_Kind) EnumDescriptor deprecated

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

Deprecated: Use RestoreJobHooksCapability_Kind.Descriptor instead.

func (RestoreJobHooksCapability_Kind) Number

func (RestoreJobHooksCapability_Kind) String

func (RestoreJobHooksCapability_Kind) Type

type RestoreJobHooksClient

type RestoreJobHooksClient interface {
	// GetCapabilities gets the capabilities of the Backup service
	GetCapabilities(ctx context.Context, in *RestoreJobHooksCapabilitiesRequest, opts ...grpc.CallOption) (*RestoreJobHooksCapabilitiesResult, error)
	// Restore is called to restore a PGDATA
	Restore(ctx context.Context, in *RestoreRequest, opts ...grpc.CallOption) (*RestoreResponse, error)
}

RestoreJobHooksClient is the client API for RestoreJobHooks 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.

RestoreJobHooks offers a way for the plugins to enhance the cluster recovery process

type RestoreJobHooksServer

type RestoreJobHooksServer interface {
	// GetCapabilities gets the capabilities of the Backup service
	GetCapabilities(context.Context, *RestoreJobHooksCapabilitiesRequest) (*RestoreJobHooksCapabilitiesResult, error)
	// Restore is called to restore a PGDATA
	Restore(context.Context, *RestoreRequest) (*RestoreResponse, error)
	// contains filtered or unexported methods
}

RestoreJobHooksServer is the server API for RestoreJobHooks service. All implementations must embed UnimplementedRestoreJobHooksServer for forward compatibility.

RestoreJobHooks offers a way for the plugins to enhance the cluster recovery process

type RestoreRequest

type RestoreRequest struct {

	// This field is REQUIRED. Value of this field is the JSON
	// serialization of the Cluster.
	ClusterDefinition []byte `protobuf:"bytes,1,opt,name=cluster_definition,json=clusterDefinition,proto3" json:"cluster_definition,omitempty"`
	// contains filtered or unexported fields
}

func (*RestoreRequest) Descriptor deprecated

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

Deprecated: Use RestoreRequest.ProtoReflect.Descriptor instead.

func (*RestoreRequest) GetClusterDefinition

func (x *RestoreRequest) GetClusterDefinition() []byte

func (*RestoreRequest) ProtoMessage

func (*RestoreRequest) ProtoMessage()

func (*RestoreRequest) ProtoReflect

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

func (*RestoreRequest) Reset

func (x *RestoreRequest) Reset()

func (*RestoreRequest) String

func (x *RestoreRequest) String() string

type RestoreResponse

type RestoreResponse struct {

	// This field is REQUIRED. Value of this field is the string
	// representation of PostgreSQL configuration parameters to use
	// for the restore.
	RestoreConfig string `protobuf:"bytes,1,opt,name=restore_config,json=restoreConfig,proto3" json:"restore_config,omitempty"`
	// This field if REQUIRED. Environment variables to be set in the
	// restore job, expressed as NAME=VALUE.
	Envs []string `protobuf:"bytes,2,rep,name=envs,proto3" json:"envs,omitempty"`
	// contains filtered or unexported fields
}

func (*RestoreResponse) Descriptor deprecated

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

Deprecated: Use RestoreResponse.ProtoReflect.Descriptor instead.

func (*RestoreResponse) GetEnvs

func (x *RestoreResponse) GetEnvs() []string

func (*RestoreResponse) GetRestoreConfig

func (x *RestoreResponse) GetRestoreConfig() string

func (*RestoreResponse) ProtoMessage

func (*RestoreResponse) ProtoMessage()

func (*RestoreResponse) ProtoReflect

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

func (*RestoreResponse) Reset

func (x *RestoreResponse) Reset()

func (*RestoreResponse) String

func (x *RestoreResponse) String() string

type UnimplementedRestoreJobHooksServer

type UnimplementedRestoreJobHooksServer struct{}

UnimplementedRestoreJobHooksServer 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 (UnimplementedRestoreJobHooksServer) Restore

type UnsafeRestoreJobHooksServer

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

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

Jump to

Keyboard shortcuts

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