Skip to content

k8s.v1alpha1.restore

"Restore is the Schema for the restores API. It is used to define restore jobs and its restoration source."

Index

Fields

fn new

new(name)

new returns an instance of Restore

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"RestoreSpec defines the desired state of restore"

fn spec.withArgs

withArgs(args)

"Args to be used in the Container."

fn spec.withArgsMixin

withArgsMixin(args)

"Args to be used in the Container."

Note: This function appends passed data to existing values

fn spec.withBackoffLimit

withBackoffLimit(backoffLimit)

"BackoffLimit defines the maximum number of attempts to successfully perform a Backup."

fn spec.withDatabase

withDatabase(database)

"Database defines the logical database to be restored. If not provided, all databases available in the backup are restored.\nIMPORTANT: The database must previously exist."

fn spec.withImagePullSecrets

withImagePullSecrets(imagePullSecrets)

"ImagePullSecrets is the list of pull Secrets to be used to pull the image."

fn spec.withImagePullSecretsMixin

withImagePullSecretsMixin(imagePullSecrets)

"ImagePullSecrets is the list of pull Secrets to be used to pull the image."

Note: This function appends passed data to existing values

fn spec.withLogLevel

withLogLevel(logLevel)

"LogLevel to be used n the Backup Job. It defaults to 'info'."

fn spec.withNodeSelector

withNodeSelector(nodeSelector)

"NodeSelector to be used in the Pod."

fn spec.withNodeSelectorMixin

withNodeSelectorMixin(nodeSelector)

"NodeSelector to be used in the Pod."

Note: This function appends passed data to existing values

fn spec.withPriorityClassName

withPriorityClassName(priorityClassName)

"PriorityClassName to be used in the Pod."

fn spec.withRestartPolicy

withRestartPolicy(restartPolicy)

"RestartPolicy to be added to the Backup Job."

fn spec.withServiceAccountName

withServiceAccountName(serviceAccountName)

"ServiceAccountName is the name of the ServiceAccount to be used by the Pods."

fn spec.withTargetRecoveryTime

withTargetRecoveryTime(targetRecoveryTime)

"TargetRecoveryTime is a RFC3339 (1970-01-01T00:00:00Z) date and time that defines the point in time recovery objective.\nIt is used to determine the closest restoration source in time."

fn spec.withTolerations

withTolerations(tolerations)

"Tolerations to be used in the Pod."

fn spec.withTolerationsMixin

withTolerationsMixin(tolerations)

"Tolerations to be used in the Pod."

Note: This function appends passed data to existing values

obj spec.affinity

"Affinity to be used in the Pod."

fn spec.affinity.withAntiAffinityEnabled

withAntiAffinityEnabled(antiAffinityEnabled)

"AntiAffinityEnabled configures PodAntiAffinity so each Pod is scheduled in a different Node, enabling HA.\nMake sure you have at least as many Nodes available as the replicas to not end up with unscheduled Pods."

obj spec.affinity.nodeAffinity

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nodeaffinity-v1-core"

fn spec.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

fn spec.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nodeselectorterm-v1-core"

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFields

withMatchFields(matchFields)

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withKey

withKey(key)

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValues

withValues(values)

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withKey

withKey(key)

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValues

withValues(values)

fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nodeselector-v1-core"

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms

withNodeSelectorTerms(nodeSelectorTerms)

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTermsMixin

withNodeSelectorTermsMixin(nodeSelectorTerms)

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFields

withMatchFields(matchFields)

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFieldsMixin

withMatchFieldsMixin(matchFields)

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withKey

withKey(key)

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValues

withValues(values)

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withKey

withKey(key)

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withOperator

withOperator(operator)

"A node selector operator is the set of operators that can be used in\na node selector requirement."

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValues

withValues(values)

fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.affinity.podAntiAffinity

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#podantiaffinity-v1-core."

fn spec.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecution

withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)

fn spec.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin

withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)

Note: This function appends passed data to existing values

fn spec.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecution

withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)

fn spec.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin

withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)

Note: This function appends passed data to existing values

obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight

withWeight(weight)

obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#podaffinityterm-v1-core."

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey

withTopologyKey(topologyKey)

obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#labelselector-v1-meta"

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

Note: This function appends passed data to existing values

obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withKey

withKey(key)

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator

withOperator(operator)

"A label selector operator is the set of operators that can be used in a selector requirement."

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues

withValues(values)

fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey

withTopologyKey(topologyKey)

obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#labelselector-v1-meta"

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions

withMatchExpressions(matchExpressions)

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

Note: This function appends passed data to existing values

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabels

withMatchLabels(matchLabels)

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

Note: This function appends passed data to existing values

obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withKey

withKey(key)

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator

withOperator(operator)

"A label selector operator is the set of operators that can be used in a selector requirement."

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues

withValues(values)

fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin

withValuesMixin(values)

Note: This function appends passed data to existing values

obj spec.backupRef

"BackupRef is a reference to a Backup object. It has priority over S3 and Volume."

fn spec.backupRef.withName

withName(name)

obj spec.imagePullSecrets

"ImagePullSecrets is the list of pull Secrets to be used to pull the image."

fn spec.imagePullSecrets.withName

withName(name)

obj spec.inheritMetadata

"InheritMetadata defines the metadata to be inherited by children resources."

fn spec.inheritMetadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.inheritMetadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.inheritMetadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.inheritMetadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.mariaDbRef

"MariaDBRef is a reference to a MariaDB object."

fn spec.mariaDbRef.withKind

withKind(kind)

"Kind of the referent."

fn spec.mariaDbRef.withName

withName(name)

fn spec.mariaDbRef.withNamespace

withNamespace(namespace)

fn spec.mariaDbRef.withWaitForIt

withWaitForIt(waitForIt)

"WaitForIt indicates whether the controller using this reference should wait for MariaDB to be ready."

obj spec.podMetadata

"PodMetadata defines extra metadata for the Pod."

fn spec.podMetadata.withAnnotations

withAnnotations(annotations)

"Annotations to be added to children resources."

fn spec.podMetadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to be added to children resources."

Note: This function appends passed data to existing values

fn spec.podMetadata.withLabels

withLabels(labels)

"Labels to be added to children resources."

fn spec.podMetadata.withLabelsMixin

withLabelsMixin(labels)

"Labels to be added to children resources."

Note: This function appends passed data to existing values

obj spec.podSecurityContext

"SecurityContext holds pod-level security attributes and common container settings."

fn spec.podSecurityContext.withFsGroup

withFsGroup(fsGroup)

fn spec.podSecurityContext.withFsGroupChangePolicy

withFsGroupChangePolicy(fsGroupChangePolicy)

"PodFSGroupChangePolicy holds policies that will be used for applying fsGroup to a volume\nwhen volume is mounted."

fn spec.podSecurityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

fn spec.podSecurityContext.withRunAsNonRoot

withRunAsNonRoot(runAsNonRoot)

fn spec.podSecurityContext.withRunAsUser

withRunAsUser(runAsUser)

fn spec.podSecurityContext.withSupplementalGroups

withSupplementalGroups(supplementalGroups)

fn spec.podSecurityContext.withSupplementalGroupsMixin

withSupplementalGroupsMixin(supplementalGroups)

Note: This function appends passed data to existing values

obj spec.podSecurityContext.appArmorProfile

"AppArmorProfile defines a pod or container's AppArmor settings."

fn spec.podSecurityContext.appArmorProfile.withLocalhostProfile

withLocalhostProfile(localhostProfile)

"localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\"."

fn spec.podSecurityContext.appArmorProfile.withType

withType(type)

"type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement."

obj spec.podSecurityContext.seLinuxOptions

"SELinuxOptions are the labels to be applied to the container"

fn spec.podSecurityContext.seLinuxOptions.withLevel

withLevel(level)

"Level is SELinux level label that applies to the container."

fn spec.podSecurityContext.seLinuxOptions.withRole

withRole(role)

"Role is a SELinux role label that applies to the container."

