ferry

package
v0.0.0-...-fdaabfb Latest Latest
Warning

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

Go to latest
Published: Aug 25, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	KeyRangeResponse_OpStatus_name = map[int32]string{
		0: "SUCCESS",
		1: "FAILURE",
		2: "TRANSIENT",
	}
	KeyRangeResponse_OpStatus_value = map[string]int32{
		"SUCCESS":   0,
		"FAILURE":   1,
		"TRANSIENT": 2,
	}
)

Enum value maps for KeyRangeResponse_OpStatus.

View Source
var (
	SessionResponse_OpStatus_name = map[int32]string{
		0: "SUCCESS",
		1: "FAILURE",
	}
	SessionResponse_OpStatus_value = map[string]int32{
		"SUCCESS": 0,
		"FAILURE": 1,
	}
)

Enum value maps for SessionResponse_OpStatus.

View Source
var (
	SessionResponse_SessionState_name = map[int32]string{
		0: "STARTED",
		1: "STOPPED",
		2: "ENDED",
	}
	SessionResponse_SessionState_value = map[string]int32{
		"STARTED": 0,
		"STOPPED": 1,
		"ENDED":   2,
	}
)

Enum value maps for SessionResponse_SessionState.

View Source
var Ferry_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "ferry.Ferry",
	HandlerType: (*FerryServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "StartExportSession",
			Handler:    _Ferry_StartExportSession_Handler,
		},
		{
			MethodName: "StopExportSession",
			Handler:    _Ferry_StopExportSession_Handler,
		},
		{
			MethodName: "RemoveExportedFile",
			Handler:    _Ferry_RemoveExportedFile_Handler,
		},
		{
			MethodName: "EndExportSession",
			Handler:    _Ferry_EndExportSession_Handler,
		},
		{
			MethodName: "StartImportSession",
			Handler:    _Ferry_StartImportSession_Handler,
		},
		{
			MethodName: "StopImportSession",
			Handler:    _Ferry_StopImportSession_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Export",
			Handler:       _Ferry_Export_Handler,
			ClientStreams: true,
		},
		{
			StreamName:    "GetExportedFile",
			Handler:       _Ferry_GetExportedFile_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "Import",
			Handler:       _Ferry_Import_Handler,
			ClientStreams: true,
		},
	},
	Metadata: "ferry.proto",
}

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

View Source
var File_ferry_proto protoreflect.FileDescriptor

Functions

func RegisterFerryServer

func RegisterFerryServer(s grpc.ServiceRegistrar, srv FerryServer)

Types

type FerryClient

type FerryClient interface {
	StartExportSession(ctx context.Context, in *Target, opts ...grpc.CallOption) (*SessionResponse, error)
	Export(ctx context.Context, opts ...grpc.CallOption) (Ferry_ExportClient, error)
	StopExportSession(ctx context.Context, in *Session, opts ...grpc.CallOption) (*SessionResponse, error)
	GetExportedFile(ctx context.Context, in *FileRequest, opts ...grpc.CallOption) (Ferry_GetExportedFileClient, error)
	RemoveExportedFile(ctx context.Context, in *FileRequest, opts ...grpc.CallOption) (*FileRequest, error)
	EndExportSession(ctx context.Context, in *Session, opts ...grpc.CallOption) (*SessionResponse, error)
	StartImportSession(ctx context.Context, in *Target, opts ...grpc.CallOption) (*SessionResponse, error)
	Import(ctx context.Context, opts ...grpc.CallOption) (Ferry_ImportClient, error)
	StopImportSession(ctx context.Context, in *Session, opts ...grpc.CallOption) (*SessionResponse, error)
}

FerryClient is the client API for Ferry 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.

func NewFerryClient

func NewFerryClient(cc grpc.ClientConnInterface) FerryClient

type FerryServer

type FerryServer interface {
	StartExportSession(context.Context, *Target) (*SessionResponse, error)
	Export(Ferry_ExportServer) error
	StopExportSession(context.Context, *Session) (*SessionResponse, error)
	GetExportedFile(*FileRequest, Ferry_GetExportedFileServer) error
	RemoveExportedFile(context.Context, *FileRequest) (*FileRequest, error)
	EndExportSession(context.Context, *Session) (*SessionResponse, error)
	StartImportSession(context.Context, *Target) (*SessionResponse, error)
	Import(Ferry_ImportServer) error
	StopImportSession(context.Context, *Session) (*SessionResponse, error)
	// contains filtered or unexported methods
}

