proto

package
v0.7.0 Latest Latest
Warning

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

 Go to latest Published: Jun 28, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

README

internal/proto package documentation for developers

The *.pb.go files in this directory are automatically generated with the make generate-protobuf command.

New *.proto files will need to be added to the generate.go file, with a +generate and go:generate build-tag.

It is expected that the protobuf compiler (protoc) is available on the system. Plugins for the compiler to generate Go code (protoc-gen-go) and Go-GRPC interfaces (protoc-gen-go-grpc) will be automatically installed through the tools.go in the root the project.

Documentation

Index

Constants

View Source 
const (
	NetworkFence_FenceClusterNetwork_FullMethodName   = "/proto.NetworkFence/FenceClusterNetwork"
	NetworkFence_UnFenceClusterNetwork_FullMethodName = "/proto.NetworkFence/UnFenceClusterNetwork"
)
View Source 
const (
	ReclaimSpace_ControllerReclaimSpace_FullMethodName = "/proto.ReclaimSpace/ControllerReclaimSpace"
	ReclaimSpace_NodeReclaimSpace_FullMethodName       = "/proto.ReclaimSpace/NodeReclaimSpace"
)
View Source 
const (
	Replication_EnableVolumeReplication_FullMethodName  = "/proto.Replication/EnableVolumeReplication"
	Replication_DisableVolumeReplication_FullMethodName = "/proto.Replication/DisableVolumeReplication"
	Replication_PromoteVolume_FullMethodName            = "/proto.Replication/PromoteVolume"
	Replication_DemoteVolume_FullMethodName             = "/proto.Replication/DemoteVolume"
	Replication_ResyncVolume_FullMethodName             = "/proto.Replication/ResyncVolume"
	Replication_GetVolumeReplicationInfo_FullMethodName = "/proto.Replication/GetVolumeReplicationInfo"
)

Variables

View Source 
var File_networkfence_proto protoreflect.FileDescriptor
View Source 
var File_reclaimspace_proto protoreflect.FileDescriptor
View Source 
var File_replication_proto protoreflect.FileDescriptor
View Source 
var NetworkFence_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "proto.NetworkFence",
	HandlerType: (*NetworkFenceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "FenceClusterNetwork",
			Handler:    _NetworkFence_FenceClusterNetwork_Handler,
		},
		{
			MethodName: "UnFenceClusterNetwork",
			Handler:    _NetworkFence_UnFenceClusterNetwork_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "networkfence.proto",
}

NetworkFence_ServiceDesc is the grpc.ServiceDesc for NetworkFence 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 ReclaimSpace_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "proto.ReclaimSpace",
	HandlerType: (*ReclaimSpaceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ControllerReclaimSpace",
			Handler:    _ReclaimSpace_ControllerReclaimSpace_Handler,
		},
		{
			MethodName: "NodeReclaimSpace",
			Handler:    _ReclaimSpace_NodeReclaimSpace_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "reclaimspace.proto",
}

ReclaimSpace_ServiceDesc is the grpc.ServiceDesc for ReclaimSpace 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 Replication_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "proto.Replication",
	HandlerType: (*ReplicationServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "EnableVolumeReplication",
			Handler:    _Replication_EnableVolumeReplication_Handler,
		},
		{
			MethodName: "DisableVolumeReplication",
			Handler:    _Replication_DisableVolumeReplication_Handler,
		},
		{
			MethodName: "PromoteVolume",
			Handler:    _Replication_PromoteVolume_Handler,
		},
		{
			MethodName: "DemoteVolume",
			Handler:    _Replication_DemoteVolume_Handler,
		},
		{
			MethodName: "ResyncVolume",
			Handler:    _Replication_ResyncVolume_Handler,
		},
		{
			MethodName: "GetVolumeReplicationInfo",
			Handler:    _Replication_GetVolumeReplicationInfo_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "replication.proto",
}

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

Functions

func RegisterNetworkFenceServer 

func RegisterNetworkFenceServer(s grpc.ServiceRegistrar, srv NetworkFenceServer)

func RegisterReclaimSpaceServer 

func RegisterReclaimSpaceServer(s grpc.ServiceRegistrar, srv ReclaimSpaceServer)

func RegisterReplicationServer added in v0.5.0 

func RegisterReplicationServer(s grpc.ServiceRegistrar, srv ReplicationServer)

Types

type DemoteVolumeRequest added in v0.5.0 

