csi

package
v1.11.0 Latest Latest
Warning

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

Go to latest
Published: Oct 22, 2024 License: Apache-2.0 Imports: 11 Imported by: 1,021

Documentation

Index

Constants

View Source
const (
	Identity_GetPluginInfo_FullMethodName         = "/csi.v1.Identity/GetPluginInfo"
	Identity_GetPluginCapabilities_FullMethodName = "/csi.v1.Identity/GetPluginCapabilities"
	Identity_Probe_FullMethodName                 = "/csi.v1.Identity/Probe"
)
View Source
const (
	Controller_CreateVolume_FullMethodName               = "/csi.v1.Controller/CreateVolume"
	Controller_DeleteVolume_FullMethodName               = "/csi.v1.Controller/DeleteVolume"
	Controller_ControllerPublishVolume_FullMethodName    = "/csi.v1.Controller/ControllerPublishVolume"
	Controller_ControllerUnpublishVolume_FullMethodName  = "/csi.v1.Controller/ControllerUnpublishVolume"
	Controller_ValidateVolumeCapabilities_FullMethodName = "/csi.v1.Controller/ValidateVolumeCapabilities"
	Controller_ListVolumes_FullMethodName                = "/csi.v1.Controller/ListVolumes"
	Controller_GetCapacity_FullMethodName                = "/csi.v1.Controller/GetCapacity"
	Controller_ControllerGetCapabilities_FullMethodName  = "/csi.v1.Controller/ControllerGetCapabilities"
	Controller_CreateSnapshot_FullMethodName             = "/csi.v1.Controller/CreateSnapshot"
	Controller_DeleteSnapshot_FullMethodName             = "/csi.v1.Controller/DeleteSnapshot"
	Controller_ListSnapshots_FullMethodName              = "/csi.v1.Controller/ListSnapshots"
	Controller_ControllerExpandVolume_FullMethodName     = "/csi.v1.Controller/ControllerExpandVolume"
	Controller_ControllerGetVolume_FullMethodName        = "/csi.v1.Controller/ControllerGetVolume"
	Controller_ControllerModifyVolume_FullMethodName     = "/csi.v1.Controller/ControllerModifyVolume"
)
View Source
const (
	GroupController_GroupControllerGetCapabilities_FullMethodName = "/csi.v1.GroupController/GroupControllerGetCapabilities"
	GroupController_CreateVolumeGroupSnapshot_FullMethodName      = "/csi.v1.GroupController/CreateVolumeGroupSnapshot"
	GroupController_DeleteVolumeGroupSnapshot_FullMethodName      = "/csi.v1.GroupController/DeleteVolumeGroupSnapshot"
	GroupController_GetVolumeGroupSnapshot_FullMethodName         = "/csi.v1.GroupController/GetVolumeGroupSnapshot"
)
View Source
const (
	SnapshotMetadata_GetMetadataAllocated_FullMethodName = "/csi.v1.SnapshotMetadata/GetMetadataAllocated"
	SnapshotMetadata_GetMetadataDelta_FullMethodName     = "/csi.v1.SnapshotMetadata/GetMetadataDelta"
)
View Source
const (
	Node_NodeStageVolume_FullMethodName     = "/csi.v1.Node/NodeStageVolume"
	Node_NodeUnstageVolume_FullMethodName   = "/csi.v1.Node/NodeUnstageVolume"
	Node_NodePublishVolume_FullMethodName   = "/csi.v1.Node/NodePublishVolume"
	Node_NodeUnpublishVolume_FullMethodName = "/csi.v1.Node/NodeUnpublishVolume"
	Node_NodeGetVolumeStats_FullMethodName  = "/csi.v1.Node/NodeGetVolumeStats"
	Node_NodeExpandVolume_FullMethodName    = "/csi.v1.Node/NodeExpandVolume"
	Node_NodeGetCapabilities_FullMethodName = "/csi.v1.Node/NodeGetCapabilities"
	Node_NodeGetInfo_FullMethodName         = "/csi.v1.Node/NodeGetInfo"
)

Variables

View Source
var (
	BlockMetadataType_name = map[int32]string{
		0: "UNKNOWN",
		1: "FIXED_LENGTH",
		2: "VARIABLE_LENGTH",
	}
	BlockMetadataType_value = map[string]int32{
		"UNKNOWN":         0,
		"FIXED_LENGTH":    1,
		"VARIABLE_LENGTH": 2,
	}
)

Enum value maps for BlockMetadataType.

View Source
var (
	PluginCapability_Service_Type_name = map[int32]string{
		0: "UNKNOWN",
		1: "CONTROLLER_SERVICE",
		2: "VOLUME_ACCESSIBILITY_CONSTRAINTS",
		3: "GROUP_CONTROLLER_SERVICE",
		4: "SNAPSHOT_METADATA_SERVICE",
	}
	PluginCapability_Service_Type_value = map[string]int32{
		"UNKNOWN":                          0,
		"CONTROLLER_SERVICE":               1,
		"VOLUME_ACCESSIBILITY_CONSTRAINTS": 2,
		"GROUP_CONTROLLER_SERVICE":         3,
		"SNAPSHOT_METADATA_SERVICE":        4,
	}
)

Enum value maps for PluginCapability_Service_Type.

View Source
var (
	PluginCapability_VolumeExpansion_Type_name = map[int32]string{
		0: "UNKNOWN",
		1: "ONLINE",
		2: "OFFLINE",
	}
	PluginCapability_VolumeExpansion_Type_value = map[string]int32{
		"UNKNOWN": 0,
		"ONLINE":  1,
		"OFFLINE": 2,
	}
)

Enum value maps for PluginCapability_VolumeExpansion_Type.

View Source
var (
	VolumeCapability_AccessMode_Mode_name = map[int32]string{
		0: "UNKNOWN",
		1: "SINGLE_NODE_WRITER",
		2: "SINGLE_NODE_READER_ONLY",
		3: "MULTI_NODE_READER_ONLY",
		4: "MULTI_NODE_SINGLE_WRITER",
		5: "MULTI_NODE_MULTI_WRITER",
		6: "SINGLE_NODE_SINGLE_WRITER",
		7: "SINGLE_NODE_MULTI_WRITER",
	}
	VolumeCapability_AccessMode_Mode_value = map[string]int32{
		"UNKNOWN":                   0,
		"SINGLE_NODE_WRITER":        1,
		"SINGLE_NODE_READER_ONLY":   2,
		"MULTI_NODE_READER_ONLY":    3,
		"MULTI_NODE_SINGLE_WRITER":  4,
		"MULTI_NODE_MULTI_WRITER":   5,
		"SINGLE_NODE_SINGLE_WRITER": 6,
		"SINGLE_NODE_MULTI_WRITER":  7,
	}
)

Enum value maps for VolumeCapability_AccessMode_Mode.

View Source
var (
	ControllerServiceCapability_RPC_Type_name = map[int32]string{
		0:  "UNKNOWN",
		1:  "CREATE_DELETE_VOLUME",
		2:  "PUBLISH_UNPUBLISH_VOLUME",
		3:  "LIST_VOLUMES",
		4:  "GET_CAPACITY",
		5:  "CREATE_DELETE_SNAPSHOT",
		6:  "LIST_SNAPSHOTS",
		7:  "CLONE_VOLUME",
		8:  "PUBLISH_READONLY",
		9:  "EXPAND_VOLUME",
		10: "LIST_VOLUMES_PUBLISHED_NODES",
		11: "VOLUME_CONDITION",
		12: "GET_VOLUME",
		13: "SINGLE_NODE_MULTI_WRITER",
		14: "MODIFY_VOLUME",
	}
	ControllerServiceCapability_RPC_Type_value = map[string]int32{
		"UNKNOWN":                      0,
		"CREATE_DELETE_VOLUME":         1,
		"PUBLISH_UNPUBLISH_VOLUME":     2,
		"LIST_VOLUMES":                 3,
		"GET_CAPACITY":                 4,
		"CREATE_DELETE_SNAPSHOT":       5,
		"LIST_SNAPSHOTS":               6,
		"CLONE_VOLUME":                 7,
		"PUBLISH_READONLY":             8,
		"EXPAND_VOLUME":                9,
		"LIST_VOLUMES_PUBLISHED_NODES": 10,
		"VOLUME_CONDITION":             11,
		"GET_VOLUME":                   12,
		"SINGLE_NODE_MULTI_WRITER":     13,
		"MODIFY_VOLUME":                14,
	}
)

Enum value maps for ControllerServiceCapability_RPC_Type.

View Source
var (
	VolumeUsage_Unit_name = map[int32]string{
		0: "UNKNOWN",
		1: "BYTES",
		2: "INODES",
	}
	VolumeUsage_Unit_value = map[string]int32{
		"UNKNOWN": 0,
		"BYTES":   1,
		"INODES":  2,
	}
)

Enum value maps for VolumeUsage_Unit.

View Source
var (
	NodeServiceCapability_RPC_Type_name = map[int32]string{
		0: "UNKNOWN",
		1: "STAGE_UNSTAGE_VOLUME",
		2: "GET_VOLUME_STATS",
		3: "EXPAND_VOLUME",
		4: "VOLUME_CONDITION",
		5: "SINGLE_NODE_MULTI_WRITER",
		6: "VOLUME_MOUNT_GROUP",
	}
	NodeServiceCapability_RPC_Type_value = map[string]int32{
		"UNKNOWN":                  0,
		"STAGE_UNSTAGE_VOLUME":     1,
		"GET_VOLUME_STATS":         2,
		"EXPAND_VOLUME":            3,
		"VOLUME_CONDITION":         4,
		"SINGLE_NODE_MULTI_WRITER": 5,
		"VOLUME_MOUNT_GROUP":       6,
	}
)

Enum value maps for NodeServiceCapability_RPC_Type.

View Source
var (
	GroupControllerServiceCapability_RPC_Type_name = map[int32]string{
		0: "UNKNOWN",
		1: "CREATE_DELETE_GET_VOLUME_GROUP_SNAPSHOT",
	}
	GroupControllerServiceCapability_RPC_Type_value = map[string]int32{
		"UNKNOWN": 0,
		"CREATE_DELETE_GET_VOLUME_GROUP_SNAPSHOT": 1,
	}
)

Enum value maps for GroupControllerServiceCapability_RPC_Type.

View Source
var (
	// Indicates that a field MAY contain information that is sensitive
	// and MUST be treated as such (e.g. not logged).
	//
	// optional bool csi_secret = 1059;
	E_CsiSecret = &file_csi_proto_extTypes[2]
	// Indicates that this field is OPTIONAL and part of an experimental
	// API that may be deprecated and eventually removed between minor
	// releases.
	//
	// optional bool alpha_field = 1060;
	E_AlphaField = &file_csi_proto_extTypes[3]
)

Extension fields to descriptorpb.FieldOptions.

View Source
var Controller_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "csi.v1.Controller",
	HandlerType: (*ControllerServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateVolume",
			Handler:    _Controller_CreateVolume_Handler,
		},
		{
			MethodName: "DeleteVolume",
			Handler:    _Controller_DeleteVolume_Handler,
		},
		{
			MethodName: "ControllerPublishVolume",
			Handler:    _Controller_ControllerPublishVolume_Handler,
		},
		{
			MethodName: "ControllerUnpublishVolume",
			Handler:    _Controller_ControllerUnpublishVolume_Handler,
		},
		{
			MethodName: "ValidateVolumeCapabilities",
			Handler:    _Controller_ValidateVolumeCapabilities_Handler,
		},
		{
			MethodName: "ListVolumes",
			Handler:    _Controller_ListVolumes_Handler,
		},
		{
			MethodName: "GetCapacity",
			Handler:    _Controller_GetCapacity_Handler,
		},
		{
			MethodName: "ControllerGetCapabilities",
			Handler:    _Controller_ControllerGetCapabilities_Handler,
		},
		{
			MethodName: "CreateSnapshot",
			Handler:    _Controller_CreateSnapshot_Handler,
		},
		{
			MethodName: "DeleteSnapshot",
			Handler:    _Controller_DeleteSnapshot_Handler,
		},
		{
			MethodName: "ListSnapshots",
			Handler:    _Controller_ListSnapshots_Handler,
		},
		{
			MethodName: "ControllerExpandVolume",
			Handler:    _Controller_ControllerExpandVolume_Handler,
		},
		{
			MethodName: "ControllerGetVolume",
			Handler:    _Controller_ControllerGetVolume_Handler,
		},
		{
			MethodName: "ControllerModifyVolume",
			Handler:    _Controller_ControllerModifyVolume_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "csi.proto",
}

Controller_ServiceDesc is the grpc.ServiceDesc for Controller 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 (
	// Indicates that this enum is OPTIONAL and part of an experimental
	// API that may be deprecated and eventually removed between minor
	// releases.
	//
	// optional bool alpha_enum = 1060;
	E_AlphaEnum = &file_csi_proto_extTypes[0]
)

Extension fields to descriptorpb.EnumOptions.

View Source
var (
	// Indicates that this enum value is OPTIONAL and part of an
	// experimental API that may be deprecated and eventually removed
	// between minor releases.
	//
	// optional bool alpha_enum_value = 1060;
	E_AlphaEnumValue = &file_csi_proto_extTypes[1]
)

Extension fields to descriptorpb.EnumValueOptions.

View Source
var (
	// Indicates that this message is OPTIONAL and part of an experimental
	// API that may be deprecated and eventually removed between minor
	// releases.
	//
	// optional bool alpha_message = 1060;
	E_AlphaMessage = &file_csi_proto_extTypes[4]
)

Extension fields to descriptorpb.MessageOptions.

View Source
var (
	// Indicates that this method is OPTIONAL and part of an experimental
	// API that may be deprecated and eventually removed between minor
	// releases.
	//
	// optional bool alpha_method = 1060;
	E_AlphaMethod = &file_csi_proto_extTypes[5]
)

Extension fields to descriptorpb.MethodOptions.

View Source
var (
	// Indicates that this service is OPTIONAL and part of an experimental
	// API that may be deprecated and eventually removed between minor
	// releases.
	//
	// optional bool alpha_service = 1060;
	E_AlphaService = &file_csi_proto_extTypes[6]
)

Extension fields to descriptorpb.ServiceOptions.

View Source
var GroupController_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "csi.v1.GroupController",
	HandlerType: (*GroupControllerServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GroupControllerGetCapabilities",
			Handler:    _GroupController_GroupControllerGetCapabilities_Handler,
		},
		{
			MethodName: "CreateVolumeGroupSnapshot",
			Handler:    _GroupController_CreateVolumeGroupSnapshot_Handler,
		},
		{
			MethodName: "DeleteVolumeGroupSnapshot",
			Handler:    _GroupController_DeleteVolumeGroupSnapshot_Handler,
		},
		{
			MethodName: "GetVolumeGroupSnapshot",
			Handler:    _GroupController_GetVolumeGroupSnapshot_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "csi.proto",
}

GroupController_ServiceDesc is the grpc.ServiceDesc for GroupController 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 Identity_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "csi.v1.Identity",
	HandlerType: (*IdentityServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetPluginInfo",
			Handler:    _Identity_GetPluginInfo_Handler,
		},
		{
			MethodName: "GetPluginCapabilities",
			Handler:    _Identity_GetPluginCapabilities_Handler,
		},
		{
			MethodName: "Probe",
			Handler:    _Identity_Probe_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "csi.proto",
}

