v1alpha1

type Bucket struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   BucketSpec   `json:"spec,omitempty"`
	Status BucketStatus `json:"status,omitempty"`
}

type BucketAccess struct {
	// SecretRef references the Secret containing the access credentials to consume a Bucket.
	SecretRef *corev1.LocalObjectReference `json:"secretRef,omitempty"`
	// Endpoint defines address of the Bucket REST-API.
	Endpoint string `json:"endpoint"`
}

type BucketClass struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// Capabilities describes the capabilities of a BucketClass.
	Capabilities corev1alpha1.ResourceList `json:"capabilities,omitempty"`
}

type BucketClassList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []BucketClass `json:"items"`
}

type BucketCondition struct {
	// Type is the type of the condition.
	Type BucketConditionType `json:"type"`
	// Status is the status of the condition.
	Status corev1.ConditionStatus `json:"status"`
	// Reason is a machine-readable indication of why the condition is in a certain state.
	Reason string `json:"reason,omitempty"`
	// Message is a human-readable explanation of why the condition has a certain reason / state.
	Message string `json:"message,omitempty"`
	// ObservedGeneration represents the .metadata.generation that the condition was set based upon.
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
	// LastTransitionTime is the last time the status of a condition has transitioned from one state to another.
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
}

type BucketConditionType string

type BucketList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Bucket `json:"items"`
}

type BucketPool struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   BucketPoolSpec   `json:"spec,omitempty"`
	Status BucketPoolStatus `json:"status,omitempty"`
}

type BucketPoolList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []BucketPool `json:"items"`
}

type BucketPoolSpec struct {
	// ProviderID identifies the BucketPool on provider side.
	ProviderID string `json:"providerID"`
	// Taints of the BucketPool. Only Buckets who tolerate all the taints
	// will land in the BucketPool.
	Taints []commonv1alpha1.Taint `json:"taints,omitempty"`
}

type BucketPoolState string

type BucketPoolStatus struct {
	// State represents the infrastructure state of a BucketPool.
	State BucketPoolState `json:"state,omitempty"`
	// AvailableBucketClasses list the references of any supported BucketClass of this pool
	AvailableBucketClasses []corev1.LocalObjectReference `json:"availableBucketClasses,omitempty"`
}

type BucketSpec struct {
	// BucketClassRef is the BucketClass of a bucket
	// If empty, an external controller has to provision the bucket.
	BucketClassRef *corev1.LocalObjectReference `json:"bucketClassRef,omitempty"`
	// BucketPoolSelector selects a suitable BucketPoolRef by the given labels.
	BucketPoolSelector map[string]string `json:"bucketPoolSelector,omitempty"`
	// BucketPoolRef indicates which BucketPool to use for a bucket.
	// If unset, the scheduler will figure out a suitable BucketPoolRef.
	BucketPoolRef *corev1.LocalObjectReference `json:"bucketPoolRef,omitempty"`
	// Tolerations define tolerations the Bucket has. Only any BucketPool whose taints
	// covered by Tolerations will be considered to host the Bucket.
	Tolerations []commonv1alpha1.Toleration `json:"tolerations,omitempty"`
}

type BucketState string

type BucketStatus struct {
	// BucketID is the provider-specific bucket ID in the format 'TYPE://BUCKET_ID'.
	BucketID string `json:"bucketID,omitempty"`
	// State represents the infrastructure state of a Bucket.
	State BucketState `json:"state,omitempty"`
	// LastStateTransitionTime is the last time the State transitioned between values.
	LastStateTransitionTime *metav1.Time `json:"lastStateTransitionTime,omitempty"`

	// Access specifies how to access a Bucket.
	// This is set by the bucket provider when the bucket is provisioned.
	Access *BucketAccess `json:"access,omitempty"`

	// Conditions are the conditions of a bucket.
	Conditions []BucketCondition `json:"conditions,omitempty"`
}

type BucketTemplateSpec struct {
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              BucketSpec `json:"spec,omitempty"`
}

type OSDataSource struct {
	// Image is an optional image to bootstrap the volume with.
	Image string `json:"image,omitempty"`

	// Architecture defines the architecture of the OS which should be used
	Architecture *string `json:"architecture,omitempty"`
}