fn spec.podSecurityContext.seLinuxOptions.withType

withType(type)

"Type is a SELinux type label that applies to the container."

fn spec.podSecurityContext.seLinuxOptions.withUser

withUser(user)

"User is a SELinux user label that applies to the container."

obj spec.podSecurityContext.seccompProfile

"SeccompProfile defines a pod/container's seccomp profile settings.\nOnly one profile source may be set."

fn spec.podSecurityContext.seccompProfile.withLocalhostProfile

withLocalhostProfile(localhostProfile)

"localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type."

fn spec.podSecurityContext.seccompProfile.withType

withType(type)

"type indicates which kind of seccomp profile will be applied.\nValid options are:\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied."

obj spec.resources

"Resources describes the compute resource requirements."

fn spec.resources.withLimits

withLimits(limits)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.resources.withLimitsMixin

withLimitsMixin(limits)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

fn spec.resources.withRequests

withRequests(requests)

"ResourceList is a set of (resource name, quantity) pairs."

fn spec.resources.withRequestsMixin

withRequestsMixin(requests)

"ResourceList is a set of (resource name, quantity) pairs."

Note: This function appends passed data to existing values

obj spec.s3

"S3 defines the configuration to restore backups from a S3 compatible storage. It has priority over Volume."

fn spec.s3.withBucket

withBucket(bucket)

"Bucket is the name Name of the bucket to store backups."

fn spec.s3.withEndpoint

withEndpoint(endpoint)

"Endpoint is the S3 API endpoint without scheme."

fn spec.s3.withPrefix

withPrefix(prefix)

"Prefix indicates a folder/subfolder in the bucket. For example: mariadb/ or mariadb/backups. A trailing slash '/' is added if not provided."

fn spec.s3.withRegion

withRegion(region)

"Region is the S3 region name to use."

obj spec.s3.accessKeyIdSecretKeyRef

"AccessKeyIdSecretKeyRef is a reference to a Secret key containing the S3 access key id."

fn spec.s3.accessKeyIdSecretKeyRef.withKey

withKey(key)

fn spec.s3.accessKeyIdSecretKeyRef.withName

withName(name)

obj spec.s3.secretAccessKeySecretKeyRef

"AccessKeyIdSecretKeyRef is a reference to a Secret key containing the S3 secret key."

fn spec.s3.secretAccessKeySecretKeyRef.withKey

withKey(key)

fn spec.s3.secretAccessKeySecretKeyRef.withName

withName(name)

obj spec.s3.sessionTokenSecretKeyRef

"SessionTokenSecretKeyRef is a reference to a Secret key containing the S3 session token."

fn spec.s3.sessionTokenSecretKeyRef.withKey

withKey(key)

fn spec.s3.sessionTokenSecretKeyRef.withName

withName(name)

obj spec.s3.tls

"TLS provides the configuration required to establish TLS connections with S3."

fn spec.s3.tls.withEnabled

withEnabled(enabled)

"Enabled is a flag to enable TLS."

obj spec.s3.tls.caSecretKeyRef

"CASecretKeyRef is a reference to a Secret key containing a CA bundle in PEM format used to establish TLS connections with S3.\nBy default, the system trust chain will be used, but you can use this field to add more CAs to the bundle."

fn spec.s3.tls.caSecretKeyRef.withKey

withKey(key)

fn spec.s3.tls.caSecretKeyRef.withName

withName(name)

obj spec.securityContext

"SecurityContext holds security configuration that will be applied to a container."

fn spec.securityContext.withAllowPrivilegeEscalation

withAllowPrivilegeEscalation(allowPrivilegeEscalation)

fn spec.securityContext.withPrivileged

withPrivileged(privileged)

fn spec.securityContext.withReadOnlyRootFilesystem

withReadOnlyRootFilesystem(readOnlyRootFilesystem)

fn spec.securityContext.withRunAsGroup

withRunAsGroup(runAsGroup)

fn spec.securityContext.withRunAsNonRoot

withRunAsNonRoot(runAsNonRoot)

fn spec.securityContext.withRunAsUser