FerryServer is the server API for Ferry service. All implementations must embed UnimplementedFerryServer for forward compatibility

type Ferry_ExportClient

type Ferry_ExportClient interface {
	Send(*KeyRequest) error
	CloseAndRecv() (*SessionResponse, error)
	grpc.ClientStream
}

type Ferry_ExportServer

type Ferry_ExportServer interface {
	SendAndClose(*SessionResponse) error
	Recv() (*KeyRequest, error)
	grpc.ServerStream
}

type Ferry_GetExportedFileClient

type Ferry_GetExportedFileClient interface {
	Recv() (*FileRequestResponse, error)
	grpc.ClientStream
}

type Ferry_GetExportedFileServer

type Ferry_GetExportedFileServer interface {
	Send(*FileRequestResponse) error
	grpc.ServerStream
}

type Ferry_ImportClient

type Ferry_ImportClient interface {
	Send(*ImportRequest) error
	CloseAndRecv() (*SessionResponse, error)
	grpc.ClientStream
}

type Ferry_ImportServer

type Ferry_ImportServer interface {
	SendAndClose(*SessionResponse) error
	Recv() (*ImportRequest, error)
	grpc.ServerStream
}

type FileRequest

type FileRequest struct {
	SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"` // session_id for the app level session
	TargetUrl string `protobuf:"bytes,2,opt,name=target_url,json=targetUrl,proto3" json:"target_url,omitempty"`
	FileName  string `protobuf:"bytes,3,opt,name=fileName,proto3" json:"fileName,omitempty"`
	// contains filtered or unexported fields
}

func (*FileRequest) Descriptor deprecated

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

Deprecated: Use FileRequest.ProtoReflect.Descriptor instead.

func (*FileRequest) GetFileName

func (x *FileRequest) GetFileName() string

func (*FileRequest) GetSessionId

func (x *FileRequest) GetSessionId() string

func (*FileRequest) GetTargetUrl

func (x *FileRequest) GetTargetUrl() string

func (*FileRequest) ProtoMessage

func (*FileRequest) ProtoMessage()

func (*FileRequest) ProtoReflect

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

func (*FileRequest) Reset

func (x *FileRequest) Reset()

func (*FileRequest) String

func (x *FileRequest) String() string

type FileRequestResponse

type FileRequestResponse struct {
	FileName  string `protobuf:"bytes,1,opt,name=fileName,proto3" json:"fileName,omitempty"`
	BlockNum  int32  `protobuf:"varint,2,opt,name=blockNum,proto3" json:"blockNum,omitempty"`
	BlockData []byte `protobuf:"bytes,3,opt,name=blockData,proto3" json:"blockData,omitempty"`
	// contains filtered or unexported fields
}

func (*FileRequestResponse) Descriptor deprecated

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

Deprecated: Use FileRequestResponse.ProtoReflect.Descriptor instead.

func (*FileRequestResponse) GetBlockData

func (x *FileRequestResponse) GetBlockData() []byte

func (*FileRequestResponse) GetBlockNum

func (x *FileRequestResponse) GetBlockNum() int32

func (*FileRequestResponse) GetFileName

func (x *FileRequestResponse) GetFileName() string

func (*FileRequestResponse) ProtoMessage

func (*FileRequestResponse) ProtoMessage()

func (*FileRequestResponse) ProtoReflect

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

func (*FileRequestResponse) Reset

func (x *FileRequestResponse) Reset()

func (*FileRequestResponse) String

func (x *FileRequestResponse) String() string

type FinalizedFile

type FinalizedFile struct {
	FileName    string `protobuf:"bytes,1,opt,name=file_name,json=fileName,proto3" json:"file_name,omitempty"`
	KeyRange    string `protobuf:"bytes,2,opt,name=key_range,json=keyRange,proto3" json:"key_range,omitempty"`
	Checksum    string `protobuf:"bytes,3,opt,name=checksum,proto3" json:"checksum,omitempty"`
	ContentSize int64  `protobuf:"varint,4,opt,name=content_size,json=contentSize,proto3" json:"content_size,omitempty"`
	RowCount    int64  `protobuf:"varint,5,opt,name=row_count,json=rowCount,proto3" json:"row_count,omitempty"`
	ShellOnly   bool   `protobuf:"varint,6,opt,name=shell_only,json=shellOnly,proto3" json:"shell_only,omitempty"`
	// contains filtered or unexported fields
}

