v1

package
v0.0.0-...-25b1e04 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 30, 2025 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package v1 contains the v1 group Sample resources of the anynines provider. +kubebuilder:object:generate=true +groupName=dataservices.anynines.com +versionName=v1

Index

Constants

View Source 
const (
	// StatusQueued is the status that the a9s Backup Manager returns when queried about a backup
	// that is queued for execution but hasn't begun yet.
	StatusQueued = "queued"

	// StatusRunning is the status that the a9s Backup Manager returns when queried about a backup
	// that is currently being executed.
	StatusRunning = "running"

	// StatusDone is the status that the a9s Backup Manager returns when queried about a backup that
	// has been successfully executed.
	StatusDone = "done"

	// StatusFailed is the status that the a9s Backup Manager returns when queried about a backup
	// whose execution was not successful.
	StatusFailed = "failed"

	// StatusDeleted is the status that the a9s Backup Manager returns when queried about a backup
	// whose backup file has been deleted.
	// This means the metadata of the backup is still intact on the a9s Backup Manager but the
	// contents of the backup have been removed from the cloud storage where it was hosted.
	StatusDeleted = "deleted"
)
View Source 
const (
	Group   = "dataservices.anynines.com"
	Version = "v1"
)

Package type metadata.

Variables

View Source 
var (
	BackupKind             = reflect.TypeOf(Backup{}).Name()
	BackupGroupKind        = schema.GroupKind{Group: Group, Kind: BackupKind}.String()
	BackupKindAPIVersion   = BackupKind + "." + SchemeGroupVersion.String()
	BackupGroupVersionKind = SchemeGroupVersion.WithKind(BackupKind)
)

Backup type metadata.

View Source 
var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: Group, Version: Version}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}
)

Functions

This section is empty.

Types

type Backup 

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

	Spec   BackupSpec   `json:"spec"`
	Status BackupStatus `json:"status,omitempty"`
}

A Backup is an example API type. +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="EXTERNAL-NAME",type="string",JSONPath=".metadata.annotations.crossplane\\.io/external-name" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,anynines}

func (*Backup) DeepCopy 

func (in *Backup) DeepCopy() *Backup

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

func (*Backup) DeepCopyInto 

func (in *Backup) DeepCopyInto(out *Backup)

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

func (*Backup) DeepCopyObject 

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

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

func (*Backup) GetCondition 

func (mg *Backup) GetCondition(ct xpv1.ConditionType) xpv1.Condition

GetCondition of this Backup.

func (*Backup) GetDeletionPolicy 

func (mg *Backup) GetDeletionPolicy() xpv1.DeletionPolicy

GetDeletionPolicy of this Backup.

func (*Backup) GetManagementPolicies 

func (mg *Backup) GetManagementPolicies() xpv1.ManagementPolicies

GetManagementPolicies of this Backup.

func (*Backup) GetProviderConfigReference 

func (mg *Backup) GetProviderConfigReference() *xpv1.Reference

GetProviderConfigReference of this Backup.

func (*Backup) GetPublishConnectionDetailsTo 

func (mg *Backup) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo

GetPublishConnectionDetailsTo of this Backup.

func (*Backup) GetWriteConnectionSecretToReference 

func (mg *Backup) GetWriteConnectionSecretToReference() *xpv1.SecretReference

GetWriteConnectionSecretToReference of this Backup.

func (*Backup) SetConditions 

func (mg *Backup) SetConditions(c ...xpv1.Condition)

SetConditions of this Backup.

func (*Backup) SetDeletionPolicy 

func (mg *Backup) SetDeletionPolicy(r xpv1.DeletionPolicy)

SetDeletionPolicy of this Backup.

func (*Backup) SetManagementPolicies 

func (mg *Backup) SetManagementPolicies(r xpv1.ManagementPolicies)

SetManagementPolicies of this Backup.

func (*Backup) SetProviderConfigReference 

func (mg *Backup) SetProviderConfigReference(r *xpv1.Reference)

SetProviderConfigReference of this Backup.

func (*Backup) SetPublishConnectionDetailsTo 

func (mg *Backup) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)

SetPublishConnectionDetailsTo of this Backup.

func (*Backup) SetWriteConnectionSecretToReference 

func (mg *Backup) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)

SetWriteConnectionSecretToReference of this Backup.

type BackupList 

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

BackupList contains a list of Backup

func (*BackupList) DeepCopy 

func (in *BackupList) DeepCopy() *BackupList

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