Identity_ServiceDesc is the grpc.ServiceDesc for Identity 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 Node_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "csi.v1.Node",
	HandlerType: (*NodeServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "NodeStageVolume",
			Handler:    _Node_NodeStageVolume_Handler,
		},
		{
			MethodName: "NodeUnstageVolume",
			Handler:    _Node_NodeUnstageVolume_Handler,
		},
		{
			MethodName: "NodePublishVolume",
			Handler:    _Node_NodePublishVolume_Handler,
		},
		{
			MethodName: "NodeUnpublishVolume",
			Handler:    _Node_NodeUnpublishVolume_Handler,
		},
		{
			MethodName: "NodeGetVolumeStats",
			Handler:    _Node_NodeGetVolumeStats_Handler,
		},
		{
			MethodName: "NodeExpandVolume",
			Handler:    _Node_NodeExpandVolume_Handler,
		},
		{
			MethodName: "NodeGetCapabilities",
			Handler:    _Node_NodeGetCapabilities_Handler,
		},
		{
			MethodName: "NodeGetInfo",
			Handler:    _Node_NodeGetInfo_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "csi.proto",
}

Node_ServiceDesc is the grpc.ServiceDesc for Node 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 SnapshotMetadata_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "csi.v1.SnapshotMetadata",
	HandlerType: (*SnapshotMetadataServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "GetMetadataAllocated",
			Handler:       _SnapshotMetadata_GetMetadataAllocated_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "GetMetadataDelta",
			Handler:       _SnapshotMetadata_GetMetadataDelta_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "csi.proto",
}

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

Functions

func RegisterControllerServer

func RegisterControllerServer(s grpc.ServiceRegistrar, srv ControllerServer)

func RegisterGroupControllerServer added in v1.8.0

func RegisterGroupControllerServer(s grpc.ServiceRegistrar, srv GroupControllerServer)

func RegisterIdentityServer

func RegisterIdentityServer(s grpc.ServiceRegistrar, srv IdentityServer)

func RegisterNodeServer

func RegisterNodeServer(s grpc.ServiceRegistrar, srv NodeServer)

func RegisterSnapshotMetadataServer added in v1.10.0

func RegisterSnapshotMetadataServer(s grpc.ServiceRegistrar, srv SnapshotMetadataServer)

Types

type BlockMetadata added in v1.10.0

type BlockMetadata struct {

	// This is the zero based byte position in the volume or snapshot,
	// measured from the start of the object.
	// This field is REQUIRED.
	ByteOffset int64 `protobuf:"varint,1,opt,name=byte_offset,json=byteOffset,proto3" json:"byte_offset,omitempty"`
	// This is the size of the data range.
	// size_bytes MUST be greater than zero.
	// This field is REQUIRED.
	SizeBytes int64 `protobuf:"varint,2,opt,name=size_bytes,json=sizeBytes,proto3" json:"size_bytes,omitempty"`
	// contains filtered or unexported fields
}

BlockMetadata specifies a data range.

func (*BlockMetadata) Descriptor deprecated added in v1.10.0

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

Deprecated: Use BlockMetadata.ProtoReflect.Descriptor instead.

func (*BlockMetadata) GetByteOffset added in v1.10.0

func (x *BlockMetadata) GetByteOffset() int64

func (*BlockMetadata) GetSizeBytes added in v1.10.0

func (x *BlockMetadata) GetSizeBytes() int64

func (*BlockMetadata) ProtoMessage added in v1.10.0

func (*BlockMetadata) ProtoMessage()

func (*BlockMetadata) ProtoReflect added in v1.10.0

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

func (*BlockMetadata) Reset added in v1.10.0

func (x *BlockMetadata) Reset()

func (*BlockMetadata) String added in v1.10.0

func (x *BlockMetadata) String() string

type BlockMetadataType added in v1.10.0

type BlockMetadataType int32
const (
	BlockMetadataType_UNKNOWN BlockMetadataType = 0
	// The FIXED_LENGTH value indicates that data ranges are
	// returned in fixed size blocks.
	BlockMetadataType_FIXED_LENGTH BlockMetadataType = 1
	// The VARIABLE_LENGTH value indicates that data ranges
	// are returned in potentially variable sized extents.
	BlockMetadataType_VARIABLE_LENGTH BlockMetadataType = 2
)

func (BlockMetadataType) Descriptor added in v1.10.0

func (BlockMetadataType) Enum added in v1.10.0

func (BlockMetadataType) EnumDescriptor deprecated added in v1.10.0

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

Deprecated: Use BlockMetadataType.Descriptor instead.

func (BlockMetadataType) Number added in v1.10.0

func (BlockMetadataType) String added in v1.10.0

func (x BlockMetadataType) String() string

func (BlockMetadataType) Type added in v1.10.0

type CapacityRange

type CapacityRange struct {

	// Volume MUST be at least this big. This field is OPTIONAL.
	// A value of 0 is equal to an unspecified field value.
	// The value of this field MUST NOT be negative.
	RequiredBytes int64 `protobuf:"varint,1,opt,name=required_bytes,json=requiredBytes,proto3" json:"required_bytes,omitempty"`
	// Volume MUST not be bigger than this. This field is OPTIONAL.
	// A value of 0 is equal to an unspecified field value.
	// The value of this field MUST NOT be negative.
	LimitBytes int64 `protobuf:"varint,2,opt,name=limit_bytes,json=limitBytes,proto3" json:"limit_bytes,omitempty"`
	// contains filtered or unexported fields
}

The capacity of the storage space in bytes. To specify an exact size, `required_bytes` and `limit_bytes` SHALL be set to the same value. At least one of the these fields MUST be specified.

func (*CapacityRange) Descriptor deprecated

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

Deprecated: Use CapacityRange.ProtoReflect.Descriptor instead.

func (*CapacityRange) GetLimitBytes

func (x *CapacityRange) GetLimitBytes() int64

func (*CapacityRange) GetRequiredBytes

func (x *CapacityRange) GetRequiredBytes() int64

func (*CapacityRange) ProtoMessage

func (*CapacityRange) ProtoMessage()

func (*CapacityRange) ProtoReflect added in v1.10.0

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

func (*CapacityRange) Reset

func (x *CapacityRange) Reset()

func (*CapacityRange) String

func (x *CapacityRange) String() string

type ControllerClient

type ControllerClient interface {
	CreateVolume(ctx context.Context, in *CreateVolumeRequest, opts ...grpc.CallOption) (*CreateVolumeResponse, error)
	DeleteVolume(ctx context.Context, in *DeleteVolumeRequest, opts ...grpc.CallOption) (*DeleteVolumeResponse, error)
	ControllerPublishVolume(ctx context.Context, in *ControllerPublishVolumeRequest, opts ...grpc.CallOption) (*ControllerPublishVolumeResponse, error)
	ControllerUnpublishVolume(ctx context.Context, in *ControllerUnpublishVolumeRequest, opts ...grpc.CallOption) (*ControllerUnpublishVolumeResponse, error)
	ValidateVolumeCapabilities(ctx context.Context, in *ValidateVolumeCapabilitiesRequest, opts ...grpc.CallOption) (*ValidateVolumeCapabilitiesResponse, error)
	ListVolumes(ctx context.Context, in *ListVolumesRequest, opts ...grpc.CallOption) (*ListVolumesResponse, error)
	GetCapacity(ctx context.Context, in *GetCapacityRequest, opts ...grpc.CallOption) (*GetCapacityResponse, error)
	ControllerGetCapabilities(ctx context.Context, in *ControllerGetCapabilitiesRequest, opts ...grpc.CallOption) (*ControllerGetCapabilitiesResponse, error)
	CreateSnapshot(ctx context.Context, in *CreateSnapshotRequest, opts ...grpc.CallOption) (*CreateSnapshotResponse, error)
	DeleteSnapshot(ctx context.Context, in *DeleteSnapshotRequest, opts ...grpc.CallOption) (*DeleteSnapshotResponse, error)
	ListSnapshots(ctx context.Context, in *ListSnapshotsRequest, opts ...grpc.CallOption) (*ListSnapshotsResponse, error)
	ControllerExpandVolume(ctx context.Context, in *ControllerExpandVolumeRequest, opts ...grpc.CallOption) (*ControllerExpandVolumeResponse, error)
	ControllerGetVolume(ctx context.Context, in *ControllerGetVolumeRequest, opts ...grpc.CallOption) (*ControllerGetVolumeResponse, error)
	ControllerModifyVolume(ctx context.Context, in *ControllerModifyVolumeRequest, opts ...grpc.CallOption) (*ControllerModifyVolumeResponse, error)
}

ControllerClient is the client API for Controller 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 NewControllerClient

func NewControllerClient(cc grpc.ClientConnInterface) ControllerClient

type ControllerExpandVolumeRequest added in v1.1.0

type ControllerExpandVolumeRequest struct {

	// The ID of the volume to expand. This field is REQUIRED.
	VolumeId string `protobuf:"bytes,1,opt,name=volume_id,json=volumeId,proto3" json:"volume_id,omitempty"`
	// This allows CO to specify the capacity requirements of the volume
	// after expansion. This field is REQUIRED.
	CapacityRange *CapacityRange `protobuf:"bytes,2,opt,name=capacity_range,json=capacityRange,proto3" json:"capacity_range,omitempty"`
	// Secrets required by the plugin for expanding the volume.
	// This field is OPTIONAL.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// 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 set
	// node_expansion_required to false in ControllerExpandVolumeResponse
	// to skip invocation of NodeExpandVolume on the node by the CO.
	// This is an OPTIONAL field.
	VolumeCapability *VolumeCapability `protobuf:"bytes,4,opt,name=volume_capability,json=volumeCapability,proto3" json:"volume_capability,omitempty"`
	// contains filtered or unexported fields
}

func (*ControllerExpandVolumeRequest) Descriptor deprecated added in v1.1.0

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

Deprecated: Use ControllerExpandVolumeRequest.ProtoReflect.Descriptor instead.

func (*ControllerExpandVolumeRequest) GetCapacityRange added in v1.1.0

func (x *ControllerExpandVolumeRequest) GetCapacityRange() *CapacityRange

func (*ControllerExpandVolumeRequest) GetSecrets added in v1.1.0

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

func (*ControllerExpandVolumeRequest) GetVolumeCapability added in v1.2.0

func (x *ControllerExpandVolumeRequest) GetVolumeCapability() *VolumeCapability

func (*ControllerExpandVolumeRequest) GetVolumeId added in v1.1.0

func (x *ControllerExpandVolumeRequest) GetVolumeId() string

func (*ControllerExpandVolumeRequest) ProtoMessage added in v1.1.0

func (*ControllerExpandVolumeRequest) ProtoMessage()

func (*ControllerExpandVolumeRequest) ProtoReflect added in v1.10.0

func (*ControllerExpandVolumeRequest) Reset added in v1.1.0

func (x *ControllerExpandVolumeRequest) Reset()

func (*ControllerExpandVolumeRequest) String added in v1.1.0

type ControllerExpandVolumeResponse added in v1.1.0

type ControllerExpandVolumeResponse struct {

	// Capacity of volume after expansion. This field is REQUIRED.
	CapacityBytes int64 `protobuf:"varint,1,opt,name=capacity_bytes,json=capacityBytes,proto3" json:"capacity_bytes,omitempty"`
	// Whether node expansion is required for the volume. When true
	// the CO MUST make NodeExpandVolume RPC call on the node. This field
	// is REQUIRED.
	NodeExpansionRequired bool `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ControllerExpandVolumeResponse) Descriptor deprecated added in v1.1.0

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

Deprecated: Use ControllerExpandVolumeResponse.ProtoReflect.Descriptor instead.

func (*ControllerExpandVolumeResponse) GetCapacityBytes added in v1.1.0

func (x *ControllerExpandVolumeResponse) GetCapacityBytes() int64

func (*ControllerExpandVolumeResponse) GetNodeExpansionRequired added in v1.1.0

func (x *ControllerExpandVolumeResponse) GetNodeExpansionRequired() bool

func (*ControllerExpandVolumeResponse) ProtoMessage added in v1.1.0

func (*ControllerExpandVolumeResponse) ProtoMessage()

func (*ControllerExpandVolumeResponse) ProtoReflect added in v1.10.0

func (*ControllerExpandVolumeResponse) Reset added in v1.1.0

func (x *ControllerExpandVolumeResponse) Reset()

func (*ControllerExpandVolumeResponse) String added in v1.1.0

type ControllerGetCapabilitiesRequest

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

func (*ControllerGetCapabilitiesRequest) Descriptor deprecated

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

Deprecated: Use ControllerGetCapabilitiesRequest.ProtoReflect.Descriptor instead.

func (*ControllerGetCapabilitiesRequest) ProtoMessage

func (*ControllerGetCapabilitiesRequest) ProtoMessage()

func (*ControllerGetCapabilitiesRequest) ProtoReflect added in v1.10.0

func (*ControllerGetCapabilitiesRequest) Reset

func (*ControllerGetCapabilitiesRequest) String

type ControllerGetCapabilitiesResponse

type ControllerGetCapabilitiesResponse struct {

	// All the capabilities that the controller service supports. This
	// field is OPTIONAL.
	Capabilities []*ControllerServiceCapability `protobuf:"bytes,1,rep,name=capabilities,proto3" json:"capabilities,omitempty"`
	// contains filtered or unexported fields
}

func (*ControllerGetCapabilitiesResponse) Descriptor deprecated

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

Deprecated: Use ControllerGetCapabilitiesResponse.ProtoReflect.Descriptor instead.

func (*ControllerGetCapabilitiesResponse) GetCapabilities

func (*ControllerGetCapabilitiesResponse) ProtoMessage

func (*ControllerGetCapabilitiesResponse) ProtoMessage()

func (*ControllerGetCapabilitiesResponse) ProtoReflect added in v1.10.0

func (*ControllerGetCapabilitiesResponse) Reset

func (*ControllerGetCapabilitiesResponse) String

type ControllerGetVolumeRequest added in v1.3.0

type ControllerGetVolumeRequest struct {

	// The ID of the volume to fetch current volume information for.
	// This field is REQUIRED.
	VolumeId string `protobuf:"bytes,1,opt,name=volume_id,json=volumeId,proto3" json:"volume_id,omitempty"`
	// contains filtered or unexported fields
}

func (*ControllerGetVolumeRequest) Descriptor deprecated added in v1.3.0

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

Deprecated: Use ControllerGetVolumeRequest.ProtoReflect.Descriptor instead.

func (*ControllerGetVolumeRequest) GetVolumeId added in v1.3.0

func (x *ControllerGetVolumeRequest) GetVolumeId() string

func (*ControllerGetVolumeRequest) ProtoMessage added in v1.3.0

func (*ControllerGetVolumeRequest) ProtoMessage()

func (*ControllerGetVolumeRequest) ProtoReflect added in v1.10.0

func (*ControllerGetVolumeRequest) Reset added in v1.3.0

func (x *ControllerGetVolumeRequest) Reset()

func (*ControllerGetVolumeRequest) String added in v1.3.0

func (x *ControllerGetVolumeRequest) String() string

type ControllerGetVolumeResponse added in v1.3.0

type ControllerGetVolumeResponse struct {

	// This field is REQUIRED
	Volume *Volume `protobuf:"bytes,1,opt,name=volume,proto3" json:"volume,omitempty"`
	// This field is REQUIRED.
	Status *ControllerGetVolumeResponse_VolumeStatus `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*ControllerGetVolumeResponse) Descriptor deprecated added in v1.3.0

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