func (*FinalizedFile) Descriptor deprecated

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

Deprecated: Use FinalizedFile.ProtoReflect.Descriptor instead.

func (*FinalizedFile) GetChecksum

func (x *FinalizedFile) GetChecksum() string

func (*FinalizedFile) GetContentSize

func (x *FinalizedFile) GetContentSize() int64

func (*FinalizedFile) GetFileName

func (x *FinalizedFile) GetFileName() string

func (*FinalizedFile) GetKeyRange

func (x *FinalizedFile) GetKeyRange() string

func (*FinalizedFile) GetRowCount

func (x *FinalizedFile) GetRowCount() int64

func (*FinalizedFile) GetShellOnly

func (x *FinalizedFile) GetShellOnly() bool

func (*FinalizedFile) ProtoMessage

func (*FinalizedFile) ProtoMessage()

func (*FinalizedFile) ProtoReflect

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

func (*FinalizedFile) Reset

func (x *FinalizedFile) Reset()

func (*FinalizedFile) String

func (x *FinalizedFile) String() string

type ImportRequest

type ImportRequest struct {
	FileName  string `protobuf:"bytes,1,opt,name=fileName,proto3" json:"fileName,omitempty"`
	SessionId string `protobuf:"bytes,2,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"` // session_id for the app level session
	// contains filtered or unexported fields
}

func (*ImportRequest) Descriptor deprecated

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

Deprecated: Use ImportRequest.ProtoReflect.Descriptor instead.

func (*ImportRequest) GetFileName

func (x *ImportRequest) GetFileName() string

func (*ImportRequest) GetSessionId

func (x *ImportRequest) GetSessionId() string

func (*ImportRequest) ProtoMessage

func (*ImportRequest) ProtoMessage()

func (*ImportRequest) ProtoReflect

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

func (*ImportRequest) Reset

func (x *ImportRequest) Reset()

func (*ImportRequest) String

func (x *ImportRequest) String() string

type KeyRangeResponse

type KeyRangeResponse struct {
	BeginKey  []byte                    `protobuf:"bytes,1,opt,name=begin_key,json=beginKey,proto3" json:"begin_key,omitempty"`
	EndKey    []byte                    `protobuf:"bytes,2,opt,name=end_key,json=endKey,proto3" json:"end_key,omitempty"`
	StartTime int64                     `protobuf:"varint,3,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	EndTime   int64                     `protobuf:"varint,4,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	Status    KeyRangeResponse_OpStatus `protobuf:"varint,5,opt,name=status,proto3,enum=ferry.KeyRangeResponse_OpStatus" json:"status,omitempty"`
	FileUrl   string                    `protobuf:"bytes,6,opt,name=file_url,json=fileUrl,proto3" json:"file_url,omitempty"` // only set on success
	// contains filtered or unexported fields
}

func (*KeyRangeResponse) Descriptor deprecated

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

Deprecated: Use KeyRangeResponse.ProtoReflect.Descriptor instead.

func (*KeyRangeResponse) GetBeginKey

func (x *KeyRangeResponse) GetBeginKey() []byte

func (*KeyRangeResponse) GetEndKey

func (x *KeyRangeResponse) GetEndKey() []byte

func (*KeyRangeResponse) GetEndTime

func (x *KeyRangeResponse) GetEndTime() int64

func (*KeyRangeResponse) GetFileUrl

func (x *KeyRangeResponse) GetFileUrl() string

func (*KeyRangeResponse) GetStartTime

func (x *KeyRangeResponse) GetStartTime() int64

func (*KeyRangeResponse) GetStatus

func (*KeyRangeResponse) ProtoMessage

func (*KeyRangeResponse) ProtoMessage()

func (*KeyRangeResponse) ProtoReflect

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

func (*KeyRangeResponse) Reset

func (x *KeyRangeResponse) Reset()