type ResizePolicy string

type Volume struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   VolumeSpec   `json:"spec,omitempty"`
	Status VolumeStatus `json:"status,omitempty"`
}

type VolumeAccess struct {
	// SecretRef references the Secret containing the access credentials to consume a Volume.
	SecretRef *corev1.LocalObjectReference `json:"secretRef,omitempty"`
	// Driver is the name of the drive to use for this volume. Required.
	Driver string `json:"driver"`
	// Handle is the unique handle of the volume.
	Handle string `json:"handle"`
	// VolumeAttributes are attributes of the volume to use.
	VolumeAttributes map[string]string `json:"volumeAttributes,omitempty"`
}

type VolumeClass struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// Capabilities describes the capabilities of a VolumeClass.
	Capabilities corev1alpha1.ResourceList `json:"capabilities,omitempty"`
	// ResizePolicy describes the supported expansion policy of a VolumeClass.
	// If not set default to Static expansion policy.
	ResizePolicy ResizePolicy `json:"resizePolicy,omitempty"`
}

type VolumeClassList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []VolumeClass `json:"items"`
}

type VolumeCondition struct {
	// Type is the type of the condition.
	Type VolumeConditionType `json:"type"`
	// Status is the status of the condition.
	Status corev1.ConditionStatus `json:"status"`
	// Reason is a machine-readable indication of why the condition is in a certain state.
	Reason string `json:"reason,omitempty"`
	// Message is a human-readable explanation of why the condition has a certain reason / state.
	Message string `json:"message,omitempty"`
	// ObservedGeneration represents the .metadata.generation that the condition was set based upon.
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
	// LastTransitionTime is the last time the status of a condition has transitioned from one state to another.
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
}

type VolumeConditionType string

type VolumeDataSource struct {
	// VolumeSnapshotRef instructs to use the specified VolumeSnapshot as the data source.
	VolumeSnapshotRef *corev1.LocalObjectReference `json:"volumeSnapshotRef,omitempty"`
	// OSImage defines an optional os image to bootstrap the volume.
	OSImage *OSDataSource `json:"osImage,omitempty"`
}

type VolumeEncryption struct {
	// SecretRef references the Secret containing the encryption key to encrypt a Volume.
	// This secret is created by user with encryptionKey as Key and base64 encoded 256-bit encryption key as Value.
	SecretRef corev1.LocalObjectReference `json:"secretRef"`
}

type VolumeList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Volume `json:"items"`
}

type VolumePool struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   VolumePoolSpec   `json:"spec,omitempty"`
	Status VolumePoolStatus `json:"status,omitempty"`
}

type VolumePoolCondition struct {
	// Type is the type of the condition.
	Type VolumePoolConditionType `json:"type"`
	// Status is the status of the condition.
	Status corev1.ConditionStatus `json:"status"`
	// Reason is a machine-readable indication of why the condition is in a certain state.
	Reason string `json:"reason"`
	// Message is a human-readable explanation of why the condition has a certain reason / state.
	Message string `json:"message"`
	// ObservedGeneration represents the .metadata.generation that the condition was set based upon.
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
	// LastTransitionTime is the last time the status of a condition has transitioned from one state to another.
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
}

type VolumePoolConditionType string

type VolumePoolList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []VolumePool `json:"items"`
}

type VolumePoolSpec struct {
	// ProviderID identifies the VolumePool on provider side.
	ProviderID string `json:"providerID"`
	// Taints of the VolumePool. Only Volumes who tolerate all the taints
	// will land in the VolumePool.
	Taints []commonv1alpha1.Taint `json:"taints,omitempty"`
}

type VolumePoolState string

type VolumePoolStatus struct {
	State      VolumePoolState       `json:"state,omitempty"`
	Conditions []VolumePoolCondition `json:"conditions,omitempty"`
	// AvailableVolumeClasses list the references of any supported VolumeClass of this pool
	AvailableVolumeClasses []corev1.LocalObjectReference `json:"availableVolumeClasses,omitempty"`
	// Capacity represents the total resources of a machine pool.
	Capacity corev1alpha1.ResourceList `json:"capacity,omitempty"`
	// Allocatable represents the resources of a machine pool that are available for scheduling.
	Allocatable corev1alpha1.ResourceList `json:"allocatable,omitempty"`
}