withRunAsUser(runAsUser)

obj spec.securityContext.capabilities

"Adds and removes POSIX capabilities from running containers."

fn spec.securityContext.capabilities.withAdd

withAdd(add)

"Added capabilities"

fn spec.securityContext.capabilities.withAddMixin

withAddMixin(add)

"Added capabilities"

Note: This function appends passed data to existing values

fn spec.securityContext.capabilities.withDrop

withDrop(drop)

"Removed capabilities"

fn spec.securityContext.capabilities.withDropMixin

withDropMixin(drop)

"Removed capabilities"

Note: This function appends passed data to existing values

obj spec.stagingStorage

"StagingStorage defines the temporary storage used to keep external backups (i.e. S3) while they are being processed.\nIt defaults to an emptyDir volume, meaning that the backups will be temporarily stored in the node where the Restore Job is scheduled."

obj spec.stagingStorage.persistentVolumeClaim

"PersistentVolumeClaim is a Kubernetes PVC specification."

fn spec.stagingStorage.persistentVolumeClaim.withAccessModes

withAccessModes(accessModes)

fn spec.stagingStorage.persistentVolumeClaim.withAccessModesMixin

withAccessModesMixin(accessModes)

Note: This function appends passed data to existing values

fn spec.stagingStorage.persistentVolumeClaim.withStorageClassName

withStorageClassName(storageClassName)

obj spec.stagingStorage.persistentVolumeClaim.resources

"VolumeResourceRequirements describes the storage resource requirements for a volume."

fn spec.stagingStorage.persistentVolumeClaim.resources.withLimits

withLimits(limits)

"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.stagingStorage.persistentVolumeClaim.resources.withLimitsMixin

withLimitsMixin(limits)

"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

fn spec.stagingStorage.persistentVolumeClaim.resources.withRequests

withRequests(requests)

"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

fn spec.stagingStorage.persistentVolumeClaim.resources.withRequestsMixin

withRequestsMixin(requests)

"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"

Note: This function appends passed data to existing values

obj spec.stagingStorage.persistentVolumeClaim.selector

"A label selector is a label query over a set of resources. The result of matchLabels and\nmatchExpressions are ANDed. An empty label selector matches all objects. A null\nlabel selector matches no objects."

fn spec.stagingStorage.persistentVolumeClaim.selector.withMatchExpressions

withMatchExpressions(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.stagingStorage.persistentVolumeClaim.selector.withMatchExpressionsMixin

withMatchExpressionsMixin(matchExpressions)

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

Note: This function appends passed data to existing values

fn spec.stagingStorage.persistentVolumeClaim.selector.withMatchLabels

withMatchLabels(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

fn spec.stagingStorage.persistentVolumeClaim.selector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed."

Note: This function appends passed data to existing values

obj spec.stagingStorage.persistentVolumeClaim.selector.matchExpressions

"matchExpressions is a list of label selector requirements. The requirements are ANDed."

fn spec.stagingStorage.persistentVolumeClaim.selector.matchExpressions.withKey

withKey(key)

"key is the label key that the selector applies to."

fn spec.stagingStorage.persistentVolumeClaim.selector.matchExpressions.withOperator

withOperator(operator)

"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist."

fn spec.stagingStorage.persistentVolumeClaim.selector.matchExpressions.withValues

withValues(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

fn spec.stagingStorage.persistentVolumeClaim.selector.matchExpressions.withValuesMixin

withValuesMixin(values)

"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch."

Note: This function appends passed data to existing values

obj spec.stagingStorage.volume

"Volume is a Kubernetes volume specification."

obj spec.stagingStorage.volume.csi

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#csivolumesource-v1-core."

fn spec.stagingStorage.volume.csi.withDriver

withDriver(driver)

fn spec.stagingStorage.volume.csi.withFsType

withFsType(fsType)

fn spec.stagingStorage.volume.csi.withReadOnly

withReadOnly(readOnly)

fn spec.stagingStorage.volume.csi.withVolumeAttributes

withVolumeAttributes(volumeAttributes)

fn spec.stagingStorage.volume.csi.withVolumeAttributesMixin

withVolumeAttributesMixin(volumeAttributes)

Note: This function appends passed data to existing values

obj spec.stagingStorage.volume.csi.nodePublishSecretRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core."

fn spec.stagingStorage.volume.csi.nodePublishSecretRef.withName

withName(name)

obj spec.stagingStorage.volume.emptyDir

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#emptydirvolumesource-v1-core."

fn spec.stagingStorage.volume.emptyDir.withMedium

withMedium(medium)

"StorageMedium defines ways that storage can be allocated to a volume."

fn spec.stagingStorage.volume.emptyDir.withSizeLimit

withSizeLimit(sizeLimit)

obj spec.stagingStorage.volume.hostPath

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#hostpathvolumesource-v1-core"

fn spec.stagingStorage.volume.hostPath.withPath

withPath(path)

fn spec.stagingStorage.volume.hostPath.withType

withType(type)

obj spec.stagingStorage.volume.nfs

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nfsvolumesource-v1-core."

fn spec.stagingStorage.volume.nfs.withPath

withPath(path)

fn spec.stagingStorage.volume.nfs.withReadOnly

withReadOnly(readOnly)

fn spec.stagingStorage.volume.nfs.withServer

withServer(server)

obj spec.stagingStorage.volume.persistentVolumeClaim

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#persistentvolumeclaimvolumesource-v1-core."

fn spec.stagingStorage.volume.persistentVolumeClaim.withClaimName

withClaimName(claimName)

fn spec.stagingStorage.volume.persistentVolumeClaim.withReadOnly

withReadOnly(readOnly)

obj spec.tolerations

"Tolerations to be used in the Pod."

fn spec.tolerations.withEffect

withEffect(effect)

"Effect indicates the taint effect to match. Empty means match all taint effects.\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute."

fn spec.tolerations.withKey

withKey(key)

"Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys."

fn spec.tolerations.withOperator

withOperator(operator)

"Operator represents a key's relationship to the value.\nValid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category."

fn spec.tolerations.withTolerationSeconds

withTolerationSeconds(tolerationSeconds)

"TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system."

fn spec.tolerations.withValue

withValue(value)

"Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string."

obj spec.volume

"Volume is a Kubernetes Volume object that contains a backup."

obj spec.volume.csi

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#csivolumesource-v1-core."

fn spec.volume.csi.withDriver

withDriver(driver)

fn spec.volume.csi.withFsType

withFsType(fsType)

fn spec.volume.csi.withReadOnly

withReadOnly(readOnly)

fn spec.volume.csi.withVolumeAttributes

withVolumeAttributes(volumeAttributes)

fn spec.volume.csi.withVolumeAttributesMixin

withVolumeAttributesMixin(volumeAttributes)

Note: This function appends passed data to existing values

obj spec.volume.csi.nodePublishSecretRef

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core."

fn spec.volume.csi.nodePublishSecretRef.withName

withName(name)

obj spec.volume.emptyDir

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#emptydirvolumesource-v1-core."

fn spec.volume.emptyDir.withMedium

withMedium(medium)

"StorageMedium defines ways that storage can be allocated to a volume."

fn spec.volume.emptyDir.withSizeLimit

withSizeLimit(sizeLimit)

obj spec.volume.hostPath

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#hostpathvolumesource-v1-core"

fn spec.volume.hostPath.withPath

withPath(path)

fn spec.volume.hostPath.withType

withType(type)

obj spec.volume.nfs

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#nfsvolumesource-v1-core."

fn spec.volume.nfs.withPath

withPath(path)

fn spec.volume.nfs.withReadOnly

withReadOnly(readOnly)

fn spec.volume.nfs.withServer

withServer(server)

obj spec.volume.persistentVolumeClaim

"Refer to the Kubernetes docs: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#persistentvolumeclaimvolumesource-v1-core."

fn spec.volume.persistentVolumeClaim.withClaimName

withClaimName(claimName)

fn spec.volume.persistentVolumeClaim.withReadOnly

withReadOnly(readOnly)