Documentation
¶
Index ¶
- Variables
- func RegisterFilesystemServer(s *grpc.Server, srv FilesystemServer)
- type CreateSymlinkRequest
- func (*CreateSymlinkRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateSymlinkRequest) GetSourcePath() string
- func (x *CreateSymlinkRequest) GetTargetPath() string
- func (*CreateSymlinkRequest) ProtoMessage()
- func (x *CreateSymlinkRequest) ProtoReflect() protoreflect.Message
- func (x *CreateSymlinkRequest) Reset()
- func (x *CreateSymlinkRequest) String() string
- type CreateSymlinkResponse
- type FilesystemClient
- type FilesystemServer
- type IsSymlinkRequest
- type IsSymlinkResponse
- type MkdirRequest
- type MkdirResponse
- type PathExistsRequest
- type PathExistsResponse
- func (*PathExistsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *PathExistsResponse) GetExists() bool
- func (*PathExistsResponse) ProtoMessage()
- func (x *PathExistsResponse) ProtoReflect() protoreflect.Message
- func (x *PathExistsResponse) Reset()
- func (x *PathExistsResponse) String() string
- type RmdirContentsRequest
- func (*RmdirContentsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *RmdirContentsRequest) GetPath() string
- func (*RmdirContentsRequest) ProtoMessage()
- func (x *RmdirContentsRequest) ProtoReflect() protoreflect.Message
- func (x *RmdirContentsRequest) Reset()
- func (x *RmdirContentsRequest) String() string
- type RmdirContentsResponse
- type RmdirRequest
- func (*RmdirRequest) Descriptor() ([]byte, []int)deprecated
- func (x *RmdirRequest) GetForce() bool
- func (x *RmdirRequest) GetPath() string
- func (*RmdirRequest) ProtoMessage()
- func (x *RmdirRequest) ProtoReflect() protoreflect.Message
- func (x *RmdirRequest) Reset()
- func (x *RmdirRequest) String() string
- type RmdirResponse
- type UnimplementedFilesystemServer
- func (*UnimplementedFilesystemServer) CreateSymlink(context.Context, *CreateSymlinkRequest) (*CreateSymlinkResponse, error)
- func (*UnimplementedFilesystemServer) IsSymlink(context.Context, *IsSymlinkRequest) (*IsSymlinkResponse, error)
- func (*UnimplementedFilesystemServer) Mkdir(context.Context, *MkdirRequest) (*MkdirResponse, error)
- func (*UnimplementedFilesystemServer) PathExists(context.Context, *PathExistsRequest) (*PathExistsResponse, error)
- func (*UnimplementedFilesystemServer) Rmdir(context.Context, *RmdirRequest) (*RmdirResponse, error)
- func (*UnimplementedFilesystemServer) RmdirContents(context.Context, *RmdirContentsRequest) (*RmdirContentsResponse, error)
Constants ¶
This section is empty.
Variables ¶
var File_github_com_kubernetes_csi_csi_proxy_client_api_filesystem_v2alpha1_api_proto protoreflect.FileDescriptor
Functions ¶
func RegisterFilesystemServer ¶
func RegisterFilesystemServer(s *grpc.Server, srv FilesystemServer)
Types ¶
type CreateSymlinkRequest ¶
type CreateSymlinkRequest struct {
// The path of the existing directory to be linked.
// All special characters allowed by Windows in path names will be allowed
// except for restrictions noted below. For details, please check:
// https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
//
// Restrictions:
// Only absolute path (indicated by a drive letter prefix: e.g. "C:\") is accepted.
// The path prefix needs needs to match the paths specified as
// kubelet-csi-plugins-path parameter of csi-proxy.
// UNC paths of the form "\\server\share\path\file" are not allowed.
// All directory separators need to be backslash character: "\".
// Characters: .. / : | ? * in the path are not allowed.
// source_path cannot already exist in the host filesystem.
// Maximum path length will be capped to 260 characters.
SourcePath string `protobuf:"bytes,1,opt,name=source_path,json=sourcePath,proto3" json:"source_path,omitempty"`
// Target path is the location of the new directory entry to be created in the host's filesystem.
// All special characters allowed by Windows in path names will be allowed
// except for restrictions noted below. For details, please check:
// https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
//
// Restrictions:
// Only absolute path (indicated by a drive letter prefix: e.g. "C:\") is accepted.
// The path prefix needs to match the paths specified as
// kubelet-pod-path parameter of csi-proxy.
// UNC paths of the form "\\server\share\path\file" are not allowed.
// All directory separators need to be backslash character: "\".
// Characters: .. / : | ? * in the path are not allowed.
// target_path needs to exist as a directory in the host that is empty.
// target_path cannot be a symbolic link.
// Maximum path length will be capped to 260 characters.
TargetPath string `protobuf:"bytes,2,opt,name=target_path,json=targetPath,proto3" json:"target_path,omitempty"`
// contains filtered or unexported fields
}
func (*CreateSymlinkRequest) Descriptor
deprecated
func (*CreateSymlinkRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateSymlinkRequest.ProtoReflect.Descriptor instead.
func (*CreateSymlinkRequest) GetSourcePath ¶
func (x *CreateSymlinkRequest) GetSourcePath() string
func (*CreateSymlinkRequest) GetTargetPath ¶
func (x *CreateSymlinkRequest) GetTargetPath() string
func (*CreateSymlinkRequest) ProtoMessage ¶
func (*CreateSymlinkRequest) ProtoMessage()
func (*CreateSymlinkRequest) ProtoReflect ¶
func (x *CreateSymlinkRequest) ProtoReflect() protoreflect.Message
func (*CreateSymlinkRequest) Reset ¶
func (x *CreateSymlinkRequest) Reset()
func (*CreateSymlinkRequest) String ¶
func (x *CreateSymlinkRequest) String() string
type CreateSymlinkResponse ¶
type CreateSymlinkResponse struct {
// contains filtered or unexported fields
}
func (*CreateSymlinkResponse) Descriptor
deprecated
func (*CreateSymlinkResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateSymlinkResponse.ProtoReflect.Descriptor instead.
func (*CreateSymlinkResponse) ProtoMessage ¶
func (*CreateSymlinkResponse) ProtoMessage()
func (*CreateSymlinkResponse) ProtoReflect ¶
func (x *CreateSymlinkResponse) ProtoReflect() protoreflect.Message
func (*CreateSymlinkResponse) Reset ¶
func (x *CreateSymlinkResponse) Reset()
func (*CreateSymlinkResponse) String ¶
func (x *CreateSymlinkResponse) String() string
type FilesystemClient ¶
type FilesystemClient interface {
// PathExists checks if the requested path exists in the host filesystem.
PathExists(ctx context.Context, in *PathExistsRequest, opts ...grpc.CallOption) (*PathExistsResponse, error)
// Mkdir creates a directory at the requested path in the host filesystem.
Mkdir(ctx context.Context, in *MkdirRequest, opts ...grpc.CallOption) (*MkdirResponse, error)
// Rmdir removes the directory at the requested path in the host filesystem.
// This may be used for unlinking a symlink created through CreateSymlink.
Rmdir(ctx context.Context, in *RmdirRequest, opts ...grpc.CallOption) (*RmdirResponse, error)
// RmdirContents removes the contents of a directory in the host filesystem.
// Unlike Rmdir it won't delete the requested path, it'll only delete its contents.
RmdirContents(ctx context.Context, in *RmdirContentsRequest, opts ...grpc.CallOption) (*RmdirContentsResponse, error)
// CreateSymlink creates a symbolic link called target_path that points to source_path
// in the host filesystem (target_path is the name of the symbolic link created,
// source_path is the existing path).
CreateSymlink(ctx context.Context, in *CreateSymlinkRequest, opts ...grpc.CallOption) (*CreateSymlinkResponse, error)
// IsSymlink checks if a given path is a symlink.
IsSymlink(ctx context.Context, in *IsSymlinkRequest, opts ...grpc.CallOption) (*IsSymlinkResponse, error)
}
FilesystemClient is the client API for Filesystem service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewFilesystemClient ¶
func NewFilesystemClient(cc grpc.ClientConnInterface) FilesystemClient
type FilesystemServer ¶
type FilesystemServer interface {
// PathExists checks if the requested path exists in the host filesystem.
PathExists(context.Context, *PathExistsRequest) (*PathExistsResponse, error)
// Mkdir creates a directory at the requested path in the host filesystem.
Mkdir(context.Context, *MkdirRequest) (*MkdirResponse, error)
// Rmdir removes the directory at the requested path in the host filesystem.
// This may be used for unlinking a symlink created through CreateSymlink.
Rmdir(context.Context, *RmdirRequest) (*RmdirResponse, error)
// RmdirContents removes the contents of a directory in the host filesystem.
// Unlike Rmdir it won't delete the requested path, it'll only delete its contents.
RmdirContents(context.Context, *RmdirContentsRequest) (*RmdirContentsResponse, error)
// CreateSymlink creates a symbolic link called target_path that points to source_path
// in the host filesystem (target_path is the name of the symbolic link created,
// source_path is the existing path).
CreateSymlink(context.Context, *CreateSymlinkRequest) (*CreateSymlinkResponse, error)
// IsSymlink checks if a given path is a symlink.
IsSymlink(context.Context, *IsSymlinkRequest) (*IsSymlinkResponse, error)
}
FilesystemServer is the server API for Filesystem service.
type IsSymlinkRequest ¶
type IsSymlinkRequest struct {
// The path whose existence as a symlink we want to check in the host's filesystem.
Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
// contains filtered or unexported fields
}
func (*IsSymlinkRequest) Descriptor
deprecated
func (*IsSymlinkRequest) Descriptor() ([]byte, []int)
Deprecated: Use IsSymlinkRequest.ProtoReflect.Descriptor instead.
func (*IsSymlinkRequest) GetPath ¶
func (x *IsSymlinkRequest) GetPath() string
func (*IsSymlinkRequest) ProtoMessage ¶
func (*IsSymlinkRequest) ProtoMessage()
func (*IsSymlinkRequest) ProtoReflect ¶
func (x *IsSymlinkRequest) ProtoReflect() protoreflect.Message
func (*IsSymlinkRequest) Reset ¶
func (x *IsSymlinkRequest) Reset()
func (*IsSymlinkRequest) String ¶
func (x *IsSymlinkRequest) String() string
type IsSymlinkResponse ¶
type IsSymlinkResponse struct {
// Indicates whether the path in IsSymlinkRequest is a symlink.
IsSymlink bool `protobuf:"varint,1,opt,name=is_symlink,json=isSymlink,proto3" json:"is_symlink,omitempty"`
// contains filtered or unexported fields
}
func (*IsSymlinkResponse) Descriptor
deprecated
func (*IsSymlinkResponse) Descriptor() ([]byte, []int)
Deprecated: Use IsSymlinkResponse.ProtoReflect.Descriptor instead.
func (*IsSymlinkResponse) GetIsSymlink ¶
func (x *IsSymlinkResponse) GetIsSymlink() bool
func (*IsSymlinkResponse) ProtoMessage ¶
func (*IsSymlinkResponse) ProtoMessage()
func (*IsSymlinkResponse) ProtoReflect ¶
func (x *IsSymlinkResponse) ProtoReflect() protoreflect.Message
func (*IsSymlinkResponse) Reset ¶
func (x *IsSymlinkResponse) Reset()
func (*IsSymlinkResponse) String ¶
func (x *IsSymlinkResponse) String() string
type MkdirRequest ¶
type MkdirRequest struct {
// The path to create in the host's filesystem.
// All special characters allowed by Windows in path names will be allowed
// except for restrictions noted below. For details, please check:
// https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
// Non-existent parent directories in the path will be automatically created.
// Directories will be created with Read and Write privileges of the Windows
// User account under which csi-proxy is started (typically LocalSystem).
//
// Restrictions:
// Only absolute path (indicated by a drive letter prefix: e.g. "C:\") is accepted.
// Depending on the context parameter of this function, the path prefix needs
// to match the paths specified either as kubelet-csi-plugins-path
// or as kubelet-pod-path parameters of csi-proxy.
// The path parameter cannot already exist in the host's filesystem.
// UNC paths of the form "\\server\share\path\file" are not allowed.
// All directory separators need to be backslash character: "\".
// Characters: .. / : | ? * in the path are not allowed.
// Maximum path length will be capped to 260 characters.
Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
// contains filtered or unexported fields
}
func (*MkdirRequest) Descriptor
deprecated
func (*MkdirRequest) Descriptor() ([]byte, []int)
Deprecated: Use MkdirRequest.ProtoReflect.Descriptor instead.
func (*MkdirRequest) GetPath ¶
func (x *MkdirRequest) GetPath() string
func (*MkdirRequest) ProtoMessage ¶
func (*MkdirRequest) ProtoMessage()
func (*MkdirRequest) ProtoReflect ¶
func (x *MkdirRequest) ProtoReflect() protoreflect.Message
func (*MkdirRequest) Reset ¶
func (x *MkdirRequest) Reset()
func (*MkdirRequest) String ¶
func (x *MkdirRequest) String() string
type MkdirResponse ¶
type MkdirResponse struct {
// contains filtered or unexported fields
}
func (*MkdirResponse) Descriptor
deprecated
func (*MkdirResponse) Descriptor() ([]byte, []int)
Deprecated: Use MkdirResponse.ProtoReflect.Descriptor instead.
func (*MkdirResponse) ProtoMessage ¶
func (*MkdirResponse) ProtoMessage()
func (*MkdirResponse) ProtoReflect ¶
func (x *MkdirResponse) ProtoReflect() protoreflect.Message
func (*MkdirResponse) Reset ¶
func (x *MkdirResponse) Reset()
func (*MkdirResponse) String ¶
func (x *MkdirResponse) String() string
type PathExistsRequest ¶
type PathExistsRequest struct {
// The path whose existence we want to check in the host's filesystem
Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
// contains filtered or unexported fields
}
func (*PathExistsRequest) Descriptor
deprecated
func (*PathExistsRequest) Descriptor() ([]byte, []int)
Deprecated: Use PathExistsRequest.ProtoReflect.Descriptor instead.
func (*PathExistsRequest) GetPath ¶
func (x *PathExistsRequest) GetPath() string
func (*PathExistsRequest) ProtoMessage ¶
func (*PathExistsRequest) ProtoMessage()
func (*PathExistsRequest) ProtoReflect ¶
func (x *PathExistsRequest) ProtoReflect() protoreflect.Message
func (*PathExistsRequest) Reset ¶
func (x *PathExistsRequest) Reset()
func (*PathExistsRequest) String ¶
func (x *PathExistsRequest) String() string
type PathExistsResponse ¶
type PathExistsResponse struct {
// Indicates whether the path in PathExistsRequest exists in the host's filesystem
Exists bool `protobuf:"varint,1,opt,name=exists,proto3" json:"exists,omitempty"`
// contains filtered or unexported fields
}
func (*PathExistsResponse) Descriptor
deprecated
func (*PathExistsResponse) Descriptor() ([]byte, []int)
Deprecated: Use PathExistsResponse.ProtoReflect.Descriptor instead.
func (*PathExistsResponse) GetExists ¶
func (x *PathExistsResponse) GetExists() bool
func (*PathExistsResponse) ProtoMessage ¶
func (*PathExistsResponse) ProtoMessage()
func (*PathExistsResponse) ProtoReflect ¶
func (x *PathExistsResponse) ProtoReflect() protoreflect.Message
func (*PathExistsResponse) Reset ¶
func (x *PathExistsResponse) Reset()
func (*PathExistsResponse) String ¶
func (x *PathExistsResponse) String() string
type RmdirContentsRequest ¶
type RmdirContentsRequest struct {
// The path whose contents will be removed in the host's filesystem.
// All special characters allowed by Windows in path names will be allowed
// except for restrictions noted below. For details, please check:
// https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
//
// Restrictions:
// Only absolute path (indicated by a drive letter prefix: e.g. "C:\") is accepted.
// Depending on the context parameter of this function, the path prefix needs
// to match the paths specified either as kubelet-csi-plugins-path
// or as kubelet-pod-path parameters of csi-proxy.
// UNC paths of the form "\\server\share\path\file" are not allowed.
// All directory separators need to be backslash character: "\".
// Characters: .. / : | ? * in the path are not allowed.
// Path cannot be a file of type symlink.
// Maximum path length will be capped to 260 characters.
Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
// contains filtered or unexported fields
}
func (*RmdirContentsRequest) Descriptor
deprecated
func (*RmdirContentsRequest) Descriptor() ([]byte, []int)
Deprecated: Use RmdirContentsRequest.ProtoReflect.Descriptor instead.
func (*RmdirContentsRequest) GetPath ¶
func (x *RmdirContentsRequest) GetPath() string
func (*RmdirContentsRequest) ProtoMessage ¶
func (*RmdirContentsRequest) ProtoMessage()
func (*RmdirContentsRequest) ProtoReflect ¶
func (x *RmdirContentsRequest) ProtoReflect() protoreflect.Message
func (*RmdirContentsRequest) Reset ¶
func (x *RmdirContentsRequest) Reset()
func (*RmdirContentsRequest) String ¶
func (x *RmdirContentsRequest) String() string
type RmdirContentsResponse ¶
type RmdirContentsResponse struct {
// contains filtered or unexported fields
}
func (*RmdirContentsResponse) Descriptor
deprecated
func (*RmdirContentsResponse) Descriptor() ([]byte, []int)
Deprecated: Use RmdirContentsResponse.ProtoReflect.Descriptor instead.
func (*RmdirContentsResponse) ProtoMessage ¶
func (*RmdirContentsResponse) ProtoMessage()
func (*RmdirContentsResponse) ProtoReflect ¶
func (x *RmdirContentsResponse) ProtoReflect() protoreflect.Message
func (*RmdirContentsResponse) Reset ¶
func (x *RmdirContentsResponse) Reset()
func (*RmdirContentsResponse) String ¶
func (x *RmdirContentsResponse) String() string
type RmdirRequest ¶
type RmdirRequest struct {
// The path to remove in the host's filesystem.
// All special characters allowed by Windows in path names will be allowed
// except for restrictions noted below. For details, please check:
// https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
//
// Restrictions:
// Only absolute path (indicated by a drive letter prefix: e.g. "C:\") is accepted.
// Depending on the context parameter of this function, the path prefix needs
// to match the paths specified either as kubelet-csi-plugins-path
// or as kubelet-pod-path parameters of csi-proxy.
// UNC paths of the form "\\server\share\path\file" are not allowed.
// All directory separators need to be backslash character: "\".
// Characters: .. / : | ? * in the path are not allowed.
// Path cannot be a file of type symlink.
// Maximum path length will be capped to 260 characters.
Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
// Force remove all contents under path (if any).
Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
// contains filtered or unexported fields
}
func (*RmdirRequest) Descriptor
deprecated
func (*RmdirRequest) Descriptor() ([]byte, []int)
Deprecated: Use RmdirRequest.ProtoReflect.Descriptor instead.
func (*RmdirRequest) GetForce ¶
func (x *RmdirRequest) GetForce() bool
func (*RmdirRequest) GetPath ¶
func (x *RmdirRequest) GetPath() string
func (*RmdirRequest) ProtoMessage ¶
func (*RmdirRequest) ProtoMessage()
func (*RmdirRequest) ProtoReflect ¶
func (x *RmdirRequest) ProtoReflect() protoreflect.Message
func (*RmdirRequest) Reset ¶
func (x *RmdirRequest) Reset()
func (*RmdirRequest) String ¶
func (x *RmdirRequest) String() string
type RmdirResponse ¶
type RmdirResponse struct {
// contains filtered or unexported fields
}
func (*RmdirResponse) Descriptor
deprecated
func (*RmdirResponse) Descriptor() ([]byte, []int)
Deprecated: Use RmdirResponse.ProtoReflect.Descriptor instead.
func (*RmdirResponse) ProtoMessage ¶
func (*RmdirResponse) ProtoMessage()
func (*RmdirResponse) ProtoReflect ¶
func (x *RmdirResponse) ProtoReflect() protoreflect.Message
func (*RmdirResponse) Reset ¶
func (x *RmdirResponse) Reset()
func (*RmdirResponse) String ¶
func (x *RmdirResponse) String() string
type UnimplementedFilesystemServer ¶
type UnimplementedFilesystemServer struct {
}
UnimplementedFilesystemServer can be embedded to have forward compatible implementations.
func (*UnimplementedFilesystemServer) CreateSymlink ¶
func (*UnimplementedFilesystemServer) CreateSymlink(context.Context, *CreateSymlinkRequest) (*CreateSymlinkResponse, error)
func (*UnimplementedFilesystemServer) IsSymlink ¶
func (*UnimplementedFilesystemServer) IsSymlink(context.Context, *IsSymlinkRequest) (*IsSymlinkResponse, error)
func (*UnimplementedFilesystemServer) Mkdir ¶
func (*UnimplementedFilesystemServer) Mkdir(context.Context, *MkdirRequest) (*MkdirResponse, error)
func (*UnimplementedFilesystemServer) PathExists ¶
func (*UnimplementedFilesystemServer) PathExists(context.Context, *PathExistsRequest) (*PathExistsResponse, error)
func (*UnimplementedFilesystemServer) Rmdir ¶
func (*UnimplementedFilesystemServer) Rmdir(context.Context, *RmdirRequest) (*RmdirResponse, error)
func (*UnimplementedFilesystemServer) RmdirContents ¶
func (*UnimplementedFilesystemServer) RmdirContents(context.Context, *RmdirContentsRequest) (*RmdirContentsResponse, error)