func (*KeyRangeResponse) String

func (x *KeyRangeResponse) String() string

type KeyRangeResponse_OpStatus

type KeyRangeResponse_OpStatus int32
const (
	KeyRangeResponse_SUCCESS   KeyRangeResponse_OpStatus = 0 //
	KeyRangeResponse_FAILURE   KeyRangeResponse_OpStatus = 1 // FINAL failure - won't retry
	KeyRangeResponse_TRANSIENT KeyRangeResponse_OpStatus = 2 // TRANSIENT failure
)

func (KeyRangeResponse_OpStatus) Descriptor

func (KeyRangeResponse_OpStatus) Enum

func (KeyRangeResponse_OpStatus) EnumDescriptor deprecated

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

Deprecated: Use KeyRangeResponse_OpStatus.Descriptor instead.

func (KeyRangeResponse_OpStatus) Number

func (KeyRangeResponse_OpStatus) String

func (x KeyRangeResponse_OpStatus) String() string

func (KeyRangeResponse_OpStatus) Type

type KeyRequest

type KeyRequest struct {
	Begin     []byte `protobuf:"bytes,1,opt,name=begin,proto3" json:"begin,omitempty"`
	End       []byte `protobuf:"bytes,2,opt,name=end,proto3" json:"end,omitempty"`
	SessionId string `protobuf:"bytes,3,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"` // session_id for the app level session
	// contains filtered or unexported fields
}

func (*KeyRequest) Descriptor deprecated

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

Deprecated: Use KeyRequest.ProtoReflect.Descriptor instead.

func (*KeyRequest) GetBegin

func (x *KeyRequest) GetBegin() []byte

func (*KeyRequest) GetEnd

func (x *KeyRequest) GetEnd() []byte

func (*KeyRequest) GetSessionId

func (x *KeyRequest) GetSessionId() string

func (*KeyRequest) ProtoMessage

func (*KeyRequest) ProtoMessage()

func (*KeyRequest) ProtoReflect

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

func (*KeyRequest) Reset

func (x *KeyRequest) Reset()

func (*KeyRequest) String

func (x *KeyRequest) String() string

type Session

type Session struct {
	SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"` // session_id for the app level session
	// contains filtered or unexported fields
}

func (*Session) Descriptor deprecated

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

Deprecated: Use Session.ProtoReflect.Descriptor instead.

func (*Session) GetSessionId

func (x *Session) GetSessionId() string

func (*Session) ProtoMessage

func (*Session) ProtoMessage()

func (*Session) ProtoReflect

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

func (*Session) Reset

func (x *Session) Reset()

func (*Session) String

func (x *Session) String() string

type SessionResponse

type SessionResponse struct {
	Status         SessionResponse_OpStatus     `protobuf:"varint,1,opt,name=status,proto3,enum=ferry.SessionResponse_OpStatus" json:"status,omitempty"`   // status of operation
	State          SessionResponse_SessionState `protobuf:"varint,2,opt,name=state,proto3,enum=ferry.SessionResponse_SessionState" json:"state,omitempty"` // final state of session
	SessionId      string                       `protobuf:"bytes,3,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`                 // session_id for the app level session
	ErrorDetails   string                       `protobuf:"bytes,4,opt,name=error_details,json=errorDetails,proto3" json:"error_details,omitempty"`        // only set on success
	FinalizedFiles []*FinalizedFile             `protobuf:"bytes,5,rep,name=finalized_files,json=finalizedFiles,proto3" json:"finalized_files,omitempty"`
	// contains filtered or unexported fields
}

func (*SessionResponse) Descriptor deprecated

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

Deprecated: Use SessionResponse.ProtoReflect.Descriptor instead.

func (*SessionResponse) GetErrorDetails

func (x *SessionResponse) GetErrorDetails() string

func (*SessionResponse) GetFinalizedFiles

func (x *SessionResponse) GetFinalizedFiles() []*FinalizedFile

func (*SessionResponse) GetSessionId

func (x *SessionResponse) GetSessionId() string

func (*SessionResponse) GetState

func (*SessionResponse) GetStatus

func (*SessionResponse) ProtoMessage

func (*SessionResponse) ProtoMessage()

func (*SessionResponse) ProtoReflect

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

