itemoperation

Documentation

Index

• type BackupOperation
  • func (in *BackupOperation) DeepCopy() *BackupOperation
  • func (in *BackupOperation) DeepCopyInto(out *BackupOperation)
• type BackupOperationSpec
  • func (in *BackupOperationSpec) DeepCopy() *BackupOperationSpec
  • func (in *BackupOperationSpec) DeepCopyInto(out *BackupOperationSpec)
• type OperationPhase
• type OperationStatus
  • func (in *OperationStatus) DeepCopy() *OperationStatus
  • func (in *OperationStatus) DeepCopyInto(out *OperationStatus)
• type RestoreOperation
  • func (in *RestoreOperation) DeepCopy() *RestoreOperation
  • func (in *RestoreOperation) DeepCopyInto(out *RestoreOperation)
• type RestoreOperationSpec
  • func (in *RestoreOperationSpec) DeepCopy() *RestoreOperationSpec
  • func (in *RestoreOperationSpec) DeepCopyInto(out *RestoreOperationSpec)

Types

type BackupOperation

type BackupOperation struct {
	Spec BackupOperationSpec `json:"spec"`

	Status OperationStatus `json:"status"`
}

BackupOperation stores information about an async item operation started by a BackupItemAction plugin (v2 or later)

func (*BackupOperation) DeepCopy

func (in *BackupOperation) DeepCopy() *BackupOperation

func (*BackupOperation) DeepCopyInto

func (in *BackupOperation) DeepCopyInto(out *BackupOperation)

type BackupOperationSpec

type BackupOperationSpec struct {
	// BackupName is the name of the Velero backup this item operation
	// is associated with.
	BackupName string `json:"backupName"`

	// BackupUID is the UID of the Velero backup this item operation
	// is associated with.
	BackupUID string `json:"backupUID"`

	// BackupItemAction is the name of the BackupItemAction plugin that started the operation
	BackupItemAction string `json:"backupItemAction"`

	// Kubernetes resource identifier for the item
	ResourceIdentifier velero.ResourceIdentifier `json:"resourceIdentifier"`

	// OperationID returned by the BIA plugin
	OperationID string `json:"operationID"`

	// Items needing to be added to the backup after all async operations have completed
	PostOperationItems []velero.ResourceIdentifier `json:"postOperationItems"`
}

func (*BackupOperationSpec) DeepCopy

func (in *BackupOperationSpec) DeepCopy() *BackupOperationSpec

func (*BackupOperationSpec) DeepCopyInto

func (in *BackupOperationSpec) DeepCopyInto(out *BackupOperationSpec)

type OperationPhase

type OperationPhase string

OperationPhase is the lifecycle phase of a Velero item operation

const (
	// OperationPhaseNew means the item operation has been created but not started
	// by the plugin
	OperationPhaseNew OperationPhase = "New"

	// OperationPhaseInProgress means the item operation has been created and started
	// by the plugin
	OperationPhaseInProgress OperationPhase = "InProgress"

	// OperationPhaseCompleted means the item operation was successfully completed
	// and can be used for restore.
	OperationPhaseCompleted OperationPhase = "Completed"

	// OperationPhaseFailed means the item operation ended with an error.
	OperationPhaseFailed OperationPhase = "Failed"
)

type OperationStatus

type OperationStatus struct {
	// Phase is the current state of the item operation.
	Phase OperationPhase `json:"phase,omitempty"`

	// Error displays the reason for a failed operation
	Error string `json:"error,omitempty"`

	// Amount of operation completed (measured in OperationUnits)
	// i.e. number of bytes transferred for a volume
	NCompleted int64 `json:"nCompleted,omitempty"`

	// Total Amount of operation (measured in OperationUnits)
	// i.e. volume size in bytes
	NTotal int64 `json:"nTotal,omitempty"`

	// Units that NCompleted,NTotal are measured in
	// i.e. "bytes"
	OperationUnits string `json:"operationUnits,omitempty"`

	// Description of progress made
	// i.e. "processing", "Current phase: Running", etc.
	Description string `json:"description,omitempty"`

	// Created records the time the item operation was created
	Created *metav1.Time `json:"created,omitempty"`

	// Started records the time the item operation was started, if known
	// +optional
	// +nullable
	Started *metav1.Time `json:"started,omitempty"`

	// Updated records the time the item operation was updated, if known.
	// +optional
	// +nullable
	Updated *metav1.Time `json:"updated,omitempty"`
}

func (*OperationStatus) DeepCopy

func (in *OperationStatus) DeepCopy() *OperationStatus

func (*OperationStatus) DeepCopyInto

func (in *OperationStatus) DeepCopyInto(out *OperationStatus)

type RestoreOperation

type RestoreOperation struct {
	Spec RestoreOperationSpec `json:"spec"`

	Status OperationStatus `json:"status"`
}

RestoreOperation stores information about an async item operation started by a RestoreItemAction plugin (v2 or later)

func (*RestoreOperation) DeepCopy

func (in *RestoreOperation) DeepCopy() *RestoreOperation

func (*RestoreOperation) DeepCopyInto

func (in *RestoreOperation) DeepCopyInto(out *RestoreOperation)

type RestoreOperationSpec

type RestoreOperationSpec struct {
	// RestoreName is the name of the Velero restore this item operation
	// is associated with.
	RestoreName string `json:"restoreName"`

	// RestoreUID is the UID of the Velero restore this item operation
	// is associated with.
	RestoreUID string `json:"restoreUID"`

	// RestoreItemAction is the name of the RestoreItemAction plugin that started the operation
	RestoreItemAction string `json:"restoreItemAction"`

	// Kubernetes resource identifier for the item
	ResourceIdentifier velero.ResourceIdentifier `json:"resourceIdentifier"`

	// OperationID returned by the RIA plugin
	OperationID string `json:"operationID"`
}

func (*RestoreOperationSpec) DeepCopy

func (in *RestoreOperationSpec) DeepCopy() *RestoreOperationSpec

func (*RestoreOperationSpec) DeepCopyInto

func (in *RestoreOperationSpec) DeepCopyInto(out *RestoreOperationSpec)