Deprecated: Use ControllerGetVolumeResponse.ProtoReflect.Descriptor instead.

func (*ControllerGetVolumeResponse) GetStatus added in v1.3.0

func (*ControllerGetVolumeResponse) GetVolume added in v1.3.0

func (x *ControllerGetVolumeResponse) GetVolume() *Volume

func (*ControllerGetVolumeResponse) ProtoMessage added in v1.3.0

func (*ControllerGetVolumeResponse) ProtoMessage()

func (*ControllerGetVolumeResponse) ProtoReflect added in v1.10.0

func (*ControllerGetVolumeResponse) Reset added in v1.3.0

func (x *ControllerGetVolumeResponse) Reset()

func (*ControllerGetVolumeResponse) String added in v1.3.0

func (x *ControllerGetVolumeResponse) String() string

type ControllerGetVolumeResponse_VolumeStatus added in v1.3.0

type ControllerGetVolumeResponse_VolumeStatus struct {

	// A list of all the `node_id` of nodes that this volume is
	// controller published on.
	// This field is OPTIONAL.
	// This field MUST be specified if the LIST_VOLUMES_PUBLISHED_NODES
	// controller capability is supported.
	// published_node_ids MAY include nodes not published to or
	// reported by the SP. The CO MUST be resilient to that.
	PublishedNodeIds []string `protobuf:"bytes,1,rep,name=published_node_ids,json=publishedNodeIds,proto3" json:"published_node_ids,omitempty"`
	// Information about the current condition of the volume.
	// This field is OPTIONAL.
	// This field MUST be specified if the
	// VOLUME_CONDITION controller capability is supported.
	VolumeCondition *VolumeCondition `protobuf:"bytes,2,opt,name=volume_condition,json=volumeCondition,proto3" json:"volume_condition,omitempty"`
	// contains filtered or unexported fields
}

func (*ControllerGetVolumeResponse_VolumeStatus) Descriptor deprecated added in v1.3.0

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

Deprecated: Use ControllerGetVolumeResponse_VolumeStatus.ProtoReflect.Descriptor instead.

func (*ControllerGetVolumeResponse_VolumeStatus) GetPublishedNodeIds added in v1.3.0

func (x *ControllerGetVolumeResponse_VolumeStatus) GetPublishedNodeIds() []string

func (*ControllerGetVolumeResponse_VolumeStatus) GetVolumeCondition added in v1.3.0

func (*ControllerGetVolumeResponse_VolumeStatus) ProtoMessage added in v1.3.0

func (*ControllerGetVolumeResponse_VolumeStatus) ProtoReflect added in v1.10.0

func (*ControllerGetVolumeResponse_VolumeStatus) Reset added in v1.3.0

func (*ControllerGetVolumeResponse_VolumeStatus) String added in v1.3.0

type ControllerModifyVolumeRequest added in v1.9.0

