Documentation ¶
Overview ¶
Package v1 contains the v1 version of the restore.anynines.crossplane.io API group, which describes Restore API objects backed by the anynines provider.
A Restore is a request to use a previously taken Backup(whose API type is defined in apis/backup) to restore a Data Service Instance to the state contained in the Backup.
+kubebuilder:object:generate=true +groupName=dataservices.anynines.com +versionName=v1
Index ¶
- Constants
- Variables
- type Restore
- func (in *Restore) DeepCopy() *Restore
- func (in *Restore) DeepCopyInto(out *Restore)
- func (in *Restore) DeepCopyObject() runtime.Object
- func (mg *Restore) GetCondition(ct xpv1.ConditionType) xpv1.Condition
- func (mg *Restore) GetDeletionPolicy() xpv1.DeletionPolicy
- func (mg *Restore) GetManagementPolicies() xpv1.ManagementPolicies
- func (mg *Restore) GetProviderConfigReference() *xpv1.Reference
- func (mg *Restore) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
- func (mg *Restore) GetWriteConnectionSecretToReference() *xpv1.SecretReference
- func (mg *Restore) SetConditions(c ...xpv1.Condition)
- func (mg *Restore) SetDeletionPolicy(r xpv1.DeletionPolicy)
- func (mg *Restore) SetManagementPolicies(r xpv1.ManagementPolicies)
- func (mg *Restore) SetProviderConfigReference(r *xpv1.Reference)
- func (mg *Restore) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
- func (mg *Restore) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
- type RestoreList
- type RestoreObservation
- type RestoreParameters
- type RestoreSpec
- type RestoreStatus
Constants ¶
const ( Group = "dataservices.anynines.com" Version = "v1" )
Package type metadata.
const ( // StatusQueued is the status that the a9s Backup Manager returns when queried about a restore // 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 restore // that is currently being executed. StatusRunning = "running" // StatusDone is the status that the a9s Backup Manager returns when queried about a restore that // has been successfully executed. StatusDone = "done" // StatusFailed is the status that the a9s Backup Manager returns when queried about a restore // whose execution was not successful. StatusFailed = "failed" // StatusDeleted is the status that the a9s Backup Manager returns when queried about a restore // which was deleted. StatusDeleted = "deleted" )
Variables ¶
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} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
var ( RestoreKind = reflect.TypeOf(Restore{}).Name() RestoreGroupKind = schema.GroupKind{Group: Group, Kind: RestoreKind}.String() RestoreKindAPIVersion = RestoreKind + "." + SchemeGroupVersion.String() RestoreGroupVersionKind = SchemeGroupVersion.WithKind(RestoreKind) )
Restore type metadata.
Functions ¶
This section is empty.
Types ¶
type Restore ¶
type Restore struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec RestoreSpec `json:"spec"` Status RestoreStatus `json:"status,omitempty"` }
A Restore is a request to use a previously taken Backup to restore a Data Service Instance to the state contained in the Backup. +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 (*Restore) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Restore.
func (*Restore) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Restore) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Restore) GetCondition ¶
func (mg *Restore) GetCondition(ct xpv1.ConditionType) xpv1.Condition
GetCondition of this Restore.
func (*Restore) GetDeletionPolicy ¶
func (mg *Restore) GetDeletionPolicy() xpv1.DeletionPolicy
GetDeletionPolicy of this Restore.
func (*Restore) GetManagementPolicies ¶
func (mg *Restore) GetManagementPolicies() xpv1.ManagementPolicies
GetManagementPolicies of this Restore.
func (*Restore) GetProviderConfigReference ¶
GetProviderConfigReference of this Restore.
func (*Restore) GetPublishConnectionDetailsTo ¶
func (mg *Restore) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
GetPublishConnectionDetailsTo of this Restore.
func (*Restore) GetWriteConnectionSecretToReference ¶
func (mg *Restore) GetWriteConnectionSecretToReference() *xpv1.SecretReference
GetWriteConnectionSecretToReference of this Restore.
func (*Restore) SetConditions ¶
SetConditions of this Restore.
func (*Restore) SetDeletionPolicy ¶
func (mg *Restore) SetDeletionPolicy(r xpv1.DeletionPolicy)
SetDeletionPolicy of this Restore.
func (*Restore) SetManagementPolicies ¶
func (mg *Restore) SetManagementPolicies(r xpv1.ManagementPolicies)
SetManagementPolicies of this Restore.
func (*Restore) SetProviderConfigReference ¶
SetProviderConfigReference of this Restore.
func (*Restore) SetPublishConnectionDetailsTo ¶
func (mg *Restore) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
SetPublishConnectionDetailsTo of this Restore.
func (*Restore) SetWriteConnectionSecretToReference ¶
func (mg *Restore) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
SetWriteConnectionSecretToReference of this Restore.
type RestoreList ¶
type RestoreList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Restore `json:"items"` }
RestoreList contains a list of Restore
func (*RestoreList) DeepCopy ¶
func (in *RestoreList) DeepCopy() *RestoreList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RestoreList.
func (*RestoreList) DeepCopyInto ¶
func (in *RestoreList) DeepCopyInto(out *RestoreList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RestoreList) DeepCopyObject ¶
func (in *RestoreList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*RestoreList) GetItems ¶
func (l *RestoreList) GetItems() []resource.Managed
GetItems of this RestoreList.
type RestoreObservation ¶
type RestoreObservation struct { // InstanceID is the ID of a data service instance on which // restore should be performed. InstanceID string `json:"instanceId,omitempty"` // BackupID is the ID of a data service instance backup to use for the restore. BackupID *int `json:"backupId,omitempty"` // RestoreID represents the restore ID of a data service instance. RestoreID *int `json:"restoreId,omitempty"` // State represents the status of a restore on a data service instance // e.g. queued, running, done, failed, deleted. // +kubebuilder:validation:Enum:=queued;running;done;failed;deleted State string `json:"state,omitempty"` // TriggeredAt represents the timestamp of when the restore was // initiated(YYYY-MM-DDThh:mm:ss.sssZ), e.g. 2023-05-01T01:30:28.300Z. TriggeredAt string `json:"triggeredAt,omitempty"` // FinishedAt represents the timestamp of when the restore was // completed(YYYY-MM-DDThh:mm:ss.sssZ), e.g. 2023-05-01T01:30:28.300Z. FinishedAt string `json:"finishedAt,omitempty"` }
RestoreObservation represents the observed state of a restore from the backup manager api.
func (*RestoreObservation) DeepCopy ¶
func (in *RestoreObservation) DeepCopy() *RestoreObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RestoreObservation.
func (*RestoreObservation) DeepCopyInto ¶
func (in *RestoreObservation) DeepCopyInto(out *RestoreObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RestoreParameters ¶
type RestoreParameters struct { // BackupName is the claim name of a data service instance backup to use for the restore. BackupName string `json:"backupName"` }
func (*RestoreParameters) DeepCopy ¶
func (in *RestoreParameters) DeepCopy() *RestoreParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RestoreParameters.
func (*RestoreParameters) DeepCopyInto ¶
func (in *RestoreParameters) DeepCopyInto(out *RestoreParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RestoreSpec ¶
type RestoreSpec struct { xpv1.ResourceSpec `json:",inline"` ForProvider RestoreParameters `json:"forProvider"` }
A RestoreSpec defines the desired state of a Restore.
func (*RestoreSpec) DeepCopy ¶
func (in *RestoreSpec) DeepCopy() *RestoreSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RestoreSpec.
func (*RestoreSpec) DeepCopyInto ¶
func (in *RestoreSpec) DeepCopyInto(out *RestoreSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RestoreStatus ¶
type RestoreStatus struct { xpv1.ResourceStatus `json:",inline"` AtProvider RestoreObservation `json:"atProvider,omitempty"` }
A RestoreStatus represents the observed state of a Restore.
func (*RestoreStatus) DeepCopy ¶
func (in *RestoreStatus) DeepCopy() *RestoreStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RestoreStatus.
func (*RestoreStatus) DeepCopyInto ¶
func (in *RestoreStatus) DeepCopyInto(out *RestoreStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.