volume

type CnsSnapshotInfo struct {
	SnapshotID                string
	SourceVolumeID            string
	SnapshotDescription       string
	SnapshotCreationTimestamp time.Time
}

type CnsVolumeInfo struct {
	DatastoreURL string
	VolumeID     cnstypes.CnsVolumeId
}

type CreateVolumeExtraParams struct {
	VolSizeBytes                         int64
	StorageClassName                     string
	Namespace                            string
	IsPodVMOnStretchSupervisorFSSEnabled bool
}

type ExpandVolumeExtraParams struct {
	StorageClassName string
	StoragePolicyID  string
	Namespace        string
	// Capacity stores the original volume size which is from CNSVolumeInfo
	Capacity                             *resource.Quantity
	IsPodVMOnStretchSupervisorFSSEnabled bool
}

type InMemoryMapIf interface {
	// Upsert : if task exists in the map, the taskDetails will be overwritten.
	// if the task doesn't exist, the taskDetails will be stored
	Upsert(types.ManagedObjectReference, TaskDetails)
	// Delete task from map
	Delete(types.ManagedObjectReference)
	// Get retrieves a single item from a map
	Get(types.ManagedObjectReference) (TaskDetails, bool)
	// GetAll retrieves all map items
	GetAll() []TaskDetails
	// Count returns the count of all items present in the map
	Count() int
}

type ListViewIf interface {
	// AddTask adds task to listView and the internal map
	AddTask(ctx context.Context, taskMoRef types.ManagedObjectReference, ch chan TaskResult) error
	// RemoveTask removes task from listview and the internal map
	RemoveTask(ctx context.Context, taskMoRef types.ManagedObjectReference) error
	// SetVirtualCenter is a setter method for the reference to the global vcenter object.
	// use case: ReloadConfiguration
	SetVirtualCenter(ctx context.Context, virtualCenter *cnsvsphere.VirtualCenter)
	// LogoutSession logout the vCenter Session
	LogoutSession(ctx context.Context) error
	// MarkTaskForDeletion marks a given task MoRef for deletion by a cleanup goroutine
	// use case: failure to remove task due to a vc issue
	MarkTaskForDeletion(ctx context.Context, taskMoRef types.ManagedObjectReference) error
}

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