func (*BackupList) DeepCopyInto 

func (in *BackupList) DeepCopyInto(out *BackupList)

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

func (*BackupList) DeepCopyObject 

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

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

func (*BackupList) GetItems 

func (l *BackupList) GetItems() []resource.Managed

GetItems of this BackupList.

func (*BackupList) ToBackup 

func (b *BackupList) ToBackup(name string, errMsg string) (*Backup, error)

type BackupObservation 

type BackupObservation struct {
	// InstanceID is the ID of the data service instance to take a backup from.
	InstanceID string `json:"instanceId,omitempty"`

	// BackupID is the numeric identifier that the a9s Backup Manager assigned to this specific
	// backup, e.g. 123456. It is used when communicating with the a9s Backup Manager.
	BackupID *int `json:"id,omitempty"`

	// SizeInBytes is the size of the backup in bytes. It is passed without a unit identifier, e.g.
	// 1000 is passed for a backup that is one kilobyte big.
	SizeInBytes uint64 `json:"size,omitempty"`

	// Status is the status of the backup as returned by the a9s Backup Manager. Can be "queued",
	// "running", "done", "failed" or "deleted".
	Status string `json:"status,omitempty"`

	// TriggeredAt is the timestamp from when the backup was triggered in the format
	// "YYYY-MM-DDThh:mm:ss.sssZ", e.g. "2023-05-01T01:30:00.742Z"
	TriggeredAt string `json:"triggered_at,omitempty"`

	// FinishedAt is the timestamp from when the backup was finished in the format
	// "YYYY-MM-DDThh:mm:ss.sssZ", e.g. "2023-05-01T01:30:28.300Z"
	FinishedAt string `json:"finished_at,omitempty"`

	// Downloadable indicates whether the the files that constitute this backup can be downloaded
	// from the cloud storage provider where it is hosted or not.
	// This is only true if a user has updated the credentials of the data service instance from
	// which this backup was taken at least once and the backup this observation belongs to was
	// taken after the last credential change for the instance.
	Downloadable bool `json:"downloadable,omitempty"`
}

BackupObservation are the observable fields of a Backup.

func (*BackupObservation) DeepCopy 

func (in *BackupObservation) DeepCopy() *BackupObservation

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

func (*BackupObservation) DeepCopyInto 

func (in *BackupObservation) DeepCopyInto(out *BackupObservation)

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

type BackupParameters 

type BackupParameters struct {
	// InstanceName is the name of the data service instance to take a backup from.
	InstanceName string `json:"instanceName"`

	// EncryptionKey is the key used to encrypt backups.
	EncryptionKey string `json:"encryption_key,omitempty"`

	// ExcludeFromAutoBackup indicates whether the data service instance will be
	// excluded from the backup schedule.
	// https://docs.anynines.com/docs/35.0.0/platform-operator/a9s-backup-service/a9s-po-backup-service-backup-process#regular-backup-cycle
	ExcludeFromAutoBackup *bool `json:"exclude_from_auto_backup,omitempty"`

	// CredentialsUpdatedByUser indicates whether credentials are updated by the user.
	CredentialsUpdatedByUser *bool `json:"credentials_updated_by_user,omitempty"`
}

BackupParameters are the configurable fields of a Backup.

func (*BackupParameters) DeepCopy 

func (in *BackupParameters) DeepCopy() *BackupParameters

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

func (*BackupParameters) DeepCopyInto 

func (in *BackupParameters) DeepCopyInto(out *BackupParameters)

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

type BackupSpec 

type BackupSpec struct {
	xpv1.ResourceSpec `json:",inline"`
	ForProvider       BackupParameters `json:"forProvider"`
}

A BackupSpec defines the desired state of a Backup.

func (*BackupSpec) DeepCopy 

func (in *BackupSpec) DeepCopy() *BackupSpec

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

func (*BackupSpec) DeepCopyInto 

func (in *BackupSpec) DeepCopyInto(out *BackupSpec)

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

type BackupStatus 

type BackupStatus struct {
	xpv1.ResourceStatus `json:",inline"`
	AtProvider          BackupObservation `json:"atProvider,omitempty"`
}

A BackupStatus represents the observed state of a Backup.

func (*BackupStatus) DeepCopy 

func (in *BackupStatus) DeepCopy() *BackupStatus

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

func (*BackupStatus) DeepCopyInto 

func (in *BackupStatus) DeepCopyInto(out *BackupStatus)

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.