type VolumeSnapshot struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   VolumeSnapshotSpec   `json:"spec,omitempty"`
	Status VolumeSnapshotStatus `json:"status,omitempty"`
}

type VolumeSnapshotList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []VolumeSnapshot `json:"items"`
}

type VolumeSnapshotSpec struct {
	// VolumeRef indicates which Volume to refer for VolumeSnapshot
	VolumeRef *corev1.LocalObjectReference `json:"volumeRef"`
}

type VolumeSnapshotState string

type VolumeSnapshotStatus struct {
	// SnapshotID is the provider-specific snapshot ID in the format 'TYPE://SNAPSHOT_ID'.
	SnapshotID string `json:"snapshotID,omitempty"`
	// State represents the storage provider state of VolumeSnapshot
	State VolumeSnapshotState `json:"state,omitempty"`
	// LastStateTransitionTime is the last time the State transitioned between values.
	LastStateTransitionTime *metav1.Time `json:"lastStateTransitionTime,omitempty"`
	// Size is the storage size used by VolumeSnapshot
	Size *resource.Quantity `json:"size,omitempty"`
}

type VolumeSpec struct {
	// VolumeClassRef is the VolumeClass of a volume
	// If empty, an external controller has to provision the volume.
	VolumeClassRef *corev1.LocalObjectReference `json:"volumeClassRef,omitempty"`
	// VolumePoolSelector selects a suitable VolumePoolRef by the given labels.
	VolumePoolSelector map[string]string `json:"volumePoolSelector,omitempty"`
	// VolumePoolRef indicates which VolumePool to use for a volume.
	// If unset, the scheduler will figure out a suitable VolumePoolRef.
	VolumePoolRef *corev1.LocalObjectReference `json:"volumePoolRef,omitempty"`
	// ClaimRef is the reference to the claiming entity of the Volume.
	ClaimRef *commonv1alpha1.LocalUIDReference `json:"claimRef,omitempty"`
	// Resources is a description of the volume's resources and capacity.
	Resources corev1alpha1.ResourceList `json:"resources,omitempty"`
	// Image is an optional image to bootstrap the volume with.
	// To be deprecated
	Image string `json:"image,omitempty"`
	// ImagePullSecretRef is an optional secret for pulling the image of a volume.
	ImagePullSecretRef *corev1.LocalObjectReference `json:"imagePullSecretRef,omitempty"`
	// Unclaimable marks the volume as unclaimable.
	Unclaimable bool `json:"unclaimable,omitempty"`
	// Tolerations define tolerations the Volume has. Only any VolumePool whose taints
	// covered by Tolerations will be considered to host the Volume.
	Tolerations []commonv1alpha1.Toleration `json:"tolerations,omitempty"`
	// Encryption is an optional field which provides attributes to encrypt Volume.
	Encryption *VolumeEncryption `json:"encryption,omitempty"`
	// DataSource contains the content to prepopulate the Volume with.
	DataSource VolumeDataSource `json:"dataSource,omitempty"`
}

type VolumeState string

type VolumeStatus struct {
	// VolumeID is the provider-specific volume ID in the format 'TYPE://VOLUME_ID'.
	VolumeID string `json:"volumeID,omitempty"`
	// State represents the infrastructure state of a Volume.
	State VolumeState `json:"state,omitempty"`
	// LastStateTransitionTime is the last time the State transitioned between values.
	LastStateTransitionTime *metav1.Time `json:"lastStateTransitionTime,omitempty"`

	// Access specifies how to access a Volume.
	// This is set by the volume provider when the volume is provisioned.
	Access *VolumeAccess `json:"access,omitempty"`

	// Conditions are the conditions of a volume.
	Conditions []VolumeCondition `json:"conditions,omitempty"`

	// Resources is a effective volume's resources.
	Resources corev1alpha1.ResourceList `json:"resources,omitempty"`
}

type VolumeTemplateSpec struct {
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              VolumeSpec `json:"spec,omitempty"`
}