type ControllerModifyVolumeRequest struct {

	// Contains identity information for the existing volume.
	// This field is REQUIRED.
	VolumeId string `protobuf:"bytes,1,opt,name=volume_id,json=volumeId,proto3" json:"volume_id,omitempty"`
	// Secrets required by plugin to complete modify volume request.
	// This field is OPTIONAL. Refer to the `Secrets Requirements`
	// section on how to use this field.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// Plugin specific volume attributes to mutate, passed in as
	// opaque key-value pairs.
	// This field is REQUIRED. The Plugin is responsible for
	// parsing and validating these parameters. COs will treat these
	// as opaque. The CO SHOULD specify the intended values of all mutable
	// parameters it intends to modify. SPs MUST NOT modify volumes based
	// on the absence of keys, only keys that are specified should result
	// in modifications to the volume.
	MutableParameters map[string]string `` /* 200-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ControllerModifyVolumeRequest) Descriptor deprecated added in v1.9.0

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

Deprecated: Use ControllerModifyVolumeRequest.ProtoReflect.Descriptor instead.

func (*ControllerModifyVolumeRequest) GetMutableParameters added in v1.9.0

func (x *ControllerModifyVolumeRequest) GetMutableParameters() map[string]string

func (*ControllerModifyVolumeRequest) GetSecrets added in v1.9.0

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

func (*ControllerModifyVolumeRequest) GetVolumeId added in v1.9.0

func (x *ControllerModifyVolumeRequest) GetVolumeId() string

func (*ControllerModifyVolumeRequest) ProtoMessage added in v1.9.0

func (*ControllerModifyVolumeRequest) ProtoMessage()

func (*ControllerModifyVolumeRequest) ProtoReflect added in v1.10.0

func (*ControllerModifyVolumeRequest) Reset added in v1.9.0

func (x *ControllerModifyVolumeRequest) Reset()

func (*ControllerModifyVolumeRequest) String added in v1.9.0

type ControllerModifyVolumeResponse added in v1.9.0

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

func (*ControllerModifyVolumeResponse) Descriptor deprecated added in v1.9.0

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

Deprecated: Use ControllerModifyVolumeResponse.ProtoReflect.Descriptor instead.

func (*ControllerModifyVolumeResponse) ProtoMessage added in v1.9.0

func (*ControllerModifyVolumeResponse) ProtoMessage()

func (*ControllerModifyVolumeResponse) ProtoReflect added in v1.10.0

func (*ControllerModifyVolumeResponse) Reset added in v1.9.0

func (x *ControllerModifyVolumeResponse) Reset()

func (*ControllerModifyVolumeResponse) String added in v1.9.0

type ControllerPublishVolumeRequest

type ControllerPublishVolumeRequest struct {

	// The ID of the volume to be used on a node.
	// This field is REQUIRED.
	VolumeId string `protobuf:"bytes,1,opt,name=volume_id,json=volumeId,proto3" json:"volume_id,omitempty"`
	// The ID of the node. This field is REQUIRED. The CO SHALL set this
	// field to match the node ID returned by `NodeGetInfo`.
	NodeId string `protobuf:"bytes,2,opt,name=node_id,json=nodeId,proto3" json:"node_id,omitempty"`
	// Volume capability describing how the CO intends to use this volume.
	// SP MUST ensure the CO can use the published volume as described.
	// Otherwise SP MUST return the appropriate gRPC error code.
	// This is a REQUIRED field.
	VolumeCapability *VolumeCapability `protobuf:"bytes,3,opt,name=volume_capability,json=volumeCapability,proto3" json:"volume_capability,omitempty"`
	// Indicates SP MUST publish the volume in readonly mode.
	// CO MUST set this field to false if SP does not have the
	// PUBLISH_READONLY controller capability.
	// This is a REQUIRED field.
	Readonly bool `protobuf:"varint,4,opt,name=readonly,proto3" json:"readonly,omitempty"`
	// Secrets required by plugin to complete controller publish volume
	// request. This field is OPTIONAL. Refer to the
	// `Secrets Requirements` section on how to use this field.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// Volume context as returned by SP in
	// CreateVolumeResponse.Volume.volume_context.
	// This field is OPTIONAL and MUST match the volume_context of the
	// volume identified by `volume_id`.
	VolumeContext map[string]string `` /* 188-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ControllerPublishVolumeRequest) Descriptor deprecated

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

Deprecated: Use ControllerPublishVolumeRequest.ProtoReflect.Descriptor instead.

func (*ControllerPublishVolumeRequest) GetNodeId

func (x *ControllerPublishVolumeRequest) GetNodeId() string

func (*ControllerPublishVolumeRequest) GetReadonly

func (x *ControllerPublishVolumeRequest) GetReadonly() bool

func (*ControllerPublishVolumeRequest) GetSecrets added in v1.0.0

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

func (*ControllerPublishVolumeRequest) GetVolumeCapability

func (x *ControllerPublishVolumeRequest) GetVolumeCapability() *VolumeCapability

func (*ControllerPublishVolumeRequest) GetVolumeContext added in v1.0.0

func (x *ControllerPublishVolumeRequest) GetVolumeContext() map[string]string

func (*ControllerPublishVolumeRequest) GetVolumeId

func (x *ControllerPublishVolumeRequest) GetVolumeId() string

func (*ControllerPublishVolumeRequest) ProtoMessage

func (*ControllerPublishVolumeRequest) ProtoMessage()

func (*ControllerPublishVolumeRequest) ProtoReflect added in v1.10.0

func (*ControllerPublishVolumeRequest) Reset

func (x *ControllerPublishVolumeRequest) Reset()

func (*ControllerPublishVolumeRequest) String

type ControllerPublishVolumeResponse

type ControllerPublishVolumeResponse struct {

	// Opaque static publish properties of the volume. SP MAY use this
	// field to ensure subsequent `NodeStageVolume` or `NodePublishVolume`
	// calls calls have contextual information.
	// The contents of this field SHALL be opaque to a CO.
	// The contents of this field SHALL NOT be mutable.
	// The contents of this field SHALL be safe for the CO to cache.
	// The contents of this field SHOULD NOT contain sensitive
	// information.
	// The contents of this field SHOULD NOT be used for uniquely
	// identifying a volume. The `volume_id` alone SHOULD be sufficient to
	// identify the volume.
	// This field is OPTIONAL and when present MUST be passed to
	// subsequent `NodeStageVolume` or `NodePublishVolume` calls
	PublishContext map[string]string `` /* 191-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ControllerPublishVolumeResponse) Descriptor deprecated

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

Deprecated: Use ControllerPublishVolumeResponse.ProtoReflect.Descriptor instead.

func (*ControllerPublishVolumeResponse) GetPublishContext added in v1.0.0

func (x *ControllerPublishVolumeResponse) GetPublishContext() map[string]string

func (*ControllerPublishVolumeResponse) ProtoMessage

func (*ControllerPublishVolumeResponse) ProtoMessage()

func (*ControllerPublishVolumeResponse) ProtoReflect added in v1.10.0

func (*ControllerPublishVolumeResponse) Reset

func (*ControllerPublishVolumeResponse) String

type ControllerServer

ControllerServer is the server API for Controller service. All implementations must embed UnimplementedControllerServer for forward compatibility

type ControllerServiceCapability

type ControllerServiceCapability struct {

	// Types that are assignable to Type:
	//
	//	*ControllerServiceCapability_Rpc
	Type isControllerServiceCapability_Type `protobuf_oneof:"type"`
	// contains filtered or unexported fields
}

Specifies a capability of the controller service.

func (*ControllerServiceCapability) Descriptor deprecated

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

Deprecated: Use ControllerServiceCapability.ProtoReflect.Descriptor instead.

func (*ControllerServiceCapability) GetRpc

func (*ControllerServiceCapability) GetType

func (m *ControllerServiceCapability) GetType() isControllerServiceCapability_Type

func (*ControllerServiceCapability) ProtoMessage

func (*ControllerServiceCapability) ProtoMessage()

func (*ControllerServiceCapability) ProtoReflect added in v1.10.0

func (*ControllerServiceCapability) Reset

func (x *ControllerServiceCapability) Reset()

func (*ControllerServiceCapability) String

func (x *ControllerServiceCapability) String() string

type ControllerServiceCapability_RPC

type ControllerServiceCapability_RPC struct {
	Type ControllerServiceCapability_RPC_Type `protobuf:"varint,1,opt,name=type,proto3,enum=csi.v1.ControllerServiceCapability_RPC_Type" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*ControllerServiceCapability_RPC) Descriptor deprecated

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

Deprecated: Use ControllerServiceCapability_RPC.ProtoReflect.Descriptor instead.

func (*ControllerServiceCapability_RPC) GetType

func (*ControllerServiceCapability_RPC) ProtoMessage

func (*ControllerServiceCapability_RPC) ProtoMessage()

func (*ControllerServiceCapability_RPC) ProtoReflect added in v1.10.0

func (*ControllerServiceCapability_RPC) Reset

func (*ControllerServiceCapability_RPC) String

type ControllerServiceCapability_RPC_Type

type ControllerServiceCapability_RPC_Type int32
const (
	ControllerServiceCapability_RPC_UNKNOWN                  ControllerServiceCapability_RPC_Type = 0
	ControllerServiceCapability_RPC_CREATE_DELETE_VOLUME     ControllerServiceCapability_RPC_Type = 1
	ControllerServiceCapability_RPC_PUBLISH_UNPUBLISH_VOLUME ControllerServiceCapability_RPC_Type = 2
	ControllerServiceCapability_RPC_LIST_VOLUMES             ControllerServiceCapability_RPC_Type = 3
	ControllerServiceCapability_RPC_GET_CAPACITY             ControllerServiceCapability_RPC_Type = 4
	// Currently the only way to consume a snapshot is to create
	// a volume from it. Therefore plugins supporting
	// CREATE_DELETE_SNAPSHOT MUST support creating volume from
	// snapshot.
	ControllerServiceCapability_RPC_CREATE_DELETE_SNAPSHOT ControllerServiceCapability_RPC_Type = 5
	ControllerServiceCapability_RPC_LIST_SNAPSHOTS         ControllerServiceCapability_RPC_Type = 6
	// Plugins supporting volume cloning at the storage level MAY
	// report this capability. The source volume MUST be managed by
	// the same plugin. Not all volume sources and parameters
	// combinations MAY work.
	ControllerServiceCapability_RPC_CLONE_VOLUME ControllerServiceCapability_RPC_Type = 7
	// Indicates the SP supports ControllerPublishVolume.readonly
	// field.
	ControllerServiceCapability_RPC_PUBLISH_READONLY ControllerServiceCapability_RPC_Type = 8
	// See VolumeExpansion for details.
	ControllerServiceCapability_RPC_EXPAND_VOLUME ControllerServiceCapability_RPC_Type = 9
	// Indicates the SP supports the
	// ListVolumesResponse.entry.published_node_ids field and the
	// ControllerGetVolumeResponse.published_node_ids field.
	// The SP MUST also support PUBLISH_UNPUBLISH_VOLUME.
	ControllerServiceCapability_RPC_LIST_VOLUMES_PUBLISHED_NODES ControllerServiceCapability_RPC_Type = 10
	// Indicates that the Controller service can report volume
	// conditions.
	// An SP MAY implement `VolumeCondition` in only the Controller
	// Plugin, only the Node Plugin, or both.
	// If `VolumeCondition` is implemented in both the Controller and
	// Node Plugins, it SHALL report from different perspectives.
	// If for some reason Controller and Node Plugins report
	// misaligned volume conditions, CO SHALL assume the worst case
	// is the truth.
	// Note that, for alpha, `VolumeCondition` is intended be
	// informative for humans only, not for automation.
	ControllerServiceCapability_RPC_VOLUME_CONDITION ControllerServiceCapability_RPC_Type = 11
	// Indicates the SP supports the ControllerGetVolume RPC.
	// This enables COs to, for example, fetch per volume
	// condition after a volume is provisioned.
	ControllerServiceCapability_RPC_GET_VOLUME ControllerServiceCapability_RPC_Type = 12
	// Indicates the SP supports the SINGLE_NODE_SINGLE_WRITER and/or
	// SINGLE_NODE_MULTI_WRITER access modes.
	// These access modes are intended to replace the
	// SINGLE_NODE_WRITER access mode to clarify the number of writers
	// for a volume on a single node. Plugins MUST accept and allow
	// use of the SINGLE_NODE_WRITER access mode when either
	// SINGLE_NODE_SINGLE_WRITER and/or SINGLE_NODE_MULTI_WRITER are
	// supported, in order to permit older COs to continue working.
	ControllerServiceCapability_RPC_SINGLE_NODE_MULTI_WRITER ControllerServiceCapability_RPC_Type = 13
	// Indicates the SP supports modifying volume with mutable
	// parameters. See ControllerModifyVolume for details.
	ControllerServiceCapability_RPC_MODIFY_VOLUME ControllerServiceCapability_RPC_Type = 14
)

func (ControllerServiceCapability_RPC_Type) Descriptor added in v1.10.0

func (ControllerServiceCapability_RPC_Type) Enum added in v1.10.0

func (ControllerServiceCapability_RPC_Type) EnumDescriptor deprecated

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

Deprecated: Use ControllerServiceCapability_RPC_Type.Descriptor instead.

func (ControllerServiceCapability_RPC_Type) Number added in v1.10.0

func (ControllerServiceCapability_RPC_Type) String

func (ControllerServiceCapability_RPC_Type) Type added in v1.10.0

type ControllerServiceCapability_Rpc

type ControllerServiceCapability_Rpc struct {
	// RPC that the controller supports.
	Rpc *ControllerServiceCapability_RPC `protobuf:"bytes,1,opt,name=rpc,proto3,oneof"`
}

type ControllerUnpublishVolumeRequest

type ControllerUnpublishVolumeRequest 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 ID of the node. This field is OPTIONAL. The CO SHOULD set this
	// field to match the node ID returned by `NodeGetInfo` or leave it
	// unset. If the value is set, the SP MUST unpublish the volume from
	// the specified node. If the value is unset, the SP MUST unpublish
	// the volume from all nodes it is published to.
	NodeId string `protobuf:"bytes,2,opt,name=node_id,json=nodeId,proto3" json:"node_id,omitempty"`
	// Secrets required by plugin to complete controller unpublish volume
	// request. This SHOULD be the same secrets passed to the
	// ControllerPublishVolume call for the specified volume.
	// This field is OPTIONAL. Refer to the `Secrets Requirements`
	// section on how to use this field.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ControllerUnpublishVolumeRequest) Descriptor deprecated

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

Deprecated: Use ControllerUnpublishVolumeRequest.ProtoReflect.Descriptor instead.

func (*ControllerUnpublishVolumeRequest) GetNodeId

func (*ControllerUnpublishVolumeRequest) GetSecrets added in v1.0.0

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

func (*ControllerUnpublishVolumeRequest) GetVolumeId

func (x *ControllerUnpublishVolumeRequest) GetVolumeId() string

func (*ControllerUnpublishVolumeRequest) ProtoMessage

func (*ControllerUnpublishVolumeRequest) ProtoMessage()

func (*ControllerUnpublishVolumeRequest) ProtoReflect added in v1.10.0

func (*ControllerUnpublishVolumeRequest) Reset

func (*ControllerUnpublishVolumeRequest) String

type ControllerUnpublishVolumeResponse

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

func (*ControllerUnpublishVolumeResponse) Descriptor deprecated

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

Deprecated: Use ControllerUnpublishVolumeResponse.ProtoReflect.Descriptor instead.

func (*ControllerUnpublishVolumeResponse) ProtoMessage

func (*ControllerUnpublishVolumeResponse) ProtoMessage()

func (*ControllerUnpublishVolumeResponse) ProtoReflect added in v1.10.0

func (*ControllerUnpublishVolumeResponse) Reset

func (*ControllerUnpublishVolumeResponse) String

type CreateSnapshotRequest added in v1.0.0

type CreateSnapshotRequest struct {

	// The ID of the source volume to be snapshotted.
	// This field is REQUIRED.
	SourceVolumeId string `protobuf:"bytes,1,opt,name=source_volume_id,json=sourceVolumeId,proto3" json:"source_volume_id,omitempty"`
	// The suggested name for the snapshot. This field is REQUIRED for
	// idempotency.
	// Any Unicode string that conforms to the length limit is allowed
	// except those containing the following banned characters:
	// U+0000-U+0008, U+000B, U+000C, U+000E-U+001F, U+007F-U+009F.
	// (These are control characters other than commonly used whitespace.)
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Secrets required by plugin to complete snapshot creation request.
	// This field is OPTIONAL. Refer to the `Secrets Requirements`
	// section on how to use this field.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// Plugin specific parameters passed in as opaque key-value pairs.
	// This field is OPTIONAL. The Plugin is responsible for parsing and
	// validating these parameters. COs will treat these as opaque.
	// Use cases for opaque parameters:
	//   - Specify a policy to automatically clean up the snapshot.
	//   - Specify an expiration date for the snapshot.
	//   - Specify whether the snapshot is readonly or read/write.
	//   - Specify if the snapshot should be replicated to some place.
	//   - Specify primary or secondary for replication systems that
	//     support snapshotting only on primary.
	Parameters map[string]string `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*CreateSnapshotRequest) Descriptor deprecated added in v1.0.0

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

Deprecated: Use CreateSnapshotRequest.ProtoReflect.Descriptor instead.

func (*CreateSnapshotRequest) GetName added in v1.0.0

func (x *CreateSnapshotRequest) GetName() string

func (*CreateSnapshotRequest) GetParameters added in v1.0.0

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

func (*CreateSnapshotRequest) GetSecrets added in v1.0.0

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

func (*CreateSnapshotRequest) GetSourceVolumeId added in v1.0.0

func (x *CreateSnapshotRequest) GetSourceVolumeId() string

func (*CreateSnapshotRequest) ProtoMessage added in v1.0.0

func (*CreateSnapshotRequest) ProtoMessage()

func (*CreateSnapshotRequest) ProtoReflect added in v1.10.0

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

func (*CreateSnapshotRequest) Reset added in v1.0.0

func (x *CreateSnapshotRequest) Reset()

func (*CreateSnapshotRequest) String added in v1.0.0

func (x *CreateSnapshotRequest) String() string

type CreateSnapshotResponse added in v1.0.0

type CreateSnapshotResponse struct {

	// Contains all attributes of the newly created snapshot that are
	// relevant to the CO along with information required by the Plugin
	// to uniquely identify the snapshot. This field is REQUIRED.
	Snapshot *Snapshot `protobuf:"bytes,1,opt,name=snapshot,proto3" json:"snapshot,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateSnapshotResponse) Descriptor deprecated added in v1.0.0

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

Deprecated: Use CreateSnapshotResponse.ProtoReflect.Descriptor instead.

func (*CreateSnapshotResponse) GetSnapshot added in v1.0.0

func (x *CreateSnapshotResponse) GetSnapshot() *Snapshot

func (*CreateSnapshotResponse) ProtoMessage added in v1.0.0

func (*CreateSnapshotResponse) ProtoMessage()

func (*CreateSnapshotResponse) ProtoReflect added in v1.10.0

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

func (*CreateSnapshotResponse) Reset added in v1.0.0

func (x *CreateSnapshotResponse) Reset()

func (*CreateSnapshotResponse) String added in v1.0.0

func (x *CreateSnapshotResponse) String() string

type CreateVolumeGroupSnapshotRequest added in v1.8.0

type CreateVolumeGroupSnapshotRequest struct {

	// The suggested name for the group snapshot. This field is REQUIRED
	// for idempotency.
	// Any Unicode string that conforms to the length limit is allowed
	// except those containing the following banned characters:
	// U+0000-U+0008, U+000B, U+000C, U+000E-U+001F, U+007F-U+009F.
	// (These are control characters other than commonly used whitespace.)
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// volume IDs of the source volumes to be snapshotted together.
	// This field is REQUIRED.
	SourceVolumeIds []string `protobuf:"bytes,2,rep,name=source_volume_ids,json=sourceVolumeIds,proto3" json:"source_volume_ids,omitempty"`
	// Secrets required by plugin to complete
	// ControllerCreateVolumeGroupSnapshot request.
	// This field is OPTIONAL. Refer to the `Secrets Requirements`
	// section on how to use this field.
	// The secrets provided in this field SHOULD be the same for
	// all group snapshot operations on the same group snapshot.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// Plugin specific parameters passed in as opaque key-value pairs.
	// This field is OPTIONAL. The Plugin is responsible for parsing and
	// validating these parameters. COs will treat these as opaque.
	Parameters map[string]string `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*CreateVolumeGroupSnapshotRequest) Descriptor deprecated added in v1.8.0

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

Deprecated: Use CreateVolumeGroupSnapshotRequest.ProtoReflect.Descriptor instead.

func (*CreateVolumeGroupSnapshotRequest) GetName added in v1.8.0

func (*CreateVolumeGroupSnapshotRequest) GetParameters added in v1.8.0

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

func (*CreateVolumeGroupSnapshotRequest) GetSecrets added in v1.8.0

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

func (*CreateVolumeGroupSnapshotRequest) GetSourceVolumeIds added in v1.8.0

func (x *CreateVolumeGroupSnapshotRequest) GetSourceVolumeIds() []string

func (*CreateVolumeGroupSnapshotRequest) ProtoMessage added in v1.8.0

func (*CreateVolumeGroupSnapshotRequest) ProtoMessage()

func (*CreateVolumeGroupSnapshotRequest) ProtoReflect added in v1.10.0

func (*CreateVolumeGroupSnapshotRequest) Reset added in v1.8.0

func (*CreateVolumeGroupSnapshotRequest) String added in v1.8.0

type CreateVolumeGroupSnapshotResponse added in v1.8.0

type CreateVolumeGroupSnapshotResponse struct {

	// Contains all attributes of the newly created group snapshot.
	// This field is REQUIRED.
	GroupSnapshot *VolumeGroupSnapshot `protobuf:"bytes,1,opt,name=group_snapshot,json=groupSnapshot,proto3" json:"group_snapshot,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateVolumeGroupSnapshotResponse) Descriptor deprecated added in v1.8.0

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

Deprecated: Use CreateVolumeGroupSnapshotResponse.ProtoReflect.Descriptor instead.

func (*CreateVolumeGroupSnapshotResponse) GetGroupSnapshot added in v1.8.0

func (*CreateVolumeGroupSnapshotResponse) ProtoMessage added in v1.8.0

func (*CreateVolumeGroupSnapshotResponse) ProtoMessage()

func (*CreateVolumeGroupSnapshotResponse) ProtoReflect added in v1.10.0

func (*CreateVolumeGroupSnapshotResponse) Reset added in v1.8.0

func (*CreateVolumeGroupSnapshotResponse) String added in v1.8.0

type CreateVolumeRequest

type CreateVolumeRequest struct {

	// The suggested name for the storage space. This field is REQUIRED.
	// It serves two purposes:
	//  1. Idempotency - This name is generated by the CO to achieve
	//     idempotency.  The Plugin SHOULD ensure that multiple
	//     `CreateVolume` calls for the same name do not result in more
	//     than one piece of storage provisioned corresponding to that
	//     name. If a Plugin is unable to enforce idempotency, the CO's
	//     error recovery logic could result in multiple (unused) volumes
	//     being provisioned.
	//     In the case of error, the CO MUST handle the gRPC error codes
	//     per the recovery behavior defined in the "CreateVolume Errors"
	//     section below.
	//     The CO is responsible for cleaning up volumes it provisioned
	//     that it no longer needs. If the CO is uncertain whether a volume
	//     was provisioned or not when a `CreateVolume` call fails, the CO
	//     MAY call `CreateVolume` again, with the same name, to ensure the
	//     volume exists and to retrieve the volume's `volume_id` (unless
	//     otherwise prohibited by "CreateVolume Errors").
	//  2. Suggested name - Some storage systems allow callers to specify
	//     an identifier by which to refer to the newly provisioned
	//     storage. If a storage system supports this, it can optionally
	//     use this name as the identifier for the new volume.
	//
	// Any Unicode string that conforms to the length limit is allowed
	// except those containing the following banned characters:
	// U+0000-U+0008, U+000B, U+000C, U+000E-U+001F, U+007F-U+009F.
	// (These are control characters other than commonly used whitespace.)
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// This field is OPTIONAL. This allows the CO to specify the capacity
	// requirement of the volume to be provisioned. If not specified, the
	// Plugin MAY choose an implementation-defined capacity range. If
	// specified it MUST always be honored, even when creating volumes
	// from a source; which MAY force some backends to internally extend
	// the volume after creating it.
	CapacityRange *CapacityRange `protobuf:"bytes,2,opt,name=capacity_range,json=capacityRange,proto3" json:"capacity_range,omitempty"`
	// The capabilities that the provisioned volume MUST have. SP MUST
	// provision a volume that will satisfy ALL of the capabilities
	// specified in this list. Otherwise SP MUST return the appropriate
	// gRPC error code.
	// The Plugin MUST assume that the CO MAY use the provisioned volume
	// with ANY of the capabilities specified in this list.
	// For example, a CO MAY specify two volume capabilities: one with
	// access mode SINGLE_NODE_WRITER and another with access mode
	// MULTI_NODE_READER_ONLY. In this case, the SP MUST verify that the
	// provisioned volume can be used in either mode.
	// This also enables the CO to do early validation: If ANY of the
	// specified volume capabilities are not supported by the SP, the call
	// MUST return the appropriate gRPC error code.
	// This field is REQUIRED.
	VolumeCapabilities []*VolumeCapability `protobuf:"bytes,3,rep,name=volume_capabilities,json=volumeCapabilities,proto3" json:"volume_capabilities,omitempty"`
	// Plugin specific creation-time parameters passed in as opaque
	// key-value pairs. This field is OPTIONAL. The Plugin is responsible
	// for parsing and validating these parameters. COs will treat
	// these as opaque.
	Parameters map[string]string `` /* 161-byte string literal not displayed */
	// Secrets required by plugin to complete volume creation request.
	// This field is OPTIONAL. Refer to the `Secrets Requirements`
	// section on how to use this field.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// If specified, the new volume will be pre-populated with data from
	// this source. This field is OPTIONAL.
	VolumeContentSource *VolumeContentSource `protobuf:"bytes,6,opt,name=volume_content_source,json=volumeContentSource,proto3" json:"volume_content_source,omitempty"`
	// Specifies where (regions, zones, racks, etc.) the provisioned
	// volume MUST be accessible from.
	// An SP SHALL advertise the requirements for topological
	// accessibility information in documentation. COs SHALL only specify
	// topological accessibility information supported by the SP.
	// This field is OPTIONAL.
	// This field SHALL NOT be specified unless the SP has the
	// VOLUME_ACCESSIBILITY_CONSTRAINTS plugin capability.
	// If this field is not specified and the SP has the
	// VOLUME_ACCESSIBILITY_CONSTRAINTS plugin capability, the SP MAY
	// choose where the provisioned volume is accessible from.
	AccessibilityRequirements *TopologyRequirement `` /* 136-byte string literal not displayed */
	// Plugins MUST treat these
	// as if they take precedence over the parameters field.
	// This field SHALL NOT be specified unless the SP has the
	// MODIFY_VOLUME plugin capability.
	MutableParameters map[string]string `` /* 200-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*CreateVolumeRequest) Descriptor deprecated

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

Deprecated: Use CreateVolumeRequest.ProtoReflect.Descriptor instead.

func (*CreateVolumeRequest) GetAccessibilityRequirements added in v1.0.0

func (x *CreateVolumeRequest) GetAccessibilityRequirements() *TopologyRequirement

func (*CreateVolumeRequest) GetCapacityRange

func (x *CreateVolumeRequest) GetCapacityRange() *CapacityRange

func (*CreateVolumeRequest) GetMutableParameters added in v1.9.0

func (x *CreateVolumeRequest) GetMutableParameters() map[string]string

func (*CreateVolumeRequest) GetName

func (x *CreateVolumeRequest) GetName() string

func (*CreateVolumeRequest) GetParameters

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

func (*CreateVolumeRequest) GetSecrets added in v1.0.0

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

func (*CreateVolumeRequest) GetVolumeCapabilities

func (x *CreateVolumeRequest) GetVolumeCapabilities() []*VolumeCapability

func (*CreateVolumeRequest) GetVolumeContentSource added in v1.0.0

func (x *CreateVolumeRequest) GetVolumeContentSource() *VolumeContentSource

func (*CreateVolumeRequest) ProtoMessage

func (*CreateVolumeRequest) ProtoMessage()

func (*CreateVolumeRequest) ProtoReflect added in v1.10.0

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

func (*CreateVolumeRequest) Reset

func (x *CreateVolumeRequest) Reset()

func (*CreateVolumeRequest) String

func (x *CreateVolumeRequest) String() string

type CreateVolumeResponse

type CreateVolumeResponse struct {

	// Contains all attributes of the newly created volume that are
	// relevant to the CO along with information required by the Plugin
	// to uniquely identify the volume. This field is REQUIRED.
	Volume *Volume `protobuf:"bytes,1,opt,name=volume,proto3" json:"volume,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateVolumeResponse) Descriptor deprecated

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

Deprecated: Use CreateVolumeResponse.ProtoReflect.Descriptor instead.

func (*CreateVolumeResponse) GetVolume added in v1.0.0

func (x *CreateVolumeResponse) GetVolume() *Volume

func (*CreateVolumeResponse) ProtoMessage

func (*CreateVolumeResponse) ProtoMessage()

func (*CreateVolumeResponse) ProtoReflect added in v1.10.0

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

func (*CreateVolumeResponse) Reset

func (x *CreateVolumeResponse) Reset()

func (*CreateVolumeResponse) String

func (x *CreateVolumeResponse) String() string

type DeleteSnapshotRequest added in v1.0.0

type DeleteSnapshotRequest struct {

	// The ID of the snapshot to be deleted.
	// This field is REQUIRED.
	SnapshotId string `protobuf:"bytes,1,opt,name=snapshot_id,json=snapshotId,proto3" json:"snapshot_id,omitempty"`
	// Secrets required by plugin to complete snapshot deletion request.
	// This field is OPTIONAL. Refer to the `Secrets Requirements`
	// section on how to use this field.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*DeleteSnapshotRequest) Descriptor deprecated added in v1.0.0

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

Deprecated: Use DeleteSnapshotRequest.ProtoReflect.Descriptor instead.

func (*DeleteSnapshotRequest) GetSecrets added in v1.0.0

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

func (*DeleteSnapshotRequest) GetSnapshotId added in v1.0.0

func (x *DeleteSnapshotRequest) GetSnapshotId() string

func (*DeleteSnapshotRequest) ProtoMessage added in v1.0.0

func (*DeleteSnapshotRequest) ProtoMessage()

func (*DeleteSnapshotRequest) ProtoReflect added in v1.10.0

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

func (*DeleteSnapshotRequest) Reset added in v1.0.0

func (x *DeleteSnapshotRequest) Reset()

func (*DeleteSnapshotRequest) String added in v1.0.0

func (x *DeleteSnapshotRequest) String() string

type DeleteSnapshotResponse added in v1.0.0

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

func (*DeleteSnapshotResponse) Descriptor deprecated added in v1.0.0

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

Deprecated: Use DeleteSnapshotResponse.ProtoReflect.Descriptor instead.

func (*DeleteSnapshotResponse) ProtoMessage added in v1.0.0

func (*DeleteSnapshotResponse) ProtoMessage()

func (*DeleteSnapshotResponse) ProtoReflect added in v1.10.0

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

func (*DeleteSnapshotResponse) Reset added in v1.0.0

func (x *DeleteSnapshotResponse) Reset()

func (*DeleteSnapshotResponse) String added in v1.0.0

func (x *DeleteSnapshotResponse) String() string

type DeleteVolumeGroupSnapshotRequest added in v1.8.0

type DeleteVolumeGroupSnapshotRequest struct {

	// The ID of the group snapshot to be deleted.
	// This field is REQUIRED.
	GroupSnapshotId string `protobuf:"bytes,1,opt,name=group_snapshot_id,json=groupSnapshotId,proto3" json:"group_snapshot_id,omitempty"`
	// A list of snapshot IDs that are part of this group snapshot.
	// If SP does not need to rely on this field to delete the snapshots
	// in the group, it SHOULD check this field and report an error
	// if it has the ability to detect a mismatch.
	// Some SPs require this list to delete the snapshots in the group.
	// If SP needs to use this field to delete the snapshots in the
	// group, it MUST report an error if it has the ability to detect
	// a mismatch.
	// This field is REQUIRED.
	SnapshotIds []string `protobuf:"bytes,2,rep,name=snapshot_ids,json=snapshotIds,proto3" json:"snapshot_ids,omitempty"`
	// Secrets required by plugin to complete group snapshot deletion
	// request.
	// This field is OPTIONAL. Refer to the `Secrets Requirements`
	// section on how to use this field.
	// The secrets provided in this field SHOULD be the same for
	// all group snapshot operations on the same group snapshot.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*DeleteVolumeGroupSnapshotRequest) Descriptor deprecated added in v1.8.0

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

Deprecated: Use DeleteVolumeGroupSnapshotRequest.ProtoReflect.Descriptor instead.

func (*DeleteVolumeGroupSnapshotRequest) GetGroupSnapshotId added in v1.8.0

func (x *DeleteVolumeGroupSnapshotRequest) GetGroupSnapshotId() string

func (*DeleteVolumeGroupSnapshotRequest) GetSecrets added in v1.8.0

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

func (*DeleteVolumeGroupSnapshotRequest) GetSnapshotIds added in v1.8.0

func (x *DeleteVolumeGroupSnapshotRequest) GetSnapshotIds() []string

func (*DeleteVolumeGroupSnapshotRequest) ProtoMessage added in v1.8.0

func (*DeleteVolumeGroupSnapshotRequest) ProtoMessage()

func (*DeleteVolumeGroupSnapshotRequest) ProtoReflect added in v1.10.0

func (*DeleteVolumeGroupSnapshotRequest) Reset added in v1.8.0

func (*DeleteVolumeGroupSnapshotRequest) String added in v1.8.0

type DeleteVolumeGroupSnapshotResponse added in v1.8.0

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

func (*DeleteVolumeGroupSnapshotResponse) Descriptor deprecated added in v1.8.0

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

Deprecated: Use DeleteVolumeGroupSnapshotResponse.ProtoReflect.Descriptor instead.

func (*DeleteVolumeGroupSnapshotResponse) ProtoMessage added in v1.8.0

func (*DeleteVolumeGroupSnapshotResponse) ProtoMessage()

func (*DeleteVolumeGroupSnapshotResponse) ProtoReflect added in v1.10.0

func (*DeleteVolumeGroupSnapshotResponse) Reset added in v1.8.0

func (*DeleteVolumeGroupSnapshotResponse) String added in v1.8.0

type DeleteVolumeRequest

type DeleteVolumeRequest struct {

	// The ID of the volume to be deprovisioned.
	// This field is REQUIRED.
	VolumeId string `protobuf:"bytes,1,opt,name=volume_id,json=volumeId,proto3" json:"volume_id,omitempty"`
	// Secrets required by plugin to complete volume deletion request.
	// This field is OPTIONAL. Refer to the `Secrets Requirements`
	// section on how to use this field.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*DeleteVolumeRequest) Descriptor deprecated

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

Deprecated: Use DeleteVolumeRequest.ProtoReflect.Descriptor instead.

func (*DeleteVolumeRequest) GetSecrets added in v1.0.0

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

func (*DeleteVolumeRequest) GetVolumeId

func (x *DeleteVolumeRequest) GetVolumeId() string

func (*DeleteVolumeRequest) ProtoMessage

func (*DeleteVolumeRequest) ProtoMessage()

func (*DeleteVolumeRequest) ProtoReflect added in v1.10.0

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

func (*DeleteVolumeRequest) Reset

func (x *DeleteVolumeRequest) Reset()

func (*DeleteVolumeRequest) String

func (x *DeleteVolumeRequest) String() string

type DeleteVolumeResponse

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

func (*DeleteVolumeResponse) Descriptor deprecated

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

Deprecated: Use DeleteVolumeResponse.ProtoReflect.Descriptor instead.

func (*DeleteVolumeResponse) ProtoMessage

func (*DeleteVolumeResponse) ProtoMessage()

func (*DeleteVolumeResponse) ProtoReflect added in v1.10.0

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

func (*DeleteVolumeResponse) Reset

func (x *DeleteVolumeResponse) Reset()

func (*DeleteVolumeResponse) String

func (x *DeleteVolumeResponse) String() string

type GetCapacityRequest

type GetCapacityRequest struct {

	// If specified, the Plugin SHALL report the capacity of the storage
	// that can be used to provision volumes that satisfy ALL of the
	// specified `volume_capabilities`. These are the same
	// `volume_capabilities` the CO will use in `CreateVolumeRequest`.
	// This field is OPTIONAL.
	VolumeCapabilities []*VolumeCapability `protobuf:"bytes,1,rep,name=volume_capabilities,json=volumeCapabilities,proto3" json:"volume_capabilities,omitempty"`
	// If specified, the Plugin SHALL report the capacity of the storage
	// that can be used to provision volumes with the given Plugin
	// specific `parameters`. These are the same `parameters` the CO will
	// use in `CreateVolumeRequest`. This field is OPTIONAL.
	Parameters map[string]string `` /* 161-byte string literal not displayed */
	// If specified, the Plugin SHALL report the capacity of the storage
	// that can be used to provision volumes that in the specified
	// `accessible_topology`. This is the same as the
	// `accessible_topology` the CO returns in a `CreateVolumeResponse`.
	// This field is OPTIONAL. This field SHALL NOT be set unless the
	// plugin advertises the VOLUME_ACCESSIBILITY_CONSTRAINTS capability.
	AccessibleTopology *Topology `protobuf:"bytes,3,opt,name=accessible_topology,json=accessibleTopology,proto3" json:"accessible_topology,omitempty"`
	// contains filtered or unexported fields
}

func (*GetCapacityRequest) Descriptor deprecated

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

Deprecated: Use GetCapacityRequest.ProtoReflect.Descriptor instead.

func (*GetCapacityRequest) GetAccessibleTopology added in v1.0.0

func (x *GetCapacityRequest) GetAccessibleTopology() *Topology

func (*GetCapacityRequest) GetParameters

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

func (*GetCapacityRequest) GetVolumeCapabilities

func (x *GetCapacityRequest) GetVolumeCapabilities() []*VolumeCapability

func (*GetCapacityRequest) ProtoMessage

func (*GetCapacityRequest) ProtoMessage()

func (*GetCapacityRequest) ProtoReflect added in v1.10.0

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

func (*GetCapacityRequest) Reset

func (x *GetCapacityRequest) Reset()

func (*GetCapacityRequest) String

func (x *GetCapacityRequest) String() string

type GetCapacityResponse

type GetCapacityResponse struct {

	// The available capacity, in bytes, of the storage that can be used
	// to provision volumes. If `volume_capabilities` or `parameters` is
	// specified in the request, the Plugin SHALL take those into
	// consideration when calculating the available capacity of the
	// storage. This field is REQUIRED.
	// The value of this field MUST NOT be negative.
	AvailableCapacity int64 `protobuf:"varint,1,opt,name=available_capacity,json=availableCapacity,proto3" json:"available_capacity,omitempty"`
	// The largest size that may be used in a
	// CreateVolumeRequest.capacity_range.required_bytes field
	// to create a volume with the same parameters as those in
	// GetCapacityRequest.
	//
	// If `volume_capabilities` or `parameters` is
	// specified in the request, the Plugin SHALL take those into
	// consideration when calculating the minimum volume size of the
	// storage.
	//
	// This field is OPTIONAL. MUST NOT be negative.
	// The Plugin SHOULD provide a value for this field if it has
	// a maximum size for individual volumes and leave it unset
	// otherwise. COs MAY use it to make decision about
	// where to create volumes.
	MaximumVolumeSize *wrapperspb.Int64Value `protobuf:"bytes,2,opt,name=maximum_volume_size,json=maximumVolumeSize,proto3" json:"maximum_volume_size,omitempty"`
	// The smallest size that may be used in a
	// CreateVolumeRequest.capacity_range.limit_bytes field
	// to create a volume with the same parameters as those in
	// GetCapacityRequest.
	//
	// If `volume_capabilities` or `parameters` is
	// specified in the request, the Plugin SHALL take those into
	// consideration when calculating the maximum volume size of the
	// storage.
	//
	// This field is OPTIONAL. MUST NOT be negative.
	// The Plugin SHOULD provide a value for this field if it has
	// a minimum size for individual volumes and leave it unset
	// otherwise. COs MAY use it to make decision about
	// where to create volumes.
	MinimumVolumeSize *wrapperspb.Int64Value `protobuf:"bytes,3,opt,name=minimum_volume_size,json=minimumVolumeSize,proto3" json:"minimum_volume_size,omitempty"`
	// contains filtered or unexported fields
}

func (*GetCapacityResponse) Descriptor deprecated

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

Deprecated: Use GetCapacityResponse.ProtoReflect.Descriptor instead.

func (*GetCapacityResponse) GetAvailableCapacity

func (x *GetCapacityResponse) GetAvailableCapacity() int64

func (*GetCapacityResponse) GetMaximumVolumeSize added in v1.4.0

func (x *GetCapacityResponse) GetMaximumVolumeSize() *wrapperspb.Int64Value

func (*GetCapacityResponse) GetMinimumVolumeSize added in v1.4.0

func (x *GetCapacityResponse) GetMinimumVolumeSize() *wrapperspb.Int64Value

func (*GetCapacityResponse) ProtoMessage

func (*GetCapacityResponse) ProtoMessage()

func (*GetCapacityResponse) ProtoReflect added in v1.10.0

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

func (*GetCapacityResponse) Reset

func (x *GetCapacityResponse) Reset()

func (*GetCapacityResponse) String

func (x *GetCapacityResponse) String() string

type GetMetadataAllocatedRequest added in v1.10.0

type GetMetadataAllocatedRequest struct {

	// This is the identifier of the snapshot.
	// This field is REQUIRED.
	SnapshotId string `protobuf:"bytes,1,opt,name=snapshot_id,json=snapshotId,proto3" json:"snapshot_id,omitempty"`
	// This indicates the zero based starting byte position in the volume
	// snapshot from which the result should be computed.
	// It is intended to be used to continue a previously interrupted
	// call.
	// The CO SHOULD specify this value to be the offset of the byte
	// position immediately after the last byte of the last data range
	// received, if continuing an interrupted operation, or zero if not.
	// The SP MUST ensure that the returned response stream does not
	// contain BlockMetadata tuples that end before the requested
	// starting_offset: i.e. if S is the requested starting_offset, and
	// B0 is block_metadata[0] of the first message in the response
	// stream, then (S < B0.byte_offset + B0.size_bytes) must be true.
	// This field is REQUIRED.
	StartingOffset int64 `protobuf:"varint,2,opt,name=starting_offset,json=startingOffset,proto3" json:"starting_offset,omitempty"`
	// This is an optional parameter, and if non-zero it specifies the
	// maximum number of tuples to be returned in each
	// GetMetadataAllocatedResponse message returned by the RPC stream.
	// The plugin will determine an appropriate value if 0, and is
	// always free to send less than the requested value.
	// This field is OPTIONAL.
	MaxResults int32 `protobuf:"varint,3,opt,name=max_results,json=maxResults,proto3" json:"max_results,omitempty"`
	// Secrets required by plugin to complete the request.
	// This field is OPTIONAL. Refer to the `Secrets Requirements`
	// section on how to use this field.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

The GetMetadataAllocatedRequest message is used to solicit metadata on the allocated blocks of a snapshot: i.e. this identifies the data ranges that have valid data as they were the target of some previous write operation on the volume.

func (*GetMetadataAllocatedRequest) Descriptor deprecated added in v1.10.0

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

Deprecated: Use GetMetadataAllocatedRequest.ProtoReflect.Descriptor instead.

func (*GetMetadataAllocatedRequest) GetMaxResults added in v1.10.0

func (x *GetMetadataAllocatedRequest) GetMaxResults() int32

func (*GetMetadataAllocatedRequest) GetSecrets added in v1.10.0

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

func (*GetMetadataAllocatedRequest) GetSnapshotId added in v1.10.0

func (x *GetMetadataAllocatedRequest) GetSnapshotId() string

func (*GetMetadataAllocatedRequest) GetStartingOffset added in v1.10.0

func (x *GetMetadataAllocatedRequest) GetStartingOffset() int64

func (*GetMetadataAllocatedRequest) ProtoMessage added in v1.10.0

func (*GetMetadataAllocatedRequest) ProtoMessage()

func (*GetMetadataAllocatedRequest) ProtoReflect added in v1.10.0

func (*GetMetadataAllocatedRequest) Reset added in v1.10.0

func (x *GetMetadataAllocatedRequest) Reset()

func (*GetMetadataAllocatedRequest) String added in v1.10.0

func (x *GetMetadataAllocatedRequest) String() string

type GetMetadataAllocatedResponse added in v1.10.0

type GetMetadataAllocatedResponse struct {

	// This specifies the style used in the BlockMetadata sequence.
	// This value must be the same in all such messages returned by
	// the stream.
	// If block_metadata_type is FIXED_LENGTH, then the size_bytes field
	// of each message in the block_metadata list MUST be constant.
	// This field is REQUIRED.
	BlockMetadataType BlockMetadataType `` /* 145-byte string literal not displayed */
	// This returns the capacity of the underlying volume in bytes.
	// This value must be the same in all such messages returned by
	// the stream.
	// This field is REQUIRED.
	VolumeCapacityBytes int64 `protobuf:"varint,2,opt,name=volume_capacity_bytes,json=volumeCapacityBytes,proto3" json:"volume_capacity_bytes,omitempty"`
	// This is a list of data range tuples.
	// If the value of max_results in the GetMetadataAllocatedRequest
	// message is greater than zero, then the number of entries in this
	// list MUST be less than or equal to that value.
	// The SP MUST respect the value of starting_offset in the request.
	// The byte_offset fields of adjacent BlockMetadata messages
	// MUST be strictly increasing and messages MUST NOT overlap:
	// i.e. for any two BlockMetadata messages, A and B, if A is returned
	// before B, then (A.byte_offset + A.size_bytes <= B.byte_offset)
	// MUST be true.
	// This MUST also be true if A and B are from block_metadata lists in
	// different GetMetadataAllocatedResponse messages in the gRPC stream.
	// This field is OPTIONAL.
	BlockMetadata []*BlockMetadata `protobuf:"bytes,3,rep,name=block_metadata,json=blockMetadata,proto3" json:"block_metadata,omitempty"`
	// contains filtered or unexported fields
}

GetMetadataAllocatedResponse messages are returned in a gRPC stream. Cumulatively, they provide information on the allocated data ranges in the snapshot.

func (*GetMetadataAllocatedResponse) Descriptor deprecated added in v1.10.0

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

Deprecated: Use GetMetadataAllocatedResponse.ProtoReflect.Descriptor instead.

func (*GetMetadataAllocatedResponse) GetBlockMetadata added in v1.10.0

func (x *GetMetadataAllocatedResponse) GetBlockMetadata() []*BlockMetadata

func (*GetMetadataAllocatedResponse) GetBlockMetadataType added in v1.10.0

func (x *GetMetadataAllocatedResponse) GetBlockMetadataType() BlockMetadataType

func (*GetMetadataAllocatedResponse) GetVolumeCapacityBytes added in v1.10.0

func (x *GetMetadataAllocatedResponse) GetVolumeCapacityBytes() int64

func (*GetMetadataAllocatedResponse) ProtoMessage added in v1.10.0

func (*GetMetadataAllocatedResponse) ProtoMessage()

func (*GetMetadataAllocatedResponse) ProtoReflect added in v1.10.0

func (*GetMetadataAllocatedResponse) Reset added in v1.10.0

func (x *GetMetadataAllocatedResponse) Reset()

func (*GetMetadataAllocatedResponse) String added in v1.10.0

type GetMetadataDeltaRequest added in v1.10.0

type GetMetadataDeltaRequest struct {

	// This is the identifier of the snapshot against which changes
	// are to be computed.
	// This field is REQUIRED.
	BaseSnapshotId string `protobuf:"bytes,1,opt,name=base_snapshot_id,json=baseSnapshotId,proto3" json:"base_snapshot_id,omitempty"`
	// This is the identifier of a second snapshot in the same volume,
	// created after the base snapshot.
	// This field is REQUIRED.
	TargetSnapshotId string `protobuf:"bytes,2,opt,name=target_snapshot_id,json=targetSnapshotId,proto3" json:"target_snapshot_id,omitempty"`
	// This indicates the zero based starting byte position in the volume
	// snapshot from which the result should be computed.
	// It is intended to be used to continue a previously interrupted
	// call.
	// The CO SHOULD specify this value to be the offset of the byte
	// position immediately after the last byte of the last data range
	// received, if continuing an interrupted operation, or zero if not.
	// The SP MUST ensure that the returned response stream does not
	// contain BlockMetadata tuples that end before the requested
	// starting_offset: i.e. if S is the requested starting_offset, and
	// B0 is block_metadata[0] of the first message in the response
	// stream, then (S < B0.byte_offset + B0.size_bytes) must be true.
	// This field is REQUIRED.
	StartingOffset int64 `protobuf:"varint,3,opt,name=starting_offset,json=startingOffset,proto3" json:"starting_offset,omitempty"`
	// This is an optional parameter, and if non-zero it specifies the
	// maximum number of tuples to be returned in each
	// GetMetadataDeltaResponse message returned by the RPC stream.
	// The plugin will determine an appropriate value if 0, and is
	// always free to send less than the requested value.
	// This field is OPTIONAL.
	MaxResults int32 `protobuf:"varint,4,opt,name=max_results,json=maxResults,proto3" json:"max_results,omitempty"`
	// Secrets required by plugin to complete the request.
	// This field is OPTIONAL. Refer to the `Secrets Requirements`
	// section on how to use this field.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

The GetMetadataDeltaRequest message is used to solicit metadata on the data ranges that have changed between two snapshots.

func (*GetMetadataDeltaRequest) Descriptor deprecated added in v1.10.0

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

Deprecated: Use GetMetadataDeltaRequest.ProtoReflect.Descriptor instead.

func (*GetMetadataDeltaRequest) GetBaseSnapshotId added in v1.10.0

func (x *GetMetadataDeltaRequest) GetBaseSnapshotId() string

func (*GetMetadataDeltaRequest) GetMaxResults added in v1.10.0

func (x *GetMetadataDeltaRequest) GetMaxResults() int32

func (*GetMetadataDeltaRequest) GetSecrets added in v1.10.0

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

func (*GetMetadataDeltaRequest) GetStartingOffset added in v1.10.0

func (x *GetMetadataDeltaRequest) GetStartingOffset() int64

func (*GetMetadataDeltaRequest) GetTargetSnapshotId added in v1.10.0

func (x *GetMetadataDeltaRequest) GetTargetSnapshotId() string

func (*GetMetadataDeltaRequest) ProtoMessage added in v1.10.0

func (*GetMetadataDeltaRequest) ProtoMessage()

func (*GetMetadataDeltaRequest) ProtoReflect added in v1.10.0

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

func (*GetMetadataDeltaRequest) Reset added in v1.10.0

func (x *GetMetadataDeltaRequest) Reset()

func (*GetMetadataDeltaRequest) String added in v1.10.0

func (x *GetMetadataDeltaRequest) String() string

type GetMetadataDeltaResponse added in v1.10.0

type GetMetadataDeltaResponse struct {

	// This specifies the style used in the BlockMetadata sequence.
	// This value must be the same in all such messages returned by
	// the stream.
	// If block_metadata_type is FIXED_LENGTH, then the size_bytes field
	// of each message in the block_metadata list MUST be constant.
	// This field is REQUIRED.
	BlockMetadataType BlockMetadataType `` /* 145-byte string literal not displayed */
	// This returns the capacity of the underlying volume in bytes.
	// This value must be the same in all such messages returned by
	// the stream.
	// This field is REQUIRED.
	VolumeCapacityBytes int64 `protobuf:"varint,2,opt,name=volume_capacity_bytes,json=volumeCapacityBytes,proto3" json:"volume_capacity_bytes,omitempty"`
	// This is a list of data range tuples.
	// If the value of max_results in the GetMetadataDeltaRequest message
	// is greater than zero, then the number of entries in this list MUST
	// be less than or equal to that value.
	// The SP MUST respect the value of starting_offset in the request.
	// The byte_offset fields of adjacent BlockMetadata messages
	// MUST be strictly increasing and messages MUST NOT overlap:
	// i.e. for any two BlockMetadata messages, A and B, if A is returned
	// before B, then (A.byte_offset + A.size_bytes <= B.byte_offset)
	// MUST be true.
	// This MUST also be true if A and B are from block_metadata lists in
	// different GetMetadataDeltaResponse messages in the gRPC stream.
	// This field is OPTIONAL.
	BlockMetadata []*BlockMetadata `protobuf:"bytes,3,rep,name=block_metadata,json=blockMetadata,proto3" json:"block_metadata,omitempty"`
	// contains filtered or unexported fields
}

GetMetadataDeltaResponse messages are returned in a gRPC stream. Cumulatively, they provide information on the data ranges that have changed between the base and target snapshots specified in the GetMetadataDeltaRequest message.

func (*GetMetadataDeltaResponse) Descriptor deprecated added in v1.10.0

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

Deprecated: Use GetMetadataDeltaResponse.ProtoReflect.Descriptor instead.

func (*GetMetadataDeltaResponse) GetBlockMetadata added in v1.10.0

func (x *GetMetadataDeltaResponse) GetBlockMetadata() []*BlockMetadata

func (*GetMetadataDeltaResponse) GetBlockMetadataType added in v1.10.0

func (x *GetMetadataDeltaResponse) GetBlockMetadataType() BlockMetadataType

func (*GetMetadataDeltaResponse) GetVolumeCapacityBytes added in v1.10.0

func (x *GetMetadataDeltaResponse) GetVolumeCapacityBytes() int64

func (*GetMetadataDeltaResponse) ProtoMessage added in v1.10.0

func (*GetMetadataDeltaResponse) ProtoMessage()

func (*GetMetadataDeltaResponse) ProtoReflect added in v1.10.0

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

func (*GetMetadataDeltaResponse) Reset added in v1.10.0

func (x *GetMetadataDeltaResponse) Reset()

func (*GetMetadataDeltaResponse) String added in v1.10.0

func (x *GetMetadataDeltaResponse) String() string

type GetPluginCapabilitiesRequest added in v1.0.0

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

func (*GetPluginCapabilitiesRequest) Descriptor deprecated added in v1.0.0

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

Deprecated: Use GetPluginCapabilitiesRequest.ProtoReflect.Descriptor instead.

func (*GetPluginCapabilitiesRequest) ProtoMessage added in v1.0.0

func (*GetPluginCapabilitiesRequest) ProtoMessage()

func (*GetPluginCapabilitiesRequest) ProtoReflect added in v1.10.0

func (*GetPluginCapabilitiesRequest) Reset added in v1.0.0

func (x *GetPluginCapabilitiesRequest) Reset()

func (*GetPluginCapabilitiesRequest) String added in v1.0.0

type GetPluginCapabilitiesResponse added in v1.0.0

type GetPluginCapabilitiesResponse struct {

	// All the capabilities that the controller service supports. This
	// field is OPTIONAL.
	Capabilities []*PluginCapability `protobuf:"bytes,1,rep,name=capabilities,proto3" json:"capabilities,omitempty"`
	// contains filtered or unexported fields
}

func (*GetPluginCapabilitiesResponse) Descriptor deprecated added in v1.0.0

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

Deprecated: Use GetPluginCapabilitiesResponse.ProtoReflect.Descriptor instead.

func (*GetPluginCapabilitiesResponse) GetCapabilities added in v1.0.0

func (x *GetPluginCapabilitiesResponse) GetCapabilities() []*PluginCapability

func (*GetPluginCapabilitiesResponse) ProtoMessage added in v1.0.0

func (*GetPluginCapabilitiesResponse) ProtoMessage()

func (*GetPluginCapabilitiesResponse) ProtoReflect added in v1.10.0

func (*GetPluginCapabilitiesResponse) Reset added in v1.0.0

func (x *GetPluginCapabilitiesResponse) Reset()

func (*GetPluginCapabilitiesResponse) String added in v1.0.0

type GetPluginInfoRequest

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

func (*GetPluginInfoRequest) Descriptor deprecated

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

Deprecated: Use GetPluginInfoRequest.ProtoReflect.Descriptor instead.

func (*GetPluginInfoRequest) ProtoMessage

func (*GetPluginInfoRequest) ProtoMessage()

func (*GetPluginInfoRequest) ProtoReflect added in v1.10.0

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

func (*GetPluginInfoRequest) Reset

func (x *GetPluginInfoRequest) Reset()

func (*GetPluginInfoRequest) String

func (x *GetPluginInfoRequest) String() string

type GetPluginInfoResponse

type GetPluginInfoResponse struct {

	// The name MUST follow domain name notation format
	// (https://tools.ietf.org/html/rfc1035#section-2.3.1). It SHOULD
	// include the plugin's host company name and the plugin name,
	// to minimize the possibility of collisions. It MUST be 63
	// characters or less, beginning and ending with an alphanumeric
	// character ([a-z0-9A-Z]) with dashes (-), dots (.), and
	// alphanumerics between. This field is REQUIRED.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// This field is REQUIRED. Value of this field is opaque to the CO.
	VendorVersion string `protobuf:"bytes,2,opt,name=vendor_version,json=vendorVersion,proto3" json:"vendor_version,omitempty"`
	// This field is OPTIONAL. Values are opaque to the CO.
	Manifest map[string]string `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*GetPluginInfoResponse) Descriptor deprecated

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

Deprecated: Use GetPluginInfoResponse.ProtoReflect.Descriptor instead.

func (*GetPluginInfoResponse) GetManifest

func (x *GetPluginInfoResponse) GetManifest() map[string]string

func (*GetPluginInfoResponse) GetName

func (x *GetPluginInfoResponse) GetName() string

func (*GetPluginInfoResponse) GetVendorVersion

func (x *GetPluginInfoResponse) GetVendorVersion() string

func (*GetPluginInfoResponse) ProtoMessage

func (*GetPluginInfoResponse) ProtoMessage()

func (*GetPluginInfoResponse) ProtoReflect added in v1.10.0

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

func (*GetPluginInfoResponse) Reset

func (x *GetPluginInfoResponse) Reset()

func (*GetPluginInfoResponse) String

func (x *GetPluginInfoResponse) String() string

type GetVolumeGroupSnapshotRequest added in v1.8.0

type GetVolumeGroupSnapshotRequest struct {

	// The ID of the group snapshot to fetch current group snapshot
	// information for.
	// This field is REQUIRED.
	GroupSnapshotId string `protobuf:"bytes,1,opt,name=group_snapshot_id,json=groupSnapshotId,proto3" json:"group_snapshot_id,omitempty"`
	// A list of snapshot IDs that are part of this group snapshot.
	// If SP does not need to rely on this field to get the snapshots
	// in the group, it SHOULD check this field and report an error
	// if it has the ability to detect a mismatch.
	// Some SPs require this list to get the snapshots in the group.
	// If SP needs to use this field to get the snapshots in the
	// group, it MUST report an error if it has the ability to detect
	// a mismatch.
	// This field is REQUIRED.
	SnapshotIds []string `protobuf:"bytes,2,rep,name=snapshot_ids,json=snapshotIds,proto3" json:"snapshot_ids,omitempty"`
	// Secrets required by plugin to complete
	// GetVolumeGroupSnapshot request.
	// This field is OPTIONAL. Refer to the `Secrets Requirements`
	// section on how to use this field.
	// The secrets provided in this field SHOULD be the same for
	// all group snapshot operations on the same group snapshot.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*GetVolumeGroupSnapshotRequest) Descriptor deprecated added in v1.8.0

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

Deprecated: Use GetVolumeGroupSnapshotRequest.ProtoReflect.Descriptor instead.

func (*GetVolumeGroupSnapshotRequest) GetGroupSnapshotId added in v1.8.0

func (x *GetVolumeGroupSnapshotRequest) GetGroupSnapshotId() string

func (*GetVolumeGroupSnapshotRequest) GetSecrets added in v1.8.0

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

func (*GetVolumeGroupSnapshotRequest) GetSnapshotIds added in v1.8.0

func (x *GetVolumeGroupSnapshotRequest) GetSnapshotIds() []string

func (*GetVolumeGroupSnapshotRequest) ProtoMessage added in v1.8.0

func (*GetVolumeGroupSnapshotRequest) ProtoMessage()

func (*GetVolumeGroupSnapshotRequest) ProtoReflect added in v1.10.0

func (*GetVolumeGroupSnapshotRequest) Reset added in v1.8.0

func (x *GetVolumeGroupSnapshotRequest) Reset()

func (*GetVolumeGroupSnapshotRequest) String added in v1.8.0

type GetVolumeGroupSnapshotResponse added in v1.8.0

type GetVolumeGroupSnapshotResponse struct {

	// This field is REQUIRED
	GroupSnapshot *VolumeGroupSnapshot `protobuf:"bytes,1,opt,name=group_snapshot,json=groupSnapshot,proto3" json:"group_snapshot,omitempty"`
	// contains filtered or unexported fields
}

func (*GetVolumeGroupSnapshotResponse) Descriptor deprecated added in v1.8.0

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

Deprecated: Use GetVolumeGroupSnapshotResponse.ProtoReflect.Descriptor instead.

func (*GetVolumeGroupSnapshotResponse) GetGroupSnapshot added in v1.8.0

func (x *GetVolumeGroupSnapshotResponse) GetGroupSnapshot() *VolumeGroupSnapshot

func (*GetVolumeGroupSnapshotResponse) ProtoMessage added in v1.8.0

func (*GetVolumeGroupSnapshotResponse) ProtoMessage()

func (*GetVolumeGroupSnapshotResponse) ProtoReflect added in v1.10.0

func (*GetVolumeGroupSnapshotResponse) Reset added in v1.8.0

func (x *GetVolumeGroupSnapshotResponse) Reset()

func (*GetVolumeGroupSnapshotResponse) String added in v1.8.0

type GroupControllerClient added in v1.8.0

type GroupControllerClient interface {
	GroupControllerGetCapabilities(ctx context.Context, in *GroupControllerGetCapabilitiesRequest, opts ...grpc.CallOption) (*GroupControllerGetCapabilitiesResponse, error)
	CreateVolumeGroupSnapshot(ctx context.Context, in *CreateVolumeGroupSnapshotRequest, opts ...grpc.CallOption) (*CreateVolumeGroupSnapshotResponse, error)
	DeleteVolumeGroupSnapshot(ctx context.Context, in *DeleteVolumeGroupSnapshotRequest, opts ...grpc.CallOption) (*DeleteVolumeGroupSnapshotResponse, error)
	GetVolumeGroupSnapshot(ctx context.Context, in *GetVolumeGroupSnapshotRequest, opts ...grpc.CallOption) (*GetVolumeGroupSnapshotResponse, error)
}

GroupControllerClient is the client API for GroupController 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 NewGroupControllerClient added in v1.8.0

func NewGroupControllerClient(cc grpc.ClientConnInterface) GroupControllerClient

type GroupControllerGetCapabilitiesRequest added in v1.8.0

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

func (*GroupControllerGetCapabilitiesRequest) Descriptor deprecated added in v1.8.0

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

Deprecated: Use GroupControllerGetCapabilitiesRequest.ProtoReflect.Descriptor instead.

func (*GroupControllerGetCapabilitiesRequest) ProtoMessage added in v1.8.0

func (*GroupControllerGetCapabilitiesRequest) ProtoMessage()

func (*GroupControllerGetCapabilitiesRequest) ProtoReflect added in v1.10.0

func (*GroupControllerGetCapabilitiesRequest) Reset added in v1.8.0

func (*GroupControllerGetCapabilitiesRequest) String added in v1.8.0

type GroupControllerGetCapabilitiesResponse added in v1.8.0

type GroupControllerGetCapabilitiesResponse struct {

	// All the capabilities that the group controller service supports.
	// This field is OPTIONAL.
	Capabilities []*GroupControllerServiceCapability `protobuf:"bytes,1,rep,name=capabilities,proto3" json:"capabilities,omitempty"`
	// contains filtered or unexported fields
}

func (*GroupControllerGetCapabilitiesResponse) Descriptor deprecated added in v1.8.0

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

Deprecated: Use GroupControllerGetCapabilitiesResponse.ProtoReflect.Descriptor instead.

func (*GroupControllerGetCapabilitiesResponse) GetCapabilities added in v1.8.0

func (*GroupControllerGetCapabilitiesResponse) ProtoMessage added in v1.8.0

func (*GroupControllerGetCapabilitiesResponse) ProtoReflect added in v1.10.0

func (*GroupControllerGetCapabilitiesResponse) Reset added in v1.8.0

func (*GroupControllerGetCapabilitiesResponse) String added in v1.8.0

type GroupControllerServer added in v1.8.0

type GroupControllerServer interface {
	GroupControllerGetCapabilities(context.Context, *GroupControllerGetCapabilitiesRequest) (*GroupControllerGetCapabilitiesResponse, error)
	CreateVolumeGroupSnapshot(context.Context, *CreateVolumeGroupSnapshotRequest) (*CreateVolumeGroupSnapshotResponse, error)
	DeleteVolumeGroupSnapshot(context.Context, *DeleteVolumeGroupSnapshotRequest) (*DeleteVolumeGroupSnapshotResponse, error)
	GetVolumeGroupSnapshot(context.Context, *GetVolumeGroupSnapshotRequest) (*GetVolumeGroupSnapshotResponse, error)
	// contains filtered or unexported methods
}

GroupControllerServer is the server API for GroupController service. All implementations must embed UnimplementedGroupControllerServer for forward compatibility

type GroupControllerServiceCapability added in v1.8.0

type GroupControllerServiceCapability struct {

	// Types that are assignable to Type:
	//
	//	*GroupControllerServiceCapability_Rpc
	Type isGroupControllerServiceCapability_Type `protobuf_oneof:"type"`
	// contains filtered or unexported fields
}

Specifies a capability of the group controller service.

func (*GroupControllerServiceCapability) Descriptor deprecated added in v1.8.0

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

Deprecated: Use GroupControllerServiceCapability.ProtoReflect.Descriptor instead.

func (*GroupControllerServiceCapability) GetRpc added in v1.8.0

func (*GroupControllerServiceCapability) GetType added in v1.8.0

func (m *GroupControllerServiceCapability) GetType() isGroupControllerServiceCapability_Type

func (*GroupControllerServiceCapability) ProtoMessage added in v1.8.0

func (*GroupControllerServiceCapability) ProtoMessage()

func (*GroupControllerServiceCapability) ProtoReflect added in v1.10.0

func (*GroupControllerServiceCapability) Reset added in v1.8.0

func (*GroupControllerServiceCapability) String added in v1.8.0

type GroupControllerServiceCapability_RPC added in v1.8.0

type GroupControllerServiceCapability_RPC struct {
	Type GroupControllerServiceCapability_RPC_Type `protobuf:"varint,1,opt,name=type,proto3,enum=csi.v1.GroupControllerServiceCapability_RPC_Type" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*GroupControllerServiceCapability_RPC) Descriptor deprecated added in v1.8.0

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

Deprecated: Use GroupControllerServiceCapability_RPC.ProtoReflect.Descriptor instead.

func (*GroupControllerServiceCapability_RPC) GetType added in v1.8.0

func (*GroupControllerServiceCapability_RPC) ProtoMessage added in v1.8.0

func (*GroupControllerServiceCapability_RPC) ProtoMessage()

func (*GroupControllerServiceCapability_RPC) ProtoReflect added in v1.10.0

func (*GroupControllerServiceCapability_RPC) Reset added in v1.8.0

func (*GroupControllerServiceCapability_RPC) String added in v1.8.0

type GroupControllerServiceCapability_RPC_Type added in v1.8.0

type GroupControllerServiceCapability_RPC_Type int32
const (
	GroupControllerServiceCapability_RPC_UNKNOWN GroupControllerServiceCapability_RPC_Type = 0
	// Indicates that the group controller plugin supports
	// creating, deleting, and getting details of a volume
	// group snapshot.
	GroupControllerServiceCapability_RPC_CREATE_DELETE_GET_VOLUME_GROUP_SNAPSHOT GroupControllerServiceCapability_RPC_Type = 1
)

func (GroupControllerServiceCapability_RPC_Type) Descriptor added in v1.10.0

func (GroupControllerServiceCapability_RPC_Type) Enum added in v1.10.0

func (GroupControllerServiceCapability_RPC_Type) EnumDescriptor deprecated added in v1.8.0

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

Deprecated: Use GroupControllerServiceCapability_RPC_Type.Descriptor instead.

func (GroupControllerServiceCapability_RPC_Type) Number added in v1.10.0

func (GroupControllerServiceCapability_RPC_Type) String added in v1.8.0

func (GroupControllerServiceCapability_RPC_Type) Type added in v1.10.0

type GroupControllerServiceCapability_Rpc added in v1.8.0

type GroupControllerServiceCapability_Rpc struct {
	// RPC that the controller supports.
	Rpc *GroupControllerServiceCapability_RPC `protobuf:"bytes,1,opt,name=rpc,proto3,oneof"`
}

type IdentityClient

type IdentityClient interface {
	GetPluginInfo(ctx context.Context, in *GetPluginInfoRequest, opts ...grpc.CallOption) (*GetPluginInfoResponse, error)
	GetPluginCapabilities(ctx context.Context, in *GetPluginCapabilitiesRequest, opts ...grpc.CallOption) (*GetPluginCapabilitiesResponse, error)
	Probe(ctx context.Context, in *ProbeRequest, opts ...grpc.CallOption) (*ProbeResponse, error)
}

IdentityClient is the client API for Identity 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 NewIdentityClient

func NewIdentityClient(cc grpc.ClientConnInterface) IdentityClient

type IdentityServer

type IdentityServer interface {
	GetPluginInfo(context.Context, *GetPluginInfoRequest) (*GetPluginInfoResponse, error)
	GetPluginCapabilities(context.Context, *GetPluginCapabilitiesRequest) (*GetPluginCapabilitiesResponse, error)
	Probe(context.Context, *ProbeRequest) (*ProbeResponse, error)
	// contains filtered or unexported methods
}

IdentityServer is the server API for Identity service. All implementations must embed UnimplementedIdentityServer for forward compatibility

type ListSnapshotsRequest added in v1.0.0

type ListSnapshotsRequest struct {

	// If specified (non-zero value), the Plugin MUST NOT return more
	// entries than this number in the response. If the actual number of
	// entries is more than this number, the Plugin MUST set `next_token`
	// in the response which can be used to get the next page of entries
	// in the subsequent `ListSnapshots` call. This field is OPTIONAL. If
	// not specified (zero value), it means there is no restriction on the
	// number of entries that can be returned.
	// The value of this field MUST NOT be negative.
	MaxEntries int32 `protobuf:"varint,1,opt,name=max_entries,json=maxEntries,proto3" json:"max_entries,omitempty"`
	// A token to specify where to start paginating. Set this field to
	// `next_token` returned by a previous `ListSnapshots` call to get the
	// next page of entries. This field is OPTIONAL.
	// An empty string is equal to an unspecified field value.
	StartingToken string `protobuf:"bytes,2,opt,name=starting_token,json=startingToken,proto3" json:"starting_token,omitempty"`
	// Identity information for the source volume. This field is OPTIONAL.
	// It can be used to list snapshots by volume.
	SourceVolumeId string `protobuf:"bytes,3,opt,name=source_volume_id,json=sourceVolumeId,proto3" json:"source_volume_id,omitempty"`
	// Identity information for a specific snapshot. This field is
	// OPTIONAL. It can be used to list only a specific snapshot.
	// ListSnapshots will return with current snapshot information
	// and will not block if the snapshot is being processed after
	// it is cut.
	SnapshotId string `protobuf:"bytes,4,opt,name=snapshot_id,json=snapshotId,proto3" json:"snapshot_id,omitempty"`
	// Secrets required by plugin to complete ListSnapshot request.
	// This field is OPTIONAL. Refer to the `Secrets Requirements`
	// section on how to use this field.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

List all snapshots on the storage system regardless of how they were created.

func (*ListSnapshotsRequest) Descriptor deprecated added in v1.0.0

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

Deprecated: Use ListSnapshotsRequest.ProtoReflect.Descriptor instead.

func (*ListSnapshotsRequest) GetMaxEntries added in v1.0.0

func (x *ListSnapshotsRequest) GetMaxEntries() int32

func (*ListSnapshotsRequest) GetSecrets added in v1.2.0

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

func (*ListSnapshotsRequest) GetSnapshotId added in v1.0.0

func (x *ListSnapshotsRequest) GetSnapshotId() string

func (*ListSnapshotsRequest) GetSourceVolumeId added in v1.0.0

func (x *ListSnapshotsRequest) GetSourceVolumeId() string

func (*ListSnapshotsRequest) GetStartingToken added in v1.0.0

func (x *ListSnapshotsRequest) GetStartingToken() string

func (*ListSnapshotsRequest) ProtoMessage added in v1.0.0

func (*ListSnapshotsRequest) ProtoMessage()

func (*ListSnapshotsRequest) ProtoReflect added in v1.10.0

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

func (*ListSnapshotsRequest) Reset added in v1.0.0

func (x *ListSnapshotsRequest) Reset()

func (*ListSnapshotsRequest) String added in v1.0.0

func (x *ListSnapshotsRequest) String() string

type ListSnapshotsResponse added in v1.0.0

type ListSnapshotsResponse struct {
	Entries []*ListSnapshotsResponse_Entry `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,omitempty"`
	// This token allows you to get the next page of entries for
	// `ListSnapshots` request. If the number of entries is larger than
	// `max_entries`, use the `next_token` as a value for the
	// `starting_token` field in the next `ListSnapshots` request. This
	// field is OPTIONAL.
	// An empty string is equal to an unspecified field value.
	NextToken string `protobuf:"bytes,2,opt,name=next_token,json=nextToken,proto3" json:"next_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListSnapshotsResponse) Descriptor deprecated added in v1.0.0

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

Deprecated: Use ListSnapshotsResponse.ProtoReflect.Descriptor instead.

func (*ListSnapshotsResponse) GetEntries added in v1.0.0

func (*ListSnapshotsResponse) GetNextToken added in v1.0.0

func (x *ListSnapshotsResponse) GetNextToken() string

func (*ListSnapshotsResponse) ProtoMessage added in v1.0.0

func (*ListSnapshotsResponse) ProtoMessage()

func (*ListSnapshotsResponse) ProtoReflect added in v1.10.0

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

func (*ListSnapshotsResponse) Reset added in v1.0.0

func (x *ListSnapshotsResponse) Reset()

func (*ListSnapshotsResponse) String added in v1.0.0

func (x *ListSnapshotsResponse) String() string

type ListSnapshotsResponse_Entry added in v1.0.0

type ListSnapshotsResponse_Entry struct {
	Snapshot *Snapshot `protobuf:"bytes,1,opt,name=snapshot,proto3" json:"snapshot,omitempty"`
	// contains filtered or unexported fields
}

func (*ListSnapshotsResponse_Entry) Descriptor deprecated added in v1.0.0

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

Deprecated: Use ListSnapshotsResponse_Entry.ProtoReflect.Descriptor instead.

func (*ListSnapshotsResponse_Entry) GetSnapshot added in v1.0.0

func (x *ListSnapshotsResponse_Entry) GetSnapshot() *Snapshot

func (*ListSnapshotsResponse_Entry) ProtoMessage added in v1.0.0

func (*ListSnapshotsResponse_Entry) ProtoMessage()

func (*ListSnapshotsResponse_Entry) ProtoReflect added in v1.10.0

func (*ListSnapshotsResponse_Entry) Reset added in v1.0.0

func (x *ListSnapshotsResponse_Entry) Reset()

func (*ListSnapshotsResponse_Entry) String added in v1.0.0

func (x *ListSnapshotsResponse_Entry) String() string

type ListVolumesRequest

type ListVolumesRequest struct {

	// If specified (non-zero value), the Plugin MUST NOT return more
	// entries than this number in the response. If the actual number of
	// entries is more than this number, the Plugin MUST set `next_token`
	// in the response which can be used to get the next page of entries
	// in the subsequent `ListVolumes` call. This field is OPTIONAL. If
	// not specified (zero value), it means there is no restriction on the
	// number of entries that can be returned.
	// The value of this field MUST NOT be negative.
	MaxEntries int32 `protobuf:"varint,1,opt,name=max_entries,json=maxEntries,proto3" json:"max_entries,omitempty"`
	// A token to specify where to start paginating. Set this field to
	// `next_token` returned by a previous `ListVolumes` call to get the
	// next page of entries. This field is OPTIONAL.
	// An empty string is equal to an unspecified field value.
	StartingToken string `protobuf:"bytes,2,opt,name=starting_token,json=startingToken,proto3" json:"starting_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListVolumesRequest) Descriptor deprecated

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

Deprecated: Use ListVolumesRequest.ProtoReflect.Descriptor instead.

func (*ListVolumesRequest) GetMaxEntries

func (x *ListVolumesRequest) GetMaxEntries() int32

func (*ListVolumesRequest) GetStartingToken

func (x *ListVolumesRequest) GetStartingToken() string

func (*ListVolumesRequest) ProtoMessage

func (*ListVolumesRequest) ProtoMessage()

func (*ListVolumesRequest) ProtoReflect added in v1.10.0

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

func (*ListVolumesRequest) Reset

func (x *ListVolumesRequest) Reset()

func (*ListVolumesRequest) String

func (x *ListVolumesRequest) String() string

type ListVolumesResponse

type ListVolumesResponse struct {
	Entries []*ListVolumesResponse_Entry `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,omitempty"`
	// This token allows you to get the next page of entries for
	// `ListVolumes` request. If the number of entries is larger than
	// `max_entries`, use the `next_token` as a value for the
	// `starting_token` field in the next `ListVolumes` request. This
	// field is OPTIONAL.
	// An empty string is equal to an unspecified field value.
	NextToken string `protobuf:"bytes,2,opt,name=next_token,json=nextToken,proto3" json:"next_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListVolumesResponse) Descriptor deprecated

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

Deprecated: Use ListVolumesResponse.ProtoReflect.Descriptor instead.

func (*ListVolumesResponse) GetEntries

func (*ListVolumesResponse) GetNextToken

func (x *ListVolumesResponse) GetNextToken() string

func (*ListVolumesResponse) ProtoMessage

func (*ListVolumesResponse) ProtoMessage()

func (*ListVolumesResponse) ProtoReflect added in v1.10.0

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

func (*ListVolumesResponse) Reset

func (x *ListVolumesResponse) Reset()

func (*ListVolumesResponse) String

func (x *ListVolumesResponse) String() string

type ListVolumesResponse_Entry

type ListVolumesResponse_Entry struct {

	// This field is REQUIRED
	Volume *Volume `protobuf:"bytes,1,opt,name=volume,proto3" json:"volume,omitempty"`
	// This field is OPTIONAL. This field MUST be specified if the
	// LIST_VOLUMES_PUBLISHED_NODES controller capability is
	// supported.
	Status *ListVolumesResponse_VolumeStatus `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*ListVolumesResponse_Entry) Descriptor deprecated

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

Deprecated: Use ListVolumesResponse_Entry.ProtoReflect.Descriptor instead.

func (*ListVolumesResponse_Entry) GetStatus added in v1.2.0

func (*ListVolumesResponse_Entry) GetVolume added in v1.0.0

func (x *ListVolumesResponse_Entry) GetVolume() *Volume

func (*ListVolumesResponse_Entry) ProtoMessage

func (*ListVolumesResponse_Entry) ProtoMessage()

func (*ListVolumesResponse_Entry) ProtoReflect added in v1.10.0

func (*ListVolumesResponse_Entry) Reset

func (x *ListVolumesResponse_Entry) Reset()

func (*ListVolumesResponse_Entry) String

func (x *ListVolumesResponse_Entry) String() string

type ListVolumesResponse_VolumeStatus added in v1.2.0

type ListVolumesResponse_VolumeStatus struct {

	// A list of all `node_id` of nodes that the volume in this entry
	// is controller published on.
	// This field is OPTIONAL. If it is not specified and the SP has
	// the LIST_VOLUMES_PUBLISHED_NODES controller capability, the CO
	// MAY assume the volume is not controller published to any nodes.
	// If the field is not specified and the SP does not have the
	// LIST_VOLUMES_PUBLISHED_NODES controller capability, the CO MUST
	// not interpret this field.
	// published_node_ids MAY include nodes not published to or
	// reported by the SP. The CO MUST be resilient to that.
	PublishedNodeIds []string `protobuf:"bytes,1,rep,name=published_node_ids,json=publishedNodeIds,proto3" json:"published_node_ids,omitempty"`
	// Information about the current condition of the volume.
	// This field is OPTIONAL.
	// This field MUST be specified if the
	// VOLUME_CONDITION controller capability is supported.
	VolumeCondition *VolumeCondition `protobuf:"bytes,2,opt,name=volume_condition,json=volumeCondition,proto3" json:"volume_condition,omitempty"`
	// contains filtered or unexported fields
}

func (*ListVolumesResponse_VolumeStatus) Descriptor deprecated added in v1.2.0

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

Deprecated: Use ListVolumesResponse_VolumeStatus.ProtoReflect.Descriptor instead.

func (*ListVolumesResponse_VolumeStatus) GetPublishedNodeIds added in v1.2.0

func (x *ListVolumesResponse_VolumeStatus) GetPublishedNodeIds() []string

func (*ListVolumesResponse_VolumeStatus) GetVolumeCondition added in v1.3.0

func (x *ListVolumesResponse_VolumeStatus) GetVolumeCondition() *VolumeCondition

func (*ListVolumesResponse_VolumeStatus) ProtoMessage added in v1.2.0

func (*ListVolumesResponse_VolumeStatus) ProtoMessage()

func (*ListVolumesResponse_VolumeStatus) ProtoReflect added in v1.10.0

func (*ListVolumesResponse_VolumeStatus) Reset added in v1.2.0

func (*ListVolumesResponse_VolumeStatus) String added in v1.2.0

type NodeClient

NodeClient is the client API for Node 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 NewNodeClient

func NewNodeClient(cc grpc.ClientConnInterface) NodeClient

type NodeExpandVolumeRequest added in v1.1.0

type NodeExpandVolumeRequest 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"`
	// This allows CO to specify the capacity requirements of the volume
	// after expansion. If capacity_range is omitted then a plugin MAY
	// inspect the file system of the volume to determine the maximum
	// capacity to which the volume can be expanded. In such cases a
	// plugin MAY expand the volume to its maximum capacity.
	// This field is OPTIONAL.
	CapacityRange *CapacityRange `protobuf:"bytes,3,opt,name=capacity_range,json=capacityRange,proto3" json:"capacity_range,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,4,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 expanding the
	// filesystem in NodeExpandVolume implementation but still perform
	// rest of the housekeeping needed for expanding the volume. If
	// volume_capability is omitted the SP MAY determine
	// access_type from given volume_path for the volume and perform
	// node expansion. This is an OPTIONAL field.
	VolumeCapability *VolumeCapability `protobuf:"bytes,5,opt,name=volume_capability,json=volumeCapability,proto3" json:"volume_capability,omitempty"`
	// Secrets required by plugin to complete node expand volume request.
	// This field is OPTIONAL. Refer to the `Secrets Requirements`
	// section on how to use this field.
	Secrets map[string]string `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*NodeExpandVolumeRequest) Descriptor deprecated added in v1.1.0

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

Deprecated: Use NodeExpandVolumeRequest.ProtoReflect.Descriptor instead.

func (*NodeExpandVolumeRequest) GetCapacityRange added in v1.1.0

func (x *NodeExpandVolumeRequest) GetCapacityRange() *CapacityRange

func (*NodeExpandVolumeRequest) GetSecrets added in v1.5.0

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

func (*NodeExpandVolumeRequest) GetStagingTargetPath added in v1.2.0

func (x *NodeExpandVolumeRequest) GetStagingTargetPath() string

func (*NodeExpandVolumeRequest) GetVolumeCapability added in v1.2.0

func (x *NodeExpandVolumeRequest) GetVolumeCapability() *VolumeCapability

func (*NodeExpandVolumeRequest) GetVolumeId added in v1.1.0

func (x *NodeExpandVolumeRequest) GetVolumeId() string

func (*NodeExpandVolumeRequest) GetVolumePath added in v1.1.0

func (x *NodeExpandVolumeRequest) GetVolumePath() string

func (*NodeExpandVolumeRequest) ProtoMessage added in v1.1.0

func (*NodeExpandVolumeRequest) ProtoMessage()

func (*NodeExpandVolumeRequest) ProtoReflect added in v1.10.0

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

func (*NodeExpandVolumeRequest) Reset added in v1.1.0

func (x *NodeExpandVolumeRequest) Reset()

func (*NodeExpandVolumeRequest) String added in v1.1.0

func (x *NodeExpandVolumeRequest) String() string

type NodeExpandVolumeResponse added in v1.1.0

type NodeExpandVolumeResponse struct {

	// The capacity of the volume in bytes. This field is OPTIONAL.
	CapacityBytes int64 `protobuf:"varint,1,opt,name=capacity_bytes,json=capacityBytes,proto3" json:"capacity_bytes,omitempty"`
	// contains filtered or unexported fields
}

func (*NodeExpandVolumeResponse) Descriptor deprecated added in v1.1.0

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

Deprecated: Use NodeExpandVolumeResponse.ProtoReflect.Descriptor instead.

func (*NodeExpandVolumeResponse) GetCapacityBytes added in v1.1.0

func (x *NodeExpandVolumeResponse) GetCapacityBytes() int64

func (*NodeExpandVolumeResponse) ProtoMessage added in v1.1.0

func (*NodeExpandVolumeResponse) ProtoMessage()

func (*NodeExpandVolumeResponse) ProtoReflect added in v1.10.0

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

func (*NodeExpandVolumeResponse) Reset added in v1.1.0

func (x *NodeExpandVolumeResponse) Reset()

func (*NodeExpandVolumeResponse) String added in v1.1.0

func (x *NodeExpandVolumeResponse) String() string

type NodeGetCapabilitiesRequest

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

func (*NodeGetCapabilitiesRequest) Descriptor deprecated

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

Deprecated: Use NodeGetCapabilitiesRequest.ProtoReflect.Descriptor instead.

func (*NodeGetCapabilitiesRequest) ProtoMessage

func (*NodeGetCapabilitiesRequest) ProtoMessage()

func (*NodeGetCapabilitiesRequest) ProtoReflect added in v1.10.0

func (*NodeGetCapabilitiesRequest) Reset

func (x *NodeGetCapabilitiesRequest) Reset()

func (*NodeGetCapabilitiesRequest) String

func (x *NodeGetCapabilitiesRequest) String() string

type NodeGetCapabilitiesResponse

type NodeGetCapabilitiesResponse struct {

	// All the capabilities that the node service supports. This field
	// is OPTIONAL.
	Capabilities []*NodeServiceCapability `protobuf:"bytes,1,rep,name=capabilities,proto3" json:"capabilities,omitempty"`
	// contains filtered or unexported fields
}

func (*NodeGetCapabilitiesResponse) Descriptor deprecated

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

Deprecated: Use NodeGetCapabilitiesResponse.ProtoReflect.Descriptor instead.

func (*NodeGetCapabilitiesResponse) GetCapabilities

func (x *NodeGetCapabilitiesResponse) GetCapabilities() []*NodeServiceCapability

func (*NodeGetCapabilitiesResponse) ProtoMessage

func (*NodeGetCapabilitiesResponse) ProtoMessage()

func (*NodeGetCapabilitiesResponse) ProtoReflect added in v1.10.0

func (*NodeGetCapabilitiesResponse) Reset

func (x *NodeGetCapabilitiesResponse) Reset()

func (*NodeGetCapabilitiesResponse) String

func (x *NodeGetCapabilitiesResponse) String() string

type NodeGetInfoRequest added in v1.0.0

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

func (*NodeGetInfoRequest) Descriptor deprecated added in v1.0.0

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

Deprecated: Use NodeGetInfoRequest.ProtoReflect.Descriptor instead.

func (*NodeGetInfoRequest) ProtoMessage added in v1.0.0

func (*NodeGetInfoRequest) ProtoMessage()

func (*NodeGetInfoRequest) ProtoReflect added in v1.10.0

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