reclaimspace

package
v0.2.4 Latest Latest
Warning

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

 Go to latest Published: Aug 19, 2023 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_reclaimspace_reclaimspace_proto protoreflect.FileDescriptor
View Source 
var ReclaimSpaceController_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "reclaimspace.ReclaimSpaceController",
	HandlerType: (*ReclaimSpaceControllerServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ControllerReclaimSpace",
			Handler:    _ReclaimSpaceController_ControllerReclaimSpace_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "reclaimspace/reclaimspace.proto",
}

ReclaimSpaceController_ServiceDesc is the grpc.ServiceDesc for ReclaimSpaceController 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 ReclaimSpaceNode_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "reclaimspace.ReclaimSpaceNode",
	HandlerType: (*ReclaimSpaceNodeServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "NodeReclaimSpace",
			Handler:    _ReclaimSpaceNode_NodeReclaimSpace_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "reclaimspace/reclaimspace.proto",
}

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

Functions

func RegisterReclaimSpaceControllerServer 

func RegisterReclaimSpaceControllerServer(s grpc.ServiceRegistrar, srv ReclaimSpaceControllerServer)

func RegisterReclaimSpaceNodeServer 

func RegisterReclaimSpaceNodeServer(s grpc.ServiceRegistrar, srv ReclaimSpaceNodeServer)

Types

type ControllerReclaimSpaceRequest 

