package v1

// VolumeSnapshotClass specifies parameters that a underlying storage system uses when
// creating a volume snapshot. A specific VolumeSnapshotClass is used by specifying its
// name in a VolumeSnapshot object.
// VolumeSnapshotClasses are non-namespaced
#VolumeSnapshotClass: {
	_embeddedResource

	// APIVersion defines the versioned schema of this representation of an object.
	// Servers should convert recognized schemas to the latest internal value, and
	// may reject unrecognized values.
	// More info:
	// https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
	apiVersion?: string

	// deletionPolicy determines whether a VolumeSnapshotContent created through
	// the VolumeSnapshotClass should be deleted when its bound VolumeSnapshot is deleted.
	// Supported values are "Retain" and "Delete".
	// "Retain" means that the VolumeSnapshotContent and its physical snapshot on
	// underlying storage system are kept.
	// "Delete" means that the VolumeSnapshotContent and its physical snapshot on
	// underlying storage system are deleted.
	// Required.
	deletionPolicy!: "Delete" | "Retain"

	// driver is the name of the storage driver that handles this VolumeSnapshotClass.
	// Required.
	driver!: string

	// Kind is a string value representing the REST resource this object represents.
	// Servers may infer this from the endpoint the client submits requests to.
	// Cannot be updated.
	// In CamelCase.
	// More info:
	// https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
	kind?:     string
	metadata?: {}

	// parameters is a key-value map with storage driver specific parameters for creating snapshots.
	// These values are opaque to Kubernetes.
	parameters?: [string]: string

	_embeddedResource: {
		apiVersion!: string
		kind!:       string
		metadata?:   {...}
	}
	apiVersion: "snapshot.storage.k8s.io/v1"
	kind:       "VolumeSnapshotClass"
	metadata!: {
		name!:      string
		namespace?: string
		labels?: [string]:      string
		annotations?: [string]: string
		...
	}
}