type Manager interface {
	// CreateVolume creates a new volume given its spec.
	// When CreateVolume failed, the second return value (faultType) and third return value(error) need to be set, and
	// should not be nil.
	// extraParams can be used to send in any values not present in the CnsVolumeCreateSpec param.
	CreateVolume(ctx context.Context, spec *cnstypes.CnsVolumeCreateSpec, extraParams interface{}) (
		*CnsVolumeInfo, string, error)
	// AttachVolume attaches a volume to a virtual machine given the spec.
	// When AttachVolume failed, the second return value (faultType) and third return value(error) need to be set, and
	// should not be nil.
	AttachVolume(ctx context.Context, vm *cnsvsphere.VirtualMachine,
		volumeID string, checkNVMeController bool) (string, string, error)
	// DetachVolume detaches a volume from the virtual machine given the spec.
	// When DetachVolume failed, the first return value (faultType) and second return value(error) need to be set, and
	// should not be nil.
	DetachVolume(ctx context.Context, vm *cnsvsphere.VirtualMachine, volumeID string) (string, error)
	// DeleteVolume deletes a volume given its spec.
	// When DeleteVolume failed, the first return value (faultType) and second return value(error) need to be set, and
	// should not be nil.
	DeleteVolume(ctx context.Context, volumeID string, deleteDisk bool) (string, error)
	// UpdateVolumeMetadata updates a volume metadata given its spec.
	UpdateVolumeMetadata(ctx context.Context, spec *cnstypes.CnsVolumeMetadataUpdateSpec) error
	// QueryVolumeInfo calls the CNS QueryVolumeInfo API and return a task, from
	// which CnsQueryVolumeInfoResult is extracted.
	QueryVolumeInfo(ctx context.Context, volumeIDList []cnstypes.CnsVolumeId) (*cnstypes.CnsQueryVolumeInfoResult, error)
	// QueryAllVolume returns all volumes matching the given filter and selection.
	QueryAllVolume(ctx context.Context, queryFilter cnstypes.CnsQueryFilter,
		querySelection cnstypes.CnsQuerySelection) (*cnstypes.CnsQueryResult, error)
	// QueryVolumeAsync returns CnsQueryResult matching the given filter by using
	// CnsQueryAsync API. QueryVolumeAsync takes querySelection spec, which helps
	// to specify which fields have to be returned for the query entities. All
	// volume fields would be returned as part of the CnsQueryResult, if the
	// querySelection parameters are not specified.
	QueryVolumeAsync(ctx context.Context, queryFilter cnstypes.CnsQueryFilter,
		querySelection *cnstypes.CnsQuerySelection) (*cnstypes.CnsQueryResult, error)
	// QueryVolume returns volumes matching the given filter.
	QueryVolume(ctx context.Context, queryFilter cnstypes.CnsQueryFilter) (*cnstypes.CnsQueryResult, error)
	// RelocateVolume migrates volumes to their target datastore as specified in relocateSpecList.
	RelocateVolume(ctx context.Context, relocateSpecList ...cnstypes.BaseCnsVolumeRelocateSpec) (*object.Task, error)
	// ExpandVolume expands a volume to a new size.
	// When ExpandVolume failed, the first return value (faultType) and second return value(error) need to be set, and
	// should not be nil.
	ExpandVolume(ctx context.Context, volumeID string, size int64, extraParams interface{}) (string, error)
	// ResetManager helps set new manager instance and VC configuration.
	ResetManager(ctx context.Context, vcenter *cnsvsphere.VirtualCenter) error
	// ConfigureVolumeACLs configures net permissions for a given CnsVolumeACLConfigureSpec.
	ConfigureVolumeACLs(ctx context.Context, spec cnstypes.CnsVolumeACLConfigureSpec) error
	// RegisterDisk registers virtual disks as FCDs using Vslm endpoint.
	RegisterDisk(ctx context.Context, path string, name string) (string, error)
	// RetrieveVStorageObject helps in retreiving virtual disk information for a given volume id.
	RetrieveVStorageObject(ctx context.Context, volumeID string) (*vim25types.VStorageObject, error)
	// ProtectVolumeFromVMDeletion sets keepAfterDeleteVm control flag on migrated volume
	ProtectVolumeFromVMDeletion(ctx context.Context, volumeID string) error
	// CreateSnapshot helps create a snapshot for a block volume
	CreateSnapshot(ctx context.Context, volumeID string, desc string) (*CnsSnapshotInfo, error)
	// DeleteSnapshot helps delete a snapshot for a block volume
	DeleteSnapshot(ctx context.Context, volumeID string, snapshotID string) error
	// QuerySnapshots retrieves the list of snapshots based on the query filter.
	QuerySnapshots(ctx context.Context, snapshotQueryFilter cnstypes.CnsSnapshotQueryFilter) (
		*cnstypes.CnsSnapshotQueryResult, error)
	// MonitorCreateVolumeTask monitors the CNS task which is created for volume creation
	// as part of volume idempotency feature
	MonitorCreateVolumeTask(ctx context.Context,
		volumeOperationDetails **cnsvolumeoperationrequest.VolumeOperationRequestDetails, task *object.Task,
		volNameFromInputSpec, clusterID string) (*CnsVolumeInfo,
		string, error)
	// GetOperationStore returns the VolumeOperationRequest interface
	GetOperationStore() cnsvolumeoperationrequest.VolumeOperationRequest
	// LogoutListViewVCSession logout current vCenter session for list-view
	LogoutListViewVCSession(ctx context.Context) error
}

type TaskDetails struct {
	Reference types.ManagedObjectReference
	// MarkedForRemoval helps in retrying the removal of tasks in case of failures
	MarkedForRemoval bool
	// channel to return results. the caller (CSI op) is waiting on this channel
	ResultCh chan TaskResult
}

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

type TaskResult struct {
	TaskInfo *types.TaskInfo
	Err      error
}