type ControllerReclaimSpaceRequest struct {

	// The ID of the volume. This field is REQUIRED.
	VolumeId string `protobuf:"bytes,1,opt,name=volume_id,json=volumeId,proto3" json:"volume_id,omitempty"`
	// Plugin specific parameters passed in as opaque key-value pairs.
	Parameters map[string]string `` /* 161-byte string literal not displayed */
	// Secrets required by the plugin to complete the request.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

ControllerReclaimSpaceRequest contains the information needed to identify the volume by the SP and access any backend services so that space can be reclaimed.

func (*ControllerReclaimSpaceRequest) Descriptor deprecated 

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

Deprecated: Use ControllerReclaimSpaceRequest.ProtoReflect.Descriptor instead.

func (*ControllerReclaimSpaceRequest) GetParameters 

func (x *ControllerReclaimSpaceRequest) GetParameters() map[string]string

func (*ControllerReclaimSpaceRequest) GetSecrets 

func (x *ControllerReclaimSpaceRequest) GetSecrets() map[string]string

func (*ControllerReclaimSpaceRequest) GetVolumeId 

func (x *ControllerReclaimSpaceRequest) GetVolumeId() string

func (*ControllerReclaimSpaceRequest) ProtoMessage 

func (*ControllerReclaimSpaceRequest) ProtoMessage()

func (*ControllerReclaimSpaceRequest) ProtoReflect 

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

func (*ControllerReclaimSpaceRequest) Reset 

func (x *ControllerReclaimSpaceRequest) Reset()

func (*ControllerReclaimSpaceRequest) String 

func (x *ControllerReclaimSpaceRequest) String() string

type ControllerReclaimSpaceResponse 

type ControllerReclaimSpaceResponse struct {

	// This field is OPTIONAL. This allows the SP to inform the CO about the
	// storage consumption before the ReclaimSpace operation was executed.
	PreUsage *StorageConsumption `protobuf:"bytes,1,opt,name=pre_usage,json=preUsage,proto3" json:"pre_usage,omitempty"`
	// This field is OPTIONAL. This allows the SP to inform the CO about the
	// storage consumption after the ReclaimSpace operation was executed.
	PostUsage *StorageConsumption `protobuf:"bytes,2,opt,name=post_usage,json=postUsage,proto3" json:"post_usage,omitempty"`
	// contains filtered or unexported fields
}

ControllerReclaimSpaceResponse holds the information about the result of the ControllerReclaimSpaceRequest call.

func (*ControllerReclaimSpaceResponse) Descriptor deprecated 

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

Deprecated: Use ControllerReclaimSpaceResponse.ProtoReflect.Descriptor instead.

func (*ControllerReclaimSpaceResponse) GetPostUsage 

func (x *ControllerReclaimSpaceResponse) GetPostUsage() *StorageConsumption

func (*ControllerReclaimSpaceResponse) GetPreUsage 

func (x *ControllerReclaimSpaceResponse) GetPreUsage() *StorageConsumption

func (*ControllerReclaimSpaceResponse) ProtoMessage 

func (*ControllerReclaimSpaceResponse) ProtoMessage()

func (*ControllerReclaimSpaceResponse) ProtoReflect 

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

func (*ControllerReclaimSpaceResponse) Reset 

func (x *ControllerReclaimSpaceResponse) Reset()

func (*ControllerReclaimSpaceResponse) String 

func (x *ControllerReclaimSpaceResponse) String() string

type NodeReclaimSpaceRequest 

type NodeReclaimSpaceRequest struct {

	// The ID of the volume. This field is REQUIRED.
	VolumeId string `protobuf:"bytes,1,opt,name=volume_id,json=volumeId,proto3" json:"volume_id,omitempty"`
	// The path on which volume is available. This field is REQUIRED.
	// This field overrides the general CSI size limit.
	// SP SHOULD support the maximum path length allowed by the operating
	// system/filesystem, but, at a minimum, SP MUST accept a max path
	// length of at least 128 bytes.
	VolumePath string `protobuf:"bytes,2,opt,name=volume_path,json=volumePath,proto3" json:"volume_path,omitempty"`
	// The path where the volume is staged, if the plugin has the
	// STAGE_UNSTAGE_VOLUME capability, otherwise empty.
	// If not empty, it MUST be an absolute path in the root
	// filesystem of the process serving this request.
	// This field is OPTIONAL.
	// This field overrides the general CSI size limit.
	// SP SHOULD support the maximum path length allowed by the operating
	// system/filesystem, but, at a minimum, SP MUST accept a max path
	// length of at least 128 bytes.
	StagingTargetPath string `protobuf:"bytes,3,opt,name=staging_target_path,json=stagingTargetPath,proto3" json:"staging_target_path,omitempty"`
	// Volume capability describing how the CO intends to use this volume.
	// This allows SP to determine if volume is being used as a block
	// device or mounted file system. For example - if volume is being
	// used as a block device the SP MAY choose to skip calling filesystem
	// operations to reclaim space, but still perform rest of the housekeeping
	// needed for reducing the size of the volume. If volume_capability is
	// omitted the SP MAY determine access_type from given volume_path for the
	// volume and perform space reduction. This is an OPTIONAL field.
	VolumeCapability *csi.VolumeCapability `protobuf:"bytes,4,opt,name=volume_capability,json=volumeCapability,proto3" json:"volume_capability,omitempty"`
	// Secrets required by plugin to complete the reclaim space operation.
	// This field is OPTIONAL.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

NodeReclaimSpaceRequest contains the information needed to identify the location where the volume is mounted so that local filesystem or block-device operations to reclaim space can be executed.

func (*NodeReclaimSpaceRequest) Descriptor deprecated 

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

Deprecated: Use NodeReclaimSpaceRequest.ProtoReflect.Descriptor instead.

func (*NodeReclaimSpaceRequest) GetSecrets 

func (x *NodeReclaimSpaceRequest) GetSecrets() map[string]string

func (*NodeReclaimSpaceRequest) GetStagingTargetPath 

func (x *NodeReclaimSpaceRequest) GetStagingTargetPath() string

func (*NodeReclaimSpaceRequest) GetVolumeCapability 

func (x *NodeReclaimSpaceRequest) GetVolumeCapability() *csi.VolumeCapability

func (*NodeReclaimSpaceRequest) GetVolumeId 

func (x *NodeReclaimSpaceRequest) GetVolumeId() string

func (*NodeReclaimSpaceRequest) GetVolumePath 

func (x *NodeReclaimSpaceRequest) GetVolumePath() string

func (*NodeReclaimSpaceRequest) ProtoMessage 

func (*NodeReclaimSpaceRequest) ProtoMessage()

func (*NodeReclaimSpaceRequest) ProtoReflect 

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

func (*NodeReclaimSpaceRequest) Reset 

func (x *NodeReclaimSpaceRequest) Reset()

func (*NodeReclaimSpaceRequest) String 

func (x *NodeReclaimSpaceRequest) String() string

type NodeReclaimSpaceResponse 

type NodeReclaimSpaceResponse struct {

	// This field is OPTIONAL. This allows the SP to inform the CO about the
	// storage consumption before the ReclaimSpace operation was executed.
	PreUsage *StorageConsumption `protobuf:"bytes,1,opt,name=pre_usage,json=preUsage,proto3" json:"pre_usage,omitempty"`
	// This field is OPTIONAL. This allows the SP to inform the CO about the
	// storage consumption after the ReclaimSpace operation was executed.
	PostUsage *StorageConsumption `protobuf:"bytes,2,opt,name=post_usage,json=postUsage,proto3" json:"post_usage,omitempty"`
	// contains filtered or unexported fields
}

NodeReclaimSpaceResponse holds the information about the result of the NodeReclaimSpaceRequest call.

func (*NodeReclaimSpaceResponse) Descriptor deprecated 

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

Deprecated: Use NodeReclaimSpaceResponse.ProtoReflect.Descriptor instead.

func (*NodeReclaimSpaceResponse) GetPostUsage 

func (x *NodeReclaimSpaceResponse) GetPostUsage() *StorageConsumption

func (*NodeReclaimSpaceResponse) GetPreUsage 

func (x *NodeReclaimSpaceResponse) GetPreUsage() *StorageConsumption

func (*NodeReclaimSpaceResponse) ProtoMessage 

func (*NodeReclaimSpaceResponse) ProtoMessage()

func (*NodeReclaimSpaceResponse) ProtoReflect 

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

func (*NodeReclaimSpaceResponse) Reset 

func (x *NodeReclaimSpaceResponse) Reset()

func (*NodeReclaimSpaceResponse) String 

func (x *NodeReclaimSpaceResponse) String() string

type ReclaimSpaceControllerClient 

type ReclaimSpaceControllerClient interface {
	// ControllerReclaimSpace is a procedure that gets called on the CSI
	// Controller.
	ControllerReclaimSpace(ctx context.Context, in *ControllerReclaimSpaceRequest, opts ...grpc.CallOption) (*ControllerReclaimSpaceResponse, error)
}

ReclaimSpaceControllerClient is the client API for ReclaimSpaceController 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 NewReclaimSpaceControllerClient 

func NewReclaimSpaceControllerClient(cc grpc.ClientConnInterface) ReclaimSpaceControllerClient

type ReclaimSpaceControllerServer 

type ReclaimSpaceControllerServer interface {
	// ControllerReclaimSpace is a procedure that gets called on the CSI
	// Controller.
	ControllerReclaimSpace(context.Context, *ControllerReclaimSpaceRequest) (*ControllerReclaimSpaceResponse, error)
	// contains filtered or unexported methods
}

ReclaimSpaceControllerServer is the server API for ReclaimSpaceController service. All implementations must embed UnimplementedReclaimSpaceControllerServer for forward compatibility

type ReclaimSpaceNodeClient 

type ReclaimSpaceNodeClient interface {
	// NodeReclaimSpace is a procedure that gets called on the CSI NodePlugin.
	NodeReclaimSpace(ctx context.Context, in *NodeReclaimSpaceRequest, opts ...grpc.CallOption) (*NodeReclaimSpaceResponse, error)
}

ReclaimSpaceNodeClient is the client API for ReclaimSpaceNode 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 NewReclaimSpaceNodeClient 

func NewReclaimSpaceNodeClient(cc grpc.ClientConnInterface) ReclaimSpaceNodeClient

type ReclaimSpaceNodeServer 

type ReclaimSpaceNodeServer interface {
	// NodeReclaimSpace is a procedure that gets called on the CSI NodePlugin.
	NodeReclaimSpace(context.Context, *NodeReclaimSpaceRequest) (*NodeReclaimSpaceResponse, error)
	// contains filtered or unexported methods
}

ReclaimSpaceNodeServer is the server API for ReclaimSpaceNode service. All implementations must embed UnimplementedReclaimSpaceNodeServer for forward compatibility

type StorageConsumption 

type StorageConsumption struct {

	// This field is REQUIRED. usage_bytes contains the consumed storage in
	// bytes.
	UsageBytes int64 `protobuf:"varint,1,opt,name=usage_bytes,json=usageBytes,proto3" json:"usage_bytes,omitempty"`
	// contains filtered or unexported fields
}

StorageConsumption contains the usage in bytes.

func (*StorageConsumption) Descriptor deprecated 

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

Deprecated: Use StorageConsumption.ProtoReflect.Descriptor instead.

func (*StorageConsumption) GetUsageBytes 

func (x *StorageConsumption) GetUsageBytes() int64

func (*StorageConsumption) ProtoMessage 

func (*StorageConsumption) ProtoMessage()

func (*StorageConsumption) ProtoReflect 

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

func (*StorageConsumption) Reset 

func (x *StorageConsumption) Reset()

func (*StorageConsumption) String 

func (x *StorageConsumption) String() string

type UnimplementedReclaimSpaceControllerServer 

type UnimplementedReclaimSpaceControllerServer struct {
}

UnimplementedReclaimSpaceControllerServer must be embedded to have forward compatible implementations.

func (UnimplementedReclaimSpaceControllerServer) ControllerReclaimSpace 

func (UnimplementedReclaimSpaceControllerServer) ControllerReclaimSpace(context.Context, *ControllerReclaimSpaceRequest) (*ControllerReclaimSpaceResponse, error)

type UnimplementedReclaimSpaceNodeServer 

type UnimplementedReclaimSpaceNodeServer struct {
}

UnimplementedReclaimSpaceNodeServer must be embedded to have forward compatible implementations.

func (UnimplementedReclaimSpaceNodeServer) NodeReclaimSpace 

func (UnimplementedReclaimSpaceNodeServer) NodeReclaimSpace(context.Context, *NodeReclaimSpaceRequest) (*NodeReclaimSpaceResponse, error)

type UnsafeReclaimSpaceControllerServer 

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

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

type UnsafeReclaimSpaceNodeServer 

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.