type DemoteVolumeRequest struct {

	// The identifier for this volume, generated by the plugin during
	// CreateVolume CSI RPC call.
	// This field is REQUIRED.
	// This field MUST contain enough information to uniquely identify
	// this specific volume vs all other volumes supported by this plugin.
	// This field SHALL be used by the CO in subsequent calls to refer to
	// this volume.
	VolumeId string `protobuf:"bytes,1,opt,name=volume_id,json=volumeId,proto3" json:"volume_id,omitempty"`
	// The identifier for the replication.
	// This field is OPTIONAL.
	// This field MUST contain enough information, together with volume_id,
	// to uniquely identify this specific replication
	// vs all other replications supported by this plugin.
	ReplicationId string `protobuf:"bytes,2,opt,name=replication_id,json=replicationId,proto3" json:"replication_id,omitempty"`
	// This field is optional.
	// Default value is false, force option to Demote the volume.
	Force bool `protobuf:"varint,3,opt,name=force,proto3" json:"force,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 driver to complete the request.
	SecretName      string `protobuf:"bytes,5,opt,name=secret_name,json=secretName,proto3" json:"secret_name,omitempty"`
	SecretNamespace string `protobuf:"bytes,6,opt,name=secret_namespace,json=secretNamespace,proto3" json:"secret_namespace,omitempty"`
	// contains filtered or unexported fields
}

DemoteVolumeRequest holds the required information to demote volume on local cluster.

func (*DemoteVolumeRequest) Descriptor deprecated added in v0.5.0 

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

Deprecated: Use DemoteVolumeRequest.ProtoReflect.Descriptor instead.

func (*DemoteVolumeRequest) GetForce added in v0.5.0 

func (x *DemoteVolumeRequest) GetForce() bool

func (*DemoteVolumeRequest) GetParameters added in v0.5.0 

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

func (*DemoteVolumeRequest) GetReplicationId added in v0.5.0 

func (x *DemoteVolumeRequest) GetReplicationId() string

func (*DemoteVolumeRequest) GetSecretName added in v0.5.0 

func (x *DemoteVolumeRequest) GetSecretName() string

func (*DemoteVolumeRequest) GetSecretNamespace added in v0.5.0 

func (x *DemoteVolumeRequest) GetSecretNamespace() string

func (*DemoteVolumeRequest) GetVolumeId added in v0.5.0 

func (x *DemoteVolumeRequest) GetVolumeId() string

func (*DemoteVolumeRequest) ProtoMessage added in v0.5.0 

func (*DemoteVolumeRequest) ProtoMessage()

func (*DemoteVolumeRequest) ProtoReflect added in v0.5.0 

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

func (*DemoteVolumeRequest) Reset added in v0.5.0 

func (x *DemoteVolumeRequest) Reset()

func (*DemoteVolumeRequest) String added in v0.5.0 

func (x *DemoteVolumeRequest) String() string

type DemoteVolumeResponse added in v0.5.0 

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

DemoteVolumeResponse holds the information to send when volume is successfully demoted.

func (*DemoteVolumeResponse) Descriptor deprecated added in v0.5.0 

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

Deprecated: Use DemoteVolumeResponse.ProtoReflect.Descriptor instead.

func (*DemoteVolumeResponse) ProtoMessage added in v0.5.0 

func (*DemoteVolumeResponse) ProtoMessage()

func (*DemoteVolumeResponse) ProtoReflect added in v0.5.0 

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

func (*DemoteVolumeResponse) Reset added in v0.5.0 

func (x *DemoteVolumeResponse) Reset()

func (*DemoteVolumeResponse) String added in v0.5.0 

func (x *DemoteVolumeResponse) String() string

type DisableVolumeReplicationRequest added in v0.5.0 

type DisableVolumeReplicationRequest struct {

	// The identifier for this volume, generated by the plugin during
	// CreateVolume CSI RPC call.
	// This field is REQUIRED.
	// This field MUST contain enough information to uniquely identify
	// this specific volume vs all other volumes supported by this plugin.
	// This field SHALL be used by the CO in subsequent calls to refer to
	// this volume.
	VolumeId string `protobuf:"bytes,1,opt,name=volume_id,json=volumeId,proto3" json:"volume_id,omitempty"`
	// The identifier for the replication.
	// This field is OPTIONAL.
	// This field MUST contain enough information, together with volume_id,
	// to uniquely identify this specific replication
	// vs all other replications supported by this plugin.
	ReplicationId string `protobuf:"bytes,2,opt,name=replication_id,json=replicationId,proto3" json:"replication_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 driver to complete the request.
	SecretName      string `protobuf:"bytes,4,opt,name=secret_name,json=secretName,proto3" json:"secret_name,omitempty"`
	SecretNamespace string `protobuf:"bytes,5,opt,name=secret_namespace,json=secretNamespace,proto3" json:"secret_namespace,omitempty"`
	// contains filtered or unexported fields
}

DisableVolumeReplicationRequest holds the required information to disable replication on a volume.

func (*DisableVolumeReplicationRequest) Descriptor deprecated added in v0.5.0 

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

Deprecated: Use DisableVolumeReplicationRequest.ProtoReflect.Descriptor instead.

func (*DisableVolumeReplicationRequest) GetParameters added in v0.5.0 

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

func (*DisableVolumeReplicationRequest) GetReplicationId added in v0.5.0 

func (x *DisableVolumeReplicationRequest) GetReplicationId() string

func (*DisableVolumeReplicationRequest) GetSecretName added in v0.5.0 

func (x *DisableVolumeReplicationRequest) GetSecretName() string

func (*DisableVolumeReplicationRequest) GetSecretNamespace added in v0.5.0 

func (x *DisableVolumeReplicationRequest) GetSecretNamespace() string

func (*DisableVolumeReplicationRequest) GetVolumeId added in v0.5.0 

func (x *DisableVolumeReplicationRequest) GetVolumeId() string

func (*DisableVolumeReplicationRequest) ProtoMessage added in v0.5.0 

func (*DisableVolumeReplicationRequest) ProtoMessage()

func (*DisableVolumeReplicationRequest) ProtoReflect added in v0.5.0 

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

func (*DisableVolumeReplicationRequest) Reset added in v0.5.0 

func (x *DisableVolumeReplicationRequest) Reset()

func (*DisableVolumeReplicationRequest) String added in v0.5.0 

func (x *DisableVolumeReplicationRequest) String() string

type DisableVolumeReplicationResponse added in v0.5.0 

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

DisableVolumeReplicationResponse holds the information to send when replication is successfully disabled on a volume.

func (*DisableVolumeReplicationResponse) Descriptor deprecated added in v0.5.0 

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

Deprecated: Use DisableVolumeReplicationResponse.ProtoReflect.Descriptor instead.

func (*DisableVolumeReplicationResponse) ProtoMessage added in v0.5.0 

func (*DisableVolumeReplicationResponse) ProtoMessage()

func (*DisableVolumeReplicationResponse) ProtoReflect added in v0.5.0 

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

func (*DisableVolumeReplicationResponse) Reset added in v0.5.0 

func (x *DisableVolumeReplicationResponse) Reset()

func (*DisableVolumeReplicationResponse) String added in v0.5.0 

func (x *DisableVolumeReplicationResponse) String() string

type EnableVolumeReplicationRequest added in v0.5.0 

type EnableVolumeReplicationRequest struct {

	// The identifier for this volume, generated by the plugin during
	// CreateVolume CSI RPC call.
	// This field is REQUIRED.
	// This field MUST contain enough information to uniquely identify
	// this specific volume vs all other volumes supported by this plugin.
	// This field SHALL be used by the CO in subsequent calls to refer to
	// this volume.
	VolumeId string `protobuf:"bytes,1,opt,name=volume_id,json=volumeId,proto3" json:"volume_id,omitempty"`
	// The identifier for the replication.
	// This field is OPTIONAL.
	// This field MUST contain enough information, together with volume_id,
	// to uniquely identify this specific replication
	// vs all other replications supported by this plugin.
	ReplicationId string `protobuf:"bytes,2,opt,name=replication_id,json=replicationId,proto3" json:"replication_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 driver to complete the request.
	SecretName      string `protobuf:"bytes,4,opt,name=secret_name,json=secretName,proto3" json:"secret_name,omitempty"`
	SecretNamespace string `protobuf:"bytes,5,opt,name=secret_namespace,json=secretNamespace,proto3" json:"secret_namespace,omitempty"`
	// contains filtered or unexported fields
}

EnableVolumeReplicationRequest holds the required information to enable replication on a volume.

func (*EnableVolumeReplicationRequest) Descriptor deprecated added in v0.5.0 

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

Deprecated: Use EnableVolumeReplicationRequest.ProtoReflect.Descriptor instead.

func (*EnableVolumeReplicationRequest) GetParameters added in v0.5.0 

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

func (*EnableVolumeReplicationRequest) GetReplicationId added in v0.5.0 

func (x *EnableVolumeReplicationRequest) GetReplicationId() string

func (*EnableVolumeReplicationRequest) GetSecretName added in v0.5.0 

func (x *EnableVolumeReplicationRequest) GetSecretName() string

func (*EnableVolumeReplicationRequest) GetSecretNamespace added in v0.5.0 

func (x *EnableVolumeReplicationRequest) GetSecretNamespace() string

func (*EnableVolumeReplicationRequest) GetVolumeId added in v0.5.0 

func (x *EnableVolumeReplicationRequest) GetVolumeId() string

func (*EnableVolumeReplicationRequest) ProtoMessage added in v0.5.0 

func (*EnableVolumeReplicationRequest) ProtoMessage()

func (*EnableVolumeReplicationRequest) ProtoReflect added in v0.5.0 

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

func (*EnableVolumeReplicationRequest) Reset added in v0.5.0 

func (x *EnableVolumeReplicationRequest) Reset()

func (*EnableVolumeReplicationRequest) String added in v0.5.0 

func (x *EnableVolumeReplicationRequest) String() string

type EnableVolumeReplicationResponse added in v0.5.0 

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

EnableVolumeReplicationResponse holds the information to send when replication is successfully enabled on a volume.

func (*EnableVolumeReplicationResponse) Descriptor deprecated added in v0.5.0 

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

Deprecated: Use EnableVolumeReplicationResponse.ProtoReflect.Descriptor instead.

func (*EnableVolumeReplicationResponse) ProtoMessage added in v0.5.0 

func (*EnableVolumeReplicationResponse) ProtoMessage()

func (*EnableVolumeReplicationResponse) ProtoReflect added in v0.5.0 

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

func (*EnableVolumeReplicationResponse) Reset added in v0.5.0 

func (x *EnableVolumeReplicationResponse) Reset()

func (*EnableVolumeReplicationResponse) String added in v0.5.0 

func (x *EnableVolumeReplicationResponse) String() string

type GetVolumeReplicationInfoRequest added in v0.6.0 

type GetVolumeReplicationInfoRequest struct {

	// The identifier for this volume, generated by the plugin during
	// CreateVolume CSI RPC call.
	// This field is REQUIRED.
	// This field MUST contain enough information to uniquely identify
	// this specific volume vs all other volumes supported by this plugin.
	// This field SHALL be used by the CO in subsequent calls to refer to
	// this volume.
	VolumeId string `protobuf:"bytes,1,opt,name=volume_id,json=volumeId,proto3" json:"volume_id,omitempty"`
	// The identifier for the replication.
	// This field is OPTIONAL.
	// This field MUST contain enough information, together with volume_id,
	// to uniquely identify this specific replication
	// vs all other replications supported by this plugin.
	ReplicationId string `protobuf:"bytes,2,opt,name=replication_id,json=replicationId,proto3" json:"replication_id,omitempty"`
	// Secrets required by the plugin to complete the request.
	SecretName      string `protobuf:"bytes,3,opt,name=secret_name,json=secretName,proto3" json:"secret_name,omitempty"`
	SecretNamespace string `protobuf:"bytes,4,opt,name=secret_namespace,json=secretNamespace,proto3" json:"secret_namespace,omitempty"`
	// contains filtered or unexported fields
}

getVolumeReplicationInfoRequest holds the required information to get the Volume replication info.

func (*GetVolumeReplicationInfoRequest) Descriptor deprecated added in v0.6.0 

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

Deprecated: Use GetVolumeReplicationInfoRequest.ProtoReflect.Descriptor instead.

func (*GetVolumeReplicationInfoRequest) GetReplicationId added in v0.6.0 

func (x *GetVolumeReplicationInfoRequest) GetReplicationId() string

func (*GetVolumeReplicationInfoRequest) GetSecretName added in v0.6.0 

func (x *GetVolumeReplicationInfoRequest) GetSecretName() string

func (*GetVolumeReplicationInfoRequest) GetSecretNamespace added in v0.6.0 

func (x *GetVolumeReplicationInfoRequest) GetSecretNamespace() string

func (*GetVolumeReplicationInfoRequest) GetVolumeId added in v0.6.0 

func (x *GetVolumeReplicationInfoRequest) GetVolumeId() string

func (*GetVolumeReplicationInfoRequest) ProtoMessage added in v0.6.0 

func (*GetVolumeReplicationInfoRequest) ProtoMessage()

func (*GetVolumeReplicationInfoRequest) ProtoReflect added in v0.6.0 

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

func (*GetVolumeReplicationInfoRequest) Reset added in v0.6.0 

func (x *GetVolumeReplicationInfoRequest) Reset()

func (*GetVolumeReplicationInfoRequest) String added in v0.6.0 

func (x *GetVolumeReplicationInfoRequest) String() string

type GetVolumeReplicationInfoResponse added in v0.6.0 

type GetVolumeReplicationInfoResponse struct {

	// Holds the last sync time.
	// This field is REQUIRED.
	LastSyncTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=last_sync_time,json=lastSyncTime,proto3" json:"last_sync_time,omitempty"`
	// Holds the last sync duration.
	// last_sync_duration represents the time taken
	// to execute the last sync operation.
	// This field is OPTIONAL.
	LastSyncDuration *durationpb.Duration `protobuf:"bytes,2,opt,name=last_sync_duration,json=lastSyncDuration,proto3" json:"last_sync_duration,omitempty"`
	// Holds the last sync bytes.
	// Represents number of bytes transferred
	// with the last synchronization.
	// A value of 0 is equal to an unspecified field value.
	// The value of this field MUST NOT be negative.
	// This field is OPTIONAL.
	LastSyncBytes int64 `protobuf:"varint,3,opt,name=last_sync_bytes,json=lastSyncBytes,proto3" json:"last_sync_bytes,omitempty"`
	// contains filtered or unexported fields
}

GetVolumeReplicationInfoResponse holds the information to send the volume replication info.

func (*GetVolumeReplicationInfoResponse) Descriptor deprecated added in v0.6.0 

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

Deprecated: Use GetVolumeReplicationInfoResponse.ProtoReflect.Descriptor instead.

func (*GetVolumeReplicationInfoResponse) GetLastSyncBytes added in v0.7.0 

func (x *GetVolumeReplicationInfoResponse) GetLastSyncBytes() int64

func (*GetVolumeReplicationInfoResponse) GetLastSyncDuration added in v0.7.0 

func (x *GetVolumeReplicationInfoResponse) GetLastSyncDuration() *durationpb.Duration

func (*GetVolumeReplicationInfoResponse) GetLastSyncTime added in v0.6.0 

func (x *GetVolumeReplicationInfoResponse) GetLastSyncTime() *timestamppb.Timestamp

func (*GetVolumeReplicationInfoResponse) ProtoMessage added in v0.6.0 

func (*GetVolumeReplicationInfoResponse) ProtoMessage()

func (*GetVolumeReplicationInfoResponse) ProtoReflect added in v0.6.0 

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

func (*GetVolumeReplicationInfoResponse) Reset added in v0.6.0 

func (x *GetVolumeReplicationInfoResponse) Reset()

func (*GetVolumeReplicationInfoResponse) String added in v0.6.0 

func (x *GetVolumeReplicationInfoResponse) String() string

type NetworkFenceClient 

type NetworkFenceClient interface {
	// FenceClusterNetwork RPC call to fence the cluster network.
	FenceClusterNetwork(ctx context.Context, in *NetworkFenceRequest, opts ...grpc.CallOption) (*NetworkFenceResponse, error)
	// UnFenceClusterNetwork RPC call to un-fence the cluster network.
	UnFenceClusterNetwork(ctx context.Context, in *NetworkFenceRequest, opts ...grpc.CallOption) (*NetworkFenceResponse, error)
}

NetworkFenceClient is the client API for NetworkFence 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 NewNetworkFenceClient 

func NewNetworkFenceClient(cc grpc.ClientConnInterface) NetworkFenceClient

type NetworkFenceRequest 

type NetworkFenceRequest struct {

	// Plugin specific parameters passed in as opaque key-value pairs.
	Parameters map[string]string `` /* 161-byte string literal not displayed */
	// Secrets required by the driver to complete the request.
	SecretName      string `protobuf:"bytes,2,opt,name=secret_name,json=secretName,proto3" json:"secret_name,omitempty"`
	SecretNamespace string `protobuf:"bytes,3,opt,name=secret_namespace,json=secretNamespace,proto3" json:"secret_namespace,omitempty"`
	// list of CIDR blocks on which the fencing/unfencing operation is expected
	// to be performed.
	Cidrs []string `protobuf:"bytes,4,rep,name=cidrs,proto3" json:"cidrs,omitempty"`
	// contains filtered or unexported fields
}

NetworkFenceRequest holds the required information to fence/unfence the cluster network.

func (*NetworkFenceRequest) Descriptor deprecated 

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

Deprecated: Use NetworkFenceRequest.ProtoReflect.Descriptor instead.

func (*NetworkFenceRequest) GetCidrs 

func (x *NetworkFenceRequest) GetCidrs() []string

func (*NetworkFenceRequest) GetParameters 

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

func (*NetworkFenceRequest) GetSecretName 

func (x *NetworkFenceRequest) GetSecretName() string

func (*NetworkFenceRequest) GetSecretNamespace 

func (x *NetworkFenceRequest) GetSecretNamespace() string

func (*NetworkFenceRequest) ProtoMessage 

func (*NetworkFenceRequest) ProtoMessage()

func (*NetworkFenceRequest) ProtoReflect 

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

func (*NetworkFenceRequest) Reset 

func (x *NetworkFenceRequest) Reset()

func (*NetworkFenceRequest) String 

func (x *NetworkFenceRequest) String() string

type NetworkFenceResponse 

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

NetworkFenceResponse is returned by the CSI-driver as a result of the FenceRequest call.

func (*NetworkFenceResponse) Descriptor deprecated 

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

Deprecated: Use NetworkFenceResponse.ProtoReflect.Descriptor instead.

func (*NetworkFenceResponse) ProtoMessage 

func (*NetworkFenceResponse) ProtoMessage()

func (*NetworkFenceResponse) ProtoReflect 

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

func (*NetworkFenceResponse) Reset 

func (x *NetworkFenceResponse) Reset()

func (*NetworkFenceResponse) String 

func (x *NetworkFenceResponse) String() string

type NetworkFenceServer 

type NetworkFenceServer interface {
	// FenceClusterNetwork RPC call to fence the cluster network.
	FenceClusterNetwork(context.Context, *NetworkFenceRequest) (*NetworkFenceResponse, error)
	// UnFenceClusterNetwork RPC call to un-fence the cluster network.
	UnFenceClusterNetwork(context.Context, *NetworkFenceRequest) (*NetworkFenceResponse, error)
	// contains filtered or unexported methods
}

NetworkFenceServer is the server API for NetworkFence service. All implementations must embed UnimplementedNetworkFenceServer for forward compatibility

type PromoteVolumeRequest added in v0.5.0 

type PromoteVolumeRequest struct {

	// The identifier for this volume, generated by the plugin during
	// CreateVolume CSI RPC call.
	// This field is REQUIRED.
	// This field MUST contain enough information to uniquely identify
	// this specific volume vs all other volumes supported by this plugin.
	// This field SHALL be used by the CO in subsequent calls to refer to
	// this volume.
	VolumeId string `protobuf:"bytes,1,opt,name=volume_id,json=volumeId,proto3" json:"volume_id,omitempty"`
	// The identifier for the replication.
	// This field is OPTIONAL.
	// This field MUST contain enough information, together with volume_id,
	// to uniquely identify this specific replication
	// vs all other replications supported by this plugin.
	ReplicationId string `protobuf:"bytes,2,opt,name=replication_id,json=replicationId,proto3" json:"replication_id,omitempty"`
	// This field is optional.
	// Default value is false, force option to Promote the volume.
	Force bool `protobuf:"varint,3,opt,name=force,proto3" json:"force,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 driver to complete the request.
	SecretName      string `protobuf:"bytes,5,opt,name=secret_name,json=secretName,proto3" json:"secret_name,omitempty"`
	SecretNamespace string `protobuf:"bytes,6,opt,name=secret_namespace,json=secretNamespace,proto3" json:"secret_namespace,omitempty"`
	// contains filtered or unexported fields
}

PromoteVolumeRequest holds the required information to promote volume as a primary on local cluster.

func (*PromoteVolumeRequest) Descriptor deprecated added in v0.5.0 

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

Deprecated: Use PromoteVolumeRequest.ProtoReflect.Descriptor instead.

func (*PromoteVolumeRequest) GetForce added in v0.5.0 

func (x *PromoteVolumeRequest) GetForce() bool

func (*PromoteVolumeRequest) GetParameters added in v0.5.0 

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

func (*PromoteVolumeRequest) GetReplicationId added in v0.5.0 

func (x *PromoteVolumeRequest) GetReplicationId() string

func (*PromoteVolumeRequest) GetSecretName added in v0.5.0 

func (x *PromoteVolumeRequest) GetSecretName() string

func (*PromoteVolumeRequest) GetSecretNamespace added in v0.5.0 

func (x *PromoteVolumeRequest) GetSecretNamespace() string

func (*PromoteVolumeRequest) GetVolumeId added in v0.5.0 

func (x *PromoteVolumeRequest) GetVolumeId() string

func (*PromoteVolumeRequest) ProtoMessage added in v0.5.0 

func (*PromoteVolumeRequest) ProtoMessage()

func (*PromoteVolumeRequest) ProtoReflect added in v0.5.0 

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

func (*PromoteVolumeRequest) Reset added in v0.5.0 

func (x *PromoteVolumeRequest) Reset()

func (*PromoteVolumeRequest) String added in v0.5.0 

func (x *PromoteVolumeRequest) String() string

type PromoteVolumeResponse added in v0.5.0 

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

PromoteVolumeResponse holds the information to send when volume is successfully promoted.

func (*PromoteVolumeResponse) Descriptor deprecated added in v0.5.0 

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

Deprecated: Use PromoteVolumeResponse.ProtoReflect.Descriptor instead.

func (*PromoteVolumeResponse) ProtoMessage added in v0.5.0 

func (*PromoteVolumeResponse) ProtoMessage()

func (*PromoteVolumeResponse) ProtoReflect added in v0.5.0 

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

func (*PromoteVolumeResponse) Reset added in v0.5.0 

func (x *PromoteVolumeResponse) Reset()

func (*PromoteVolumeResponse) String added in v0.5.0 

func (x *PromoteVolumeResponse) String() string

type ReclaimSpaceClient 

type ReclaimSpaceClient interface {
	// ControllerReclaimSpace is a procedure that gets called on the CSI
	// sidecar.
	ControllerReclaimSpace(ctx context.Context, in *ReclaimSpaceRequest, opts ...grpc.CallOption) (*ReclaimSpaceResponse, error)
	// NodeReclaimSpace is a procedure that gets called on the CSI
	// sidecar.
	NodeReclaimSpace(ctx context.Context, in *ReclaimSpaceRequest, opts ...grpc.CallOption) (*ReclaimSpaceResponse, error)
}

ReclaimSpaceClient is the client API for ReclaimSpace 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 NewReclaimSpaceClient 

func NewReclaimSpaceClient(cc grpc.ClientConnInterface) ReclaimSpaceClient

type ReclaimSpaceRequest 

type ReclaimSpaceRequest struct {

	// The name of the pv. This field is REQUIRED.
	PvName string `protobuf:"bytes,1,opt,name=pv_name,json=pvName,proto3" json:"pv_name,omitempty"`
	// contains filtered or unexported fields
}

ReclaimSpaceRequest contains the information i.e., pv_name received from the CSIAddons controller for performing the reclaim operation.

func (*ReclaimSpaceRequest) Descriptor deprecated 

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

Deprecated: Use ReclaimSpaceRequest.ProtoReflect.Descriptor instead.

func (*ReclaimSpaceRequest) GetPvName 

func (x *ReclaimSpaceRequest) GetPvName() string

func (*ReclaimSpaceRequest) ProtoMessage 

func (*ReclaimSpaceRequest) ProtoMessage()

func (*ReclaimSpaceRequest) ProtoReflect 

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

func (*ReclaimSpaceRequest) Reset 

func (x *ReclaimSpaceRequest) Reset()

func (*ReclaimSpaceRequest) String 

func (x *ReclaimSpaceRequest) String() string

type ReclaimSpaceResponse 

type ReclaimSpaceResponse 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
}

ReclaimSpaceResponse holds the information about the result of the ControllerReclaimSpaceRequest/NodeReclaimSpaceRequest call.

func (*ReclaimSpaceResponse) Descriptor deprecated 

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

Deprecated: Use ReclaimSpaceResponse.ProtoReflect.Descriptor instead.

func (*ReclaimSpaceResponse) GetPostUsage 

func (x *ReclaimSpaceResponse) GetPostUsage() *StorageConsumption

func (*ReclaimSpaceResponse) GetPreUsage 

func (x *ReclaimSpaceResponse) GetPreUsage() *StorageConsumption

func (*ReclaimSpaceResponse) ProtoMessage 

func (*ReclaimSpaceResponse) ProtoMessage()

func (*ReclaimSpaceResponse) ProtoReflect 

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

func (*ReclaimSpaceResponse) Reset 

func (x *ReclaimSpaceResponse) Reset()

func (*ReclaimSpaceResponse) String 

func (x *ReclaimSpaceResponse) String() string

type ReclaimSpaceServer 

type ReclaimSpaceServer interface {
	// ControllerReclaimSpace is a procedure that gets called on the CSI
	// sidecar.
	ControllerReclaimSpace(context.Context, *ReclaimSpaceRequest) (*ReclaimSpaceResponse, error)
	// NodeReclaimSpace is a procedure that gets called on the CSI
	// sidecar.
	NodeReclaimSpace(context.Context, *ReclaimSpaceRequest) (*ReclaimSpaceResponse, error)
	// contains filtered or unexported methods
}

ReclaimSpaceServer is the server API for ReclaimSpace service. All implementations must embed UnimplementedReclaimSpaceServer for forward compatibility

type ReplicationClient added in v0.5.0 

type ReplicationClient interface {
	// EnableVolumeReplication RPC call to enable the volume replication.
	EnableVolumeReplication(ctx context.Context, in *EnableVolumeReplicationRequest, opts ...grpc.CallOption) (*EnableVolumeReplicationResponse, error)
	// DisableVolumeReplication RPC call to disable the volume replication.
	DisableVolumeReplication(ctx context.Context, in *DisableVolumeReplicationRequest, opts ...grpc.CallOption) (*DisableVolumeReplicationResponse, error)
	// PromoteVolume RPC call to promote the volume.
	PromoteVolume(ctx context.Context, in *PromoteVolumeRequest, opts ...grpc.CallOption) (*PromoteVolumeResponse, error)
	// DemoteVolume RPC call to demote the volume.
	DemoteVolume(ctx context.Context, in *DemoteVolumeRequest, opts ...grpc.CallOption) (*DemoteVolumeResponse, error)
	// ResyncVolume RPC call to resync the volume.
	ResyncVolume(ctx context.Context, in *ResyncVolumeRequest, opts ...grpc.CallOption) (*ResyncVolumeResponse, error)
	// GetVolumeReplicationInfo RPC call to get the volume replication info.
	GetVolumeReplicationInfo(ctx context.Context, in *GetVolumeReplicationInfoRequest, opts ...grpc.CallOption) (*GetVolumeReplicationInfoResponse, error)
}

ReplicationClient is the client API for Replication 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 NewReplicationClient added in v0.5.0 

func NewReplicationClient(cc grpc.ClientConnInterface) ReplicationClient

type ReplicationServer added in v0.5.0 

type ReplicationServer interface {
	// EnableVolumeReplication RPC call to enable the volume replication.
	EnableVolumeReplication(context.Context, *EnableVolumeReplicationRequest) (*EnableVolumeReplicationResponse, error)
	// DisableVolumeReplication RPC call to disable the volume replication.
	DisableVolumeReplication(context.Context, *DisableVolumeReplicationRequest) (*DisableVolumeReplicationResponse, error)
	// PromoteVolume RPC call to promote the volume.
	PromoteVolume(context.Context, *PromoteVolumeRequest) (*PromoteVolumeResponse, error)
	// DemoteVolume RPC call to demote the volume.
	DemoteVolume(context.Context, *DemoteVolumeRequest) (*DemoteVolumeResponse, error)
	// ResyncVolume RPC call to resync the volume.
	ResyncVolume(context.Context, *ResyncVolumeRequest) (*ResyncVolumeResponse, error)
	// GetVolumeReplicationInfo RPC call to get the volume replication info.
	GetVolumeReplicationInfo(context.Context, *GetVolumeReplicationInfoRequest) (*GetVolumeReplicationInfoResponse, error)
	// contains filtered or unexported methods
}

ReplicationServer is the server API for Replication service. All implementations must embed UnimplementedReplicationServer for forward compatibility

type ResyncVolumeRequest added in v0.5.0 

type ResyncVolumeRequest struct {

	// The identifier for this volume, generated by the plugin during
	// CreateVolume CSI RPC call.
	// This field is REQUIRED.
	// This field MUST contain enough information to uniquely identify
	// this specific volume vs all other volumes supported by this plugin.
	// This field SHALL be used by the CO in subsequent calls to refer to
	// this volume.
	VolumeId string `protobuf:"bytes,1,opt,name=volume_id,json=volumeId,proto3" json:"volume_id,omitempty"`
	// The identifier for the replication.
	// This field is OPTIONAL.
	// This field MUST contain enough information, together with volume_id,
	// to uniquely identify this specific replication
	// vs all other replications supported by this plugin.
	ReplicationId string `protobuf:"bytes,2,opt,name=replication_id,json=replicationId,proto3" json:"replication_id,omitempty"`
	// This field is optional.
	// Default value is false, force option to Resync the volume.
	Force bool `protobuf:"varint,3,opt,name=force,proto3" json:"force,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 driver to complete the request.
	SecretName      string `protobuf:"bytes,5,opt,name=secret_name,json=secretName,proto3" json:"secret_name,omitempty"`
	SecretNamespace string `protobuf:"bytes,6,opt,name=secret_namespace,json=secretNamespace,proto3" json:"secret_namespace,omitempty"`
	// contains filtered or unexported fields
}

ResyncVolumeRequest holds the required information to resync volume.

func (*ResyncVolumeRequest) Descriptor deprecated added in v0.5.0 

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

Deprecated: Use ResyncVolumeRequest.ProtoReflect.Descriptor instead.

func (*ResyncVolumeRequest) GetForce added in v0.5.0 

func (x *ResyncVolumeRequest) GetForce() bool

func (*ResyncVolumeRequest) GetParameters added in v0.5.0 

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

func (*ResyncVolumeRequest) GetReplicationId added in v0.5.0 

func (x *ResyncVolumeRequest) GetReplicationId() string

func (*ResyncVolumeRequest) GetSecretName added in v0.5.0 

func (x *ResyncVolumeRequest) GetSecretName() string

func (*ResyncVolumeRequest) GetSecretNamespace added in v0.5.0 

func (x *ResyncVolumeRequest) GetSecretNamespace() string

func (*ResyncVolumeRequest) GetVolumeId added in v0.5.0 

func (x *ResyncVolumeRequest) GetVolumeId() string

func (*ResyncVolumeRequest) ProtoMessage added in v0.5.0 

func (*ResyncVolumeRequest) ProtoMessage()

func (*ResyncVolumeRequest) ProtoReflect added in v0.5.0 

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

func (*ResyncVolumeRequest) Reset added in v0.5.0 

func (x *ResyncVolumeRequest) Reset()

func (*ResyncVolumeRequest) String added in v0.5.0 

func (x *ResyncVolumeRequest) String() string

type ResyncVolumeResponse added in v0.5.0 

type ResyncVolumeResponse struct {

	// Indicates that the volume is ready to use.
	// The default value is false.
	// This field is REQUIRED.
	Ready bool `protobuf:"varint,1,opt,name=ready,proto3" json:"ready,omitempty"`
	// contains filtered or unexported fields
}

ResyncVolumeResponse holds the information to send when volume is successfully resynced.

func (*ResyncVolumeResponse) Descriptor deprecated added in v0.5.0 

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

Deprecated: Use ResyncVolumeResponse.ProtoReflect.Descriptor instead.

func (*ResyncVolumeResponse) GetReady added in v0.5.0 

func (x *ResyncVolumeResponse) GetReady() bool

func (*ResyncVolumeResponse) ProtoMessage added in v0.5.0 

func (*ResyncVolumeResponse) ProtoMessage()

func (*ResyncVolumeResponse) ProtoReflect added in v0.5.0 

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

func (*ResyncVolumeResponse) Reset added in v0.5.0 

func (x *ResyncVolumeResponse) Reset()

func (*ResyncVolumeResponse) String added in v0.5.0 

func (x *ResyncVolumeResponse) String() string

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 UnimplementedNetworkFenceServer 

type UnimplementedNetworkFenceServer struct {
}

UnimplementedNetworkFenceServer must be embedded to have forward compatible implementations.

func (UnimplementedNetworkFenceServer) FenceClusterNetwork 

func (UnimplementedNetworkFenceServer) FenceClusterNetwork(context.Context, *NetworkFenceRequest) (*NetworkFenceResponse, error)

func (UnimplementedNetworkFenceServer) UnFenceClusterNetwork 

func (UnimplementedNetworkFenceServer) UnFenceClusterNetwork(context.Context, *NetworkFenceRequest) (*NetworkFenceResponse, error)

type UnimplementedReclaimSpaceServer 

type UnimplementedReclaimSpaceServer struct {
}

UnimplementedReclaimSpaceServer must be embedded to have forward compatible implementations.

func (UnimplementedReclaimSpaceServer) ControllerReclaimSpace 

func (UnimplementedReclaimSpaceServer) ControllerReclaimSpace(context.Context, *ReclaimSpaceRequest) (*ReclaimSpaceResponse, error)

func (UnimplementedReclaimSpaceServer) NodeReclaimSpace 

func (UnimplementedReclaimSpaceServer) NodeReclaimSpace(context.Context, *ReclaimSpaceRequest) (*ReclaimSpaceResponse, error)

type UnimplementedReplicationServer added in v0.5.0 

type UnimplementedReplicationServer struct {
}

UnimplementedReplicationServer must be embedded to have forward compatible implementations.

func (UnimplementedReplicationServer) DemoteVolume added in v0.5.0 

func (UnimplementedReplicationServer) DemoteVolume(context.Context, *DemoteVolumeRequest) (*DemoteVolumeResponse, error)

func (UnimplementedReplicationServer) DisableVolumeReplication added in v0.5.0 

func (UnimplementedReplicationServer) DisableVolumeReplication(context.Context, *DisableVolumeReplicationRequest) (*DisableVolumeReplicationResponse, error)

func (UnimplementedReplicationServer) EnableVolumeReplication added in v0.5.0 

func (UnimplementedReplicationServer) EnableVolumeReplication(context.Context, *EnableVolumeReplicationRequest) (*EnableVolumeReplicationResponse, error)

func (UnimplementedReplicationServer) GetVolumeReplicationInfo added in v0.6.0 

func (UnimplementedReplicationServer) GetVolumeReplicationInfo(context.Context, *GetVolumeReplicationInfoRequest) (*GetVolumeReplicationInfoResponse, error)

func (UnimplementedReplicationServer) PromoteVolume added in v0.5.0 

func (UnimplementedReplicationServer) PromoteVolume(context.Context, *PromoteVolumeRequest) (*PromoteVolumeResponse, error)

func (UnimplementedReplicationServer) ResyncVolume added in v0.5.0 

func (UnimplementedReplicationServer) ResyncVolume(context.Context, *ResyncVolumeRequest) (*ResyncVolumeResponse, error)

type UnsafeNetworkFenceServer 

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

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

type UnsafeReclaimSpaceServer 

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

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

type UnsafeReplicationServer added in v0.5.0 

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

UnsafeReplicationServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ReplicationServer 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.