oadp

Documentation

Index

• type DPABuilder
  • func ListDataProtectionApplication(apiClient *clients.Settings, nsname string, ...) ([]*DPABuilder, error)
  • func NewDPABuilder(apiClient *clients.Settings, name, namespace string, ...) *DPABuilder
  • func PullDPA(apiClient *clients.Settings, name, nsname string) (*DPABuilder, error)
  • func (builder *DPABuilder) Create() (*DPABuilder, error)
  • func (builder *DPABuilder) Delete() error
  • func (builder *DPABuilder) Exists() bool
  • func (builder *DPABuilder) Get() (*oadpv1alpha1.DataProtectionApplication, error)
  • func (builder *DPABuilder) Update(force bool) (*DPABuilder, error)
  • func (builder *DPABuilder) WithBackupLocation(backupLocation oadpv1alpha1.BackupLocation) *DPABuilder

Types

type DPABuilder

type DPABuilder struct {
	// Backup definition, used to create the backup object.
	Definition *oadpv1alpha1.DataProtectionApplication
	// Created backup object.
	Object *oadpv1alpha1.DataProtectionApplication
	// contains filtered or unexported fields
}

DPABuilder provides a struct for backup object from the cluster and a backup definition.

func ListDataProtectionApplication

func ListDataProtectionApplication(
	apiClient *clients.Settings, nsname string, options ...runtimeClient.ListOptions) ([]*DPABuilder, error)

ListDataProtectionApplication returns dataprotectionapplication inventory in the given namespace.

func NewDPABuilder

func NewDPABuilder(
	apiClient *clients.Settings, name, namespace string, config oadpv1alpha1.ApplicationConfig) *DPABuilder

NewDPABuilder creates a new instance of DPABuilder.

func PullDPA

func PullDPA(apiClient *clients.Settings, name, nsname string) (*DPABuilder, error)

PullDPA pulls existing dataprotectionapplication from cluster.

func (*DPABuilder) Create

func (builder *DPABuilder) Create() (*DPABuilder, error)

Create makes a dataprotectionapplication according to the dataprotectionapplication definition and stores the created object in the dataprotectionapplication builder.

func (*DPABuilder) Delete

func (builder *DPABuilder) Delete() error

Delete removes the dataprotectionapplication object and resets the builder object.

func (*DPABuilder) Exists

func (builder *DPABuilder) Exists() bool

Exists checks whether the given dataprotectionapplication exists.

func (*DPABuilder) Get

func (builder *DPABuilder) Get() (*oadpv1alpha1.DataProtectionApplication, error)

Get fetches the defined dataprotectionapplication from the cluster.

func (*DPABuilder) Update

func (builder *DPABuilder) Update(force bool) (*DPABuilder, error)

Update renovates the existing dataprotectionapplication object with the dataprotectionapplication definition in builder.

func (*DPABuilder) WithBackupLocation

func (builder *DPABuilder) WithBackupLocation(backupLocation oadpv1alpha1.BackupLocation) *DPABuilder

WithBackupLocation configures the dataprotectionapplication with the specified backup location.