func (*SessionResponse) Reset

func (x *SessionResponse) Reset()

func (*SessionResponse) String

func (x *SessionResponse) String() string

type SessionResponse_OpStatus

type SessionResponse_OpStatus int32
const (
	SessionResponse_SUCCESS SessionResponse_OpStatus = 0
	SessionResponse_FAILURE SessionResponse_OpStatus = 1
)

func (SessionResponse_OpStatus) Descriptor

func (SessionResponse_OpStatus) Enum

func (SessionResponse_OpStatus) EnumDescriptor deprecated

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

Deprecated: Use SessionResponse_OpStatus.Descriptor instead.

func (SessionResponse_OpStatus) Number

func (SessionResponse_OpStatus) String

func (x SessionResponse_OpStatus) String() string

func (SessionResponse_OpStatus) Type

type SessionResponse_SessionState

type SessionResponse_SessionState int32
const (
	SessionResponse_STARTED SessionResponse_SessionState = 0
	SessionResponse_STOPPED SessionResponse_SessionState = 1
	SessionResponse_ENDED   SessionResponse_SessionState = 2
)

func (SessionResponse_SessionState) Descriptor

func (SessionResponse_SessionState) Enum

func (SessionResponse_SessionState) EnumDescriptor deprecated

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

Deprecated: Use SessionResponse_SessionState.Descriptor instead.

func (SessionResponse_SessionState) Number

func (SessionResponse_SessionState) String

func (SessionResponse_SessionState) Type

type Target

type Target struct {
	TargetUrl     string `protobuf:"bytes,1,opt,name=target_url,json=targetUrl,proto3" json:"target_url,omitempty"`
	ReaderThreads int32  `protobuf:"varint,2,opt,name=reader_threads,json=readerThreads,proto3" json:"reader_threads,omitempty"`
	Compress      bool   `protobuf:"varint,3,opt,name=compress,proto3" json:"compress,omitempty"`
	ReadPercent   int32  `protobuf:"varint,4,opt,name=read_percent,json=readPercent,proto3" json:"read_percent,omitempty"`
	ExportFormat  string `protobuf:"bytes,5,opt,name=export_format,json=exportFormat,proto3" json:"export_format,omitempty"`
	// contains filtered or unexported fields
}

func (*Target) Descriptor deprecated

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

Deprecated: Use Target.ProtoReflect.Descriptor instead.

func (*Target) GetCompress

func (x *Target) GetCompress() bool

func (*Target) GetExportFormat

func (x *Target) GetExportFormat() string

func (*Target) GetReadPercent

func (x *Target) GetReadPercent() int32

func (*Target) GetReaderThreads

func (x *Target) GetReaderThreads() int32

func (*Target) GetTargetUrl

func (x *Target) GetTargetUrl() string

func (*Target) ProtoMessage

func (*Target) ProtoMessage()

func (*Target) ProtoReflect

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

func (*Target) Reset

func (x *Target) Reset()

func (*Target) String

func (x *Target) String() string

type Time

type Time struct {
	Ts int64 `protobuf:"varint,1,opt,name=ts,proto3" json:"ts,omitempty"`
	// contains filtered or unexported fields
}

func (*Time) Descriptor deprecated

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

Deprecated: Use Time.ProtoReflect.Descriptor instead.

func (*Time) GetTs

func (x *Time) GetTs() int64

func (*Time) ProtoMessage

func (*Time) ProtoMessage()

func (*Time) ProtoReflect

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

func (*Time) Reset

func (x *Time) Reset()

func (*Time) String

func (x *Time) String() string

type UnimplementedFerryServer

type UnimplementedFerryServer struct {
}

UnimplementedFerryServer must be embedded to have forward compatible implementations.

func (UnimplementedFerryServer) EndExportSession

func (UnimplementedFerryServer) Export

func (UnimplementedFerryServer) GetExportedFile

func (UnimplementedFerryServer) Import

func (UnimplementedFerryServer) RemoveExportedFile

func (UnimplementedFerryServer) StartExportSession

func (UnimplementedFerryServer) StartImportSession

func (UnimplementedFerryServer) StopExportSession

func (UnimplementedFerryServer) StopImportSession

type UnsafeFerryServer

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

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

Jump to

Keyboard shortcuts

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