v1alpha1

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API.

Index

• Constants
• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• func VersionResource(resource string) schema.GroupVersionResource
• type ChangedBlockRange
  • func (in *ChangedBlockRange) DeepCopy() *ChangedBlockRange
  • func (in *ChangedBlockRange) DeepCopyInto(out *ChangedBlockRange)
  • func (in *ChangedBlockRange) DeepCopyObject() runtime.Object
• type ChangedBlockRangeList
  • func (in *ChangedBlockRangeList) DeepCopy() *ChangedBlockRangeList
  • func (in *ChangedBlockRangeList) DeepCopyInto(out *ChangedBlockRangeList)
  • func (in *ChangedBlockRangeList) DeepCopyObject() runtime.Object
• type ChangedBlockRangeSpec
• type ChangedBlockRangeStatus

Constants

const (
	// ChangedBlockRangeStatePending defines the 'pending' state.
	ChangedBlockRangeStatePending = "pending"

	// ChangedBlockRangeStateReady defines the 'ready' state.
	ChangedBlockRangeStateReady = "ready"

	// ChangedBlockRangeStateFailed defines the 'failed' state.
	ChangedBlockRangeStateFailed = "failed"
)

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{
		Group:   cbt.GroupName,
		Version: "v1alpha1",
	}

	// SchemeBuilder handles all scheme-related functions.
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)

	// AddToScheme is used to add new scheme to SchemeBuilder.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind converts the given 'kind' into the CBT GroupKind object.

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource.

func VersionResource

func VersionResource(resource string) schema.GroupVersionResource

VersionResource converts the given 'resource' into the CBT GroupVersionResource.

Types

type ChangedBlockRange

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

	// Spec of the ChangedBlockRange resource.
	Spec *ChangedBlockRangeSpec `json:"spec,omitempty"`

	// Status of the ChangedBlockRange resource.
	Status *ChangedBlockRangeStatus `json:"status,omitempty"`
}

ChangedBlockRange represents the range of changed blocks between two block volume snapshots.

func (*ChangedBlockRange) DeepCopy

func (in *ChangedBlockRange) DeepCopy() *ChangedBlockRange

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChangedBlockRange.

func (*ChangedBlockRange) DeepCopyInto

func (in *ChangedBlockRange) DeepCopyInto(out *ChangedBlockRange)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ChangedBlockRange) DeepCopyObject

func (in *ChangedBlockRange) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ChangedBlockRangeList

type ChangedBlockRangeList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []ChangedBlockRange `json:"items"`
}

ChangedBlockRangeList represents a list of ChangedBlockRange resources.

func (*ChangedBlockRangeList) DeepCopy

func (in *ChangedBlockRangeList) DeepCopy() *ChangedBlockRangeList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChangedBlockRangeList.

func (*ChangedBlockRangeList) DeepCopyInto

func (in *ChangedBlockRangeList) DeepCopyInto(out *ChangedBlockRangeList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ChangedBlockRangeList) DeepCopyObject

func (in *ChangedBlockRangeList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ChangedBlockRangeSpec

type ChangedBlockRangeSpec struct {
	// The name of the base volume snapshot to use for comparison.
	// If not specified, return all changed blocks.
	// +optional
	FromVolumeSnapshotName string `json:"fromVolumeSnapshotName,omitempty"`

	// The name of the target volume snapshot to use for comparison.
	// Required.
	ToVolumeSnapshotName string `json:"toVolumeSnapshotName"`

	// The number of bytes of CBT entries return should not exceed this limit.
	// +optional
	MaxSizeInBytes uint64 `json:"maxSizeInbytes"`
}

ChangedBlockRangeSpec defines the desired state of ChangedBlockRange.

type ChangedBlockRangeStatus

type ChangedBlockRangeStatus struct {
	// The number of entries found.
	// Required.
	EntryCount uint64 `json:"entryCount"`

	// The block size, which is usually some constant returned by the provider.
	// Required.
	BlockSize uint64 `json:"blockSize"`

	// The number of bytes written by the volume populator to the CBT persistent
	// persistent volume.
	NumBytesWritten uint64 `json:"numBytesWritten"`

	// Human readable messages such as warnings and errors from processing the
	// request.
	// +optional
	Message string `json:"message,omitempty"`

	// The latest state of the request: "pending", "ready", or "failed".
	// Required.
	State string `json:"state,omitempty"`
}

ChangedBlockRangeStatus defines the observed state of ChangedBlockRange.