Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterFileServer(s grpc.ServiceRegistrar, srv FileServer)
- type FileClient
- type FileServer
- type File_GetClient
- type File_GetServer
- type File_PutClient
- type File_PutServer
- type GetRequest
- type GetResponse
- func (*GetResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetResponse) GetContents() []byte
- func (x *GetResponse) GetHash() *types.HashType
- func (x *GetResponse) GetResponse() isGetResponse_Response
- func (*GetResponse) ProtoMessage()
- func (x *GetResponse) ProtoReflect() protoreflect.Message
- func (x *GetResponse) Reset()
- func (x *GetResponse) String() string
- type GetResponse_Contents
- type GetResponse_Hash
- type PutRequest
- func (*PutRequest) Descriptor() ([]byte, []int)deprecated
- func (x *PutRequest) GetContents() []byte
- func (x *PutRequest) GetHash() *types.HashType
- func (x *PutRequest) GetOpen() *PutRequest_Details
- func (x *PutRequest) GetRequest() isPutRequest_Request
- func (*PutRequest) ProtoMessage()
- func (x *PutRequest) ProtoReflect() protoreflect.Message
- func (x *PutRequest) Reset()
- func (x *PutRequest) String() string
- type PutRequest_Contents
- type PutRequest_Details
- func (*PutRequest_Details) Descriptor() ([]byte, []int)deprecated
- func (x *PutRequest_Details) GetPermissions() uint32
- func (x *PutRequest_Details) GetRemoteFile() string
- func (*PutRequest_Details) ProtoMessage()
- func (x *PutRequest_Details) ProtoReflect() protoreflect.Message
- func (x *PutRequest_Details) Reset()
- func (x *PutRequest_Details) String() string
- type PutRequest_Hash
- type PutRequest_Open
- type PutResponse
- type RemoveRequest
- type RemoveResponse
- type StatInfo
- func (*StatInfo) Descriptor() ([]byte, []int)deprecated
- func (x *StatInfo) GetLastModified() uint64
- func (x *StatInfo) GetPath() string
- func (x *StatInfo) GetPermissions() uint32
- func (x *StatInfo) GetSize() uint64
- func (x *StatInfo) GetUmask() uint32
- func (*StatInfo) ProtoMessage()
- func (x *StatInfo) ProtoReflect() protoreflect.Message
- func (x *StatInfo) Reset()
- func (x *StatInfo) String() string
- type StatRequest
- type StatResponse
- type TransferToRemoteRequest
- func (*TransferToRemoteRequest) Descriptor() ([]byte, []int)deprecated
- func (x *TransferToRemoteRequest) GetLocalPath() string
- func (x *TransferToRemoteRequest) GetRemoteDownload() *common.RemoteDownload
- func (*TransferToRemoteRequest) ProtoMessage()
- func (x *TransferToRemoteRequest) ProtoReflect() protoreflect.Message
- func (x *TransferToRemoteRequest) Reset()
- func (x *TransferToRemoteRequest) String() string
- type TransferToRemoteResponse
- func (*TransferToRemoteResponse) Descriptor() ([]byte, []int)deprecated
- func (x *TransferToRemoteResponse) GetHash() *types.HashType
- func (*TransferToRemoteResponse) ProtoMessage()
- func (x *TransferToRemoteResponse) ProtoReflect() protoreflect.Message
- func (x *TransferToRemoteResponse) Reset()
- func (x *TransferToRemoteResponse) String() string
- type UnimplementedFileServer
- func (UnimplementedFileServer) Get(*GetRequest, grpc.ServerStreamingServer[GetResponse]) error
- func (UnimplementedFileServer) Put(grpc.ClientStreamingServer[PutRequest, PutResponse]) error
- func (UnimplementedFileServer) Remove(context.Context, *RemoveRequest) (*RemoveResponse, error)
- func (UnimplementedFileServer) Stat(context.Context, *StatRequest) (*StatResponse, error)
- func (UnimplementedFileServer) TransferToRemote(context.Context, *TransferToRemoteRequest) (*TransferToRemoteResponse, error)
- type UnsafeFileServer
Constants ¶
const ( File_Get_FullMethodName = "/gnoi.file.File/Get" File_TransferToRemote_FullMethodName = "/gnoi.file.File/TransferToRemote" File_Put_FullMethodName = "/gnoi.file.File/Put" File_Stat_FullMethodName = "/gnoi.file.File/Stat" File_Remove_FullMethodName = "/gnoi.file.File/Remove" )
Variables ¶
var File_ServiceDesc = grpc.ServiceDesc{ ServiceName: "gnoi.file.File", HandlerType: (*FileServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "TransferToRemote", Handler: _File_TransferToRemote_Handler, }, { MethodName: "Stat", Handler: _File_Stat_Handler, }, { MethodName: "Remove", Handler: _File_Remove_Handler, }, }, Streams: []grpc.StreamDesc{ { StreamName: "Get", Handler: _File_Get_Handler, ServerStreams: true, }, { StreamName: "Put", Handler: _File_Put_Handler, ClientStreams: true, }, }, Metadata: "github.com/openconfig/gnoi/file/file.proto", }
File_ServiceDesc is the grpc.ServiceDesc for File service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_github_com_openconfig_gnoi_file_file_proto protoreflect.FileDescriptor
Functions ¶
func RegisterFileServer ¶
func RegisterFileServer(s grpc.ServiceRegistrar, srv FileServer)
Types ¶
type FileClient ¶
type FileClient interface {
Get(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[GetResponse], error)
TransferToRemote(ctx context.Context, in *TransferToRemoteRequest, opts ...grpc.CallOption) (*TransferToRemoteResponse, error)
Put(ctx context.Context, opts ...grpc.CallOption) (grpc.ClientStreamingClient[PutRequest, PutResponse], error)
Stat(ctx context.Context, in *StatRequest, opts ...grpc.CallOption) (*StatResponse, error)
Remove(ctx context.Context, in *RemoveRequest, opts ...grpc.CallOption) (*RemoveResponse, error)
}
FileClient is the client API for File 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 NewFileClient ¶
func NewFileClient(cc grpc.ClientConnInterface) FileClient
type FileServer ¶
type FileServer interface {
Get(*GetRequest, grpc.ServerStreamingServer[GetResponse]) error
TransferToRemote(context.Context, *TransferToRemoteRequest) (*TransferToRemoteResponse, error)
Put(grpc.ClientStreamingServer[PutRequest, PutResponse]) error
Stat(context.Context, *StatRequest) (*StatResponse, error)
Remove(context.Context, *RemoveRequest) (*RemoveResponse, error)
}
FileServer is the server API for File service. All implementations should embed UnimplementedFileServer for forward compatibility.
type File_GetClient ¶
type File_GetClient = grpc.ServerStreamingClient[GetResponse]
This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
type File_GetServer ¶
type File_GetServer = grpc.ServerStreamingServer[GetResponse]
This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
type File_PutClient ¶
type File_PutClient = grpc.ClientStreamingClient[PutRequest, PutResponse]
This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
type File_PutServer ¶
type File_PutServer = grpc.ClientStreamingServer[PutRequest, PutResponse]
This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
type GetRequest ¶
type GetRequest struct {
RemoteFile string `protobuf:"bytes,1,opt,name=remote_file,json=remoteFile,proto3" json:"remote_file,omitempty"`
// contains filtered or unexported fields
}
func (*GetRequest) Descriptor
deprecated
func (*GetRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetRequest.ProtoReflect.Descriptor instead.
func (*GetRequest) GetRemoteFile ¶
func (x *GetRequest) GetRemoteFile() string
func (*GetRequest) ProtoMessage ¶
func (*GetRequest) ProtoMessage()
func (*GetRequest) ProtoReflect ¶
func (x *GetRequest) ProtoReflect() protoreflect.Message
func (*GetRequest) Reset ¶
func (x *GetRequest) Reset()
func (*GetRequest) String ¶
func (x *GetRequest) String() string
type GetResponse ¶
type GetResponse struct {
// Types that are valid to be assigned to Response:
//
// *GetResponse_Contents
// *GetResponse_Hash
Response isGetResponse_Response `protobuf_oneof:"response"`
// contains filtered or unexported fields
}
func (*GetResponse) Descriptor
deprecated
func (*GetResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetResponse.ProtoReflect.Descriptor instead.
func (*GetResponse) GetContents ¶
func (x *GetResponse) GetContents() []byte
func (*GetResponse) GetHash ¶
func (x *GetResponse) GetHash() *types.HashType
func (*GetResponse) GetResponse ¶
func (x *GetResponse) GetResponse() isGetResponse_Response
func (*GetResponse) ProtoMessage ¶
func (*GetResponse) ProtoMessage()
func (*GetResponse) ProtoReflect ¶
func (x *GetResponse) ProtoReflect() protoreflect.Message
func (*GetResponse) Reset ¶
func (x *GetResponse) Reset()
func (*GetResponse) String ¶
func (x *GetResponse) String() string
type GetResponse_Contents ¶
type GetResponse_Contents struct {
Contents []byte `protobuf:"bytes,1,opt,name=contents,proto3,oneof"`
}
type GetResponse_Hash ¶
type PutRequest ¶
type PutRequest struct {
// Types that are valid to be assigned to Request:
//
// *PutRequest_Open
// *PutRequest_Contents
// *PutRequest_Hash
Request isPutRequest_Request `protobuf_oneof:"request"`
// contains filtered or unexported fields
}
func (*PutRequest) Descriptor
deprecated
func (*PutRequest) Descriptor() ([]byte, []int)
Deprecated: Use PutRequest.ProtoReflect.Descriptor instead.
func (*PutRequest) GetContents ¶
func (x *PutRequest) GetContents() []byte
func (*PutRequest) GetHash ¶
func (x *PutRequest) GetHash() *types.HashType
func (*PutRequest) GetOpen ¶
func (x *PutRequest) GetOpen() *PutRequest_Details
func (*PutRequest) GetRequest ¶
func (x *PutRequest) GetRequest() isPutRequest_Request
func (*PutRequest) ProtoMessage ¶
func (*PutRequest) ProtoMessage()
func (*PutRequest) ProtoReflect ¶
func (x *PutRequest) ProtoReflect() protoreflect.Message
func (*PutRequest) Reset ¶
func (x *PutRequest) Reset()
func (*PutRequest) String ¶
func (x *PutRequest) String() string
type PutRequest_Contents ¶
type PutRequest_Contents struct {
Contents []byte `protobuf:"bytes,2,opt,name=contents,proto3,oneof"`
}
type PutRequest_Details ¶
type PutRequest_Details struct {
RemoteFile string `protobuf:"bytes,1,opt,name=remote_file,json=remoteFile,proto3" json:"remote_file,omitempty"`
Permissions uint32 `protobuf:"varint,2,opt,name=permissions,proto3" json:"permissions,omitempty"`
// contains filtered or unexported fields
}
func (*PutRequest_Details) Descriptor
deprecated
func (*PutRequest_Details) Descriptor() ([]byte, []int)
Deprecated: Use PutRequest_Details.ProtoReflect.Descriptor instead.
func (*PutRequest_Details) GetPermissions ¶
func (x *PutRequest_Details) GetPermissions() uint32
func (*PutRequest_Details) GetRemoteFile ¶
func (x *PutRequest_Details) GetRemoteFile() string
func (*PutRequest_Details) ProtoMessage ¶
func (*PutRequest_Details) ProtoMessage()
func (*PutRequest_Details) ProtoReflect ¶
func (x *PutRequest_Details) ProtoReflect() protoreflect.Message
func (*PutRequest_Details) Reset ¶
func (x *PutRequest_Details) Reset()
func (*PutRequest_Details) String ¶
func (x *PutRequest_Details) String() string
type PutRequest_Hash ¶
type PutRequest_Open ¶
type PutRequest_Open struct {
Open *PutRequest_Details `protobuf:"bytes,1,opt,name=open,proto3,oneof"`
}
type PutResponse ¶
type PutResponse struct {
// contains filtered or unexported fields
}
func (*PutResponse) Descriptor
deprecated
func (*PutResponse) Descriptor() ([]byte, []int)
Deprecated: Use PutResponse.ProtoReflect.Descriptor instead.
func (*PutResponse) ProtoMessage ¶
func (*PutResponse) ProtoMessage()
func (*PutResponse) ProtoReflect ¶
func (x *PutResponse) ProtoReflect() protoreflect.Message
func (*PutResponse) Reset ¶
func (x *PutResponse) Reset()
func (*PutResponse) String ¶
func (x *PutResponse) String() string
type RemoveRequest ¶
type RemoveRequest struct {
RemoteFile string `protobuf:"bytes,1,opt,name=remote_file,json=remoteFile,proto3" json:"remote_file,omitempty"`
// contains filtered or unexported fields
}
func (*RemoveRequest) Descriptor
deprecated
func (*RemoveRequest) Descriptor() ([]byte, []int)
Deprecated: Use RemoveRequest.ProtoReflect.Descriptor instead.
func (*RemoveRequest) GetRemoteFile ¶
func (x *RemoveRequest) GetRemoteFile() string
func (*RemoveRequest) ProtoMessage ¶
func (*RemoveRequest) ProtoMessage()
func (*RemoveRequest) ProtoReflect ¶
func (x *RemoveRequest) ProtoReflect() protoreflect.Message
func (*RemoveRequest) Reset ¶
func (x *RemoveRequest) Reset()
func (*RemoveRequest) String ¶
func (x *RemoveRequest) String() string
type RemoveResponse ¶
type RemoveResponse struct {
// contains filtered or unexported fields
}
func (*RemoveResponse) Descriptor
deprecated
func (*RemoveResponse) Descriptor() ([]byte, []int)
Deprecated: Use RemoveResponse.ProtoReflect.Descriptor instead.
func (*RemoveResponse) ProtoMessage ¶
func (*RemoveResponse) ProtoMessage()
func (*RemoveResponse) ProtoReflect ¶
func (x *RemoveResponse) ProtoReflect() protoreflect.Message
func (*RemoveResponse) Reset ¶
func (x *RemoveResponse) Reset()
func (*RemoveResponse) String ¶
func (x *RemoveResponse) String() string
type StatInfo ¶
type StatInfo struct {
Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
LastModified uint64 `protobuf:"varint,2,opt,name=last_modified,json=lastModified,proto3" json:"last_modified,omitempty"`
Permissions uint32 `protobuf:"varint,3,opt,name=permissions,proto3" json:"permissions,omitempty"`
Size uint64 `protobuf:"varint,4,opt,name=size,proto3" json:"size,omitempty"`
Umask uint32 `protobuf:"varint,5,opt,name=umask,proto3" json:"umask,omitempty"`
// contains filtered or unexported fields
}
func (*StatInfo) Descriptor
deprecated
func (*StatInfo) GetLastModified ¶
func (*StatInfo) GetPermissions ¶
func (*StatInfo) ProtoMessage ¶
func (*StatInfo) ProtoMessage()
func (*StatInfo) ProtoReflect ¶
func (x *StatInfo) ProtoReflect() protoreflect.Message
type StatRequest ¶
type StatRequest struct {
Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
// contains filtered or unexported fields
}
func (*StatRequest) Descriptor
deprecated
func (*StatRequest) Descriptor() ([]byte, []int)
Deprecated: Use StatRequest.ProtoReflect.Descriptor instead.
func (*StatRequest) GetPath ¶
func (x *StatRequest) GetPath() string
func (*StatRequest) ProtoMessage ¶
func (*StatRequest) ProtoMessage()
func (*StatRequest) ProtoReflect ¶
func (x *StatRequest) ProtoReflect() protoreflect.Message
func (*StatRequest) Reset ¶
func (x *StatRequest) Reset()
func (*StatRequest) String ¶
func (x *StatRequest) String() string
type StatResponse ¶
type StatResponse struct {
Stats []*StatInfo `protobuf:"bytes,1,rep,name=stats,proto3" json:"stats,omitempty"`
// contains filtered or unexported fields
}
func (*StatResponse) Descriptor
deprecated
func (*StatResponse) Descriptor() ([]byte, []int)
Deprecated: Use StatResponse.ProtoReflect.Descriptor instead.
func (*StatResponse) GetStats ¶
func (x *StatResponse) GetStats() []*StatInfo
func (*StatResponse) ProtoMessage ¶
func (*StatResponse) ProtoMessage()
func (*StatResponse) ProtoReflect ¶
func (x *StatResponse) ProtoReflect() protoreflect.Message
func (*StatResponse) Reset ¶
func (x *StatResponse) Reset()
func (*StatResponse) String ¶
func (x *StatResponse) String() string
type TransferToRemoteRequest ¶
type TransferToRemoteRequest struct {
LocalPath string `protobuf:"bytes,1,opt,name=local_path,json=localPath,proto3" json:"local_path,omitempty"`
RemoteDownload *common.RemoteDownload `protobuf:"bytes,2,opt,name=remote_download,json=remoteDownload,proto3" json:"remote_download,omitempty"`
// contains filtered or unexported fields
}
func (*TransferToRemoteRequest) Descriptor
deprecated
func (*TransferToRemoteRequest) Descriptor() ([]byte, []int)
Deprecated: Use TransferToRemoteRequest.ProtoReflect.Descriptor instead.
func (*TransferToRemoteRequest) GetLocalPath ¶
func (x *TransferToRemoteRequest) GetLocalPath() string
func (*TransferToRemoteRequest) GetRemoteDownload ¶
func (x *TransferToRemoteRequest) GetRemoteDownload() *common.RemoteDownload
func (*TransferToRemoteRequest) ProtoMessage ¶
func (*TransferToRemoteRequest) ProtoMessage()
func (*TransferToRemoteRequest) ProtoReflect ¶
func (x *TransferToRemoteRequest) ProtoReflect() protoreflect.Message
func (*TransferToRemoteRequest) Reset ¶
func (x *TransferToRemoteRequest) Reset()
func (*TransferToRemoteRequest) String ¶
func (x *TransferToRemoteRequest) String() string
type TransferToRemoteResponse ¶
type TransferToRemoteResponse struct {
Hash *types.HashType `protobuf:"bytes,1,opt,name=hash,proto3" json:"hash,omitempty"`
// contains filtered or unexported fields
}
func (*TransferToRemoteResponse) Descriptor
deprecated
func (*TransferToRemoteResponse) Descriptor() ([]byte, []int)
Deprecated: Use TransferToRemoteResponse.ProtoReflect.Descriptor instead.
func (*TransferToRemoteResponse) GetHash ¶
func (x *TransferToRemoteResponse) GetHash() *types.HashType
func (*TransferToRemoteResponse) ProtoMessage ¶
func (*TransferToRemoteResponse) ProtoMessage()
func (*TransferToRemoteResponse) ProtoReflect ¶
func (x *TransferToRemoteResponse) ProtoReflect() protoreflect.Message
func (*TransferToRemoteResponse) Reset ¶
func (x *TransferToRemoteResponse) Reset()
func (*TransferToRemoteResponse) String ¶
func (x *TransferToRemoteResponse) String() string
type UnimplementedFileServer ¶
type UnimplementedFileServer struct{}
UnimplementedFileServer should 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 (UnimplementedFileServer) Get ¶
func (UnimplementedFileServer) Get(*GetRequest, grpc.ServerStreamingServer[GetResponse]) error
func (UnimplementedFileServer) Put ¶
func (UnimplementedFileServer) Put(grpc.ClientStreamingServer[PutRequest, PutResponse]) error
func (UnimplementedFileServer) Remove ¶
func (UnimplementedFileServer) Remove(context.Context, *RemoveRequest) (*RemoveResponse, error)
func (UnimplementedFileServer) Stat ¶
func (UnimplementedFileServer) Stat(context.Context, *StatRequest) (*StatResponse, error)
func (UnimplementedFileServer) TransferToRemote ¶
func (UnimplementedFileServer) TransferToRemote(context.Context, *TransferToRemoteRequest) (*TransferToRemoteResponse, error)
type UnsafeFileServer ¶
type UnsafeFileServer interface {
// contains filtered or unexported methods
}
UnsafeFileServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to FileServer will result in compilation errors.