Packages > pkl > pkl.base

Module0.27.1

Properties
Methods

abstract external class Module

Base class for modules.

Known subtypes:: APIGroup, APIGroupList, APIResourceList, APIService, APIService, APIServiceList, APIServiceList, APIVersions, AWSElasticBlockStoreVolumeSource, AppArmorProfile, AzureDiskVolumeSource, Benchmark, Binding, CSIDriver, CSIDriver, CSIDriverList, CSIDriverList, CSINode, CSINode, CSINodeList, CSINodeList, CSIStorageCapacity, CSIStorageCapacity, CSIStorageCapacity, CSIStorageCapacityList, CSIStorageCapacityList, CSIStorageCapacityList, CertificateSigningRequest, CertificateSigningRequest, CertificateSigningRequestList, CertificateSigningRequestList, ClusterCIDR, ClusterCIDRList, ClusterRole, ClusterRole, ClusterRole, ClusterRoleBinding, ClusterRoleBinding, ClusterRoleBinding, ClusterRoleBindingList, ClusterRoleBindingList, ClusterRoleBindingList, ClusterRoleList, ClusterRoleList, ClusterRoleList, ClusterTrustBundle, ClusterTrustBundleList, CollectdInputDataFormat, ComponentStatus, ComponentStatusList, Condition, Config, ConfigMap, ConfigMapList, ContainerPort, ContainerResizePolicy, ControllerRevision, ControllerRevisionList, CpuInput, CronJob, CronJob, CronJob, CronJobList, CronJobList, CronJobList, CsvInputDataFormat, CustomResourceDefinition, CustomResourceDefinition, CustomResourceDefinitionList, CustomResourceDefinitionList, DaemonSet, DaemonSetList, DeleteOptions, Deployment, DeploymentList, DiscardOutput, DiskInput, DocPackageInfo, DocsiteInfo, EndpointSlice, EndpointSlice, EndpointSliceList, EndpointSliceList, Endpoints, EndpointsList, EnvFromSource, EnvVar, EphemeralContainer, EphemeralContainers, EvaluatorSettings, Event, Event, Event, EventList, EventList, EventList, EventSource, Eviction, Eviction, ExecAction, ExecInput, FCVolumeSource, FileInput, FileOutput, FlockerVolumeSource, FlowSchema, FlowSchema, FlowSchema, FlowSchema, FlowSchema, FlowSchemaList, FlowSchemaList, FlowSchemaList, FlowSchemaList, FlowSchemaList, GCEPersistentDiskVolumeSource, Generator, GeneratorSettings, HTTPGetAction, HorizontalPodAutoscaler, HorizontalPodAutoscaler, HorizontalPodAutoscaler, HorizontalPodAutoscaler, HorizontalPodAutoscalerList, HorizontalPodAutoscalerList, HorizontalPodAutoscalerList, HorizontalPodAutoscalerList, HostPathVolumeSource, HttpInput, IPAddress, IPAddressList, Info, Ingress, Ingress, Ingress, IngressClass, IngressClass, IngressClassList, IngressClassList, IngressList, IngressList, IngressList, Input, InputDataFormat, Job, JobList, JobSpec, JsonInputDataFormat, JsonOutputDataFormat, K8sObject, K8sResource, LabelSelector, Lease, Lease, LeaseList, LeaseList, Lifecycle, LimitRange, LimitRangeList, ListMeta, LoadBalancerStatus, LocalObjectReference, LocalSubjectAccessReview, LocalSubjectAccessReview, MatchCondition, MatchResources, MatchResources, MatchResources, MutatingWebhookConfiguration, MutatingWebhookConfiguration, MutatingWebhookConfigurationList, MutatingWebhookConfigurationList, NFSVolumeSource, Namespace, NamespaceList, NetInput, NetworkPolicy, NetworkPolicyList, Node, NodeList, NodeSelector, NodeSelectorTerm, NonResourceAttributes, NonResourceAttributes, ObjectFieldSelector, ObjectMeta, ObjectReference, OpenTelemetry, OpenTelemetryOutput, Output, OutputDataFormat, PersistentVolume, PersistentVolumeClaim, PersistentVolumeClaimList, PersistentVolumeClaimSpec, PersistentVolumeList, PersistentVolumeSpec, PhotonPersistentDiskVolumeSource, Plugin, Pod, PodDisruptionBudget, PodDisruptionBudget, PodDisruptionBudgetList, PodDisruptionBudgetList, PodList, PodPreset, PodPresetList, PodScheduling, PodSchedulingContext, PodSchedulingContextList, PodSchedulingList, PodSecurityPolicy, PodSecurityPolicyList, PodSpec, PodTemplate, PodTemplateList, PodTemplateSpec, PolicyRule, PolicyRule, PolicyRule, PortworxVolumeSource, PriorityClass, PriorityClass, PriorityClass, PriorityClassList, PriorityClassList, PriorityClassList, PriorityLevelConfiguration, PriorityLevelConfiguration, PriorityLevelConfiguration, PriorityLevelConfiguration, PriorityLevelConfiguration, PriorityLevelConfigurationList, PriorityLevelConfigurationList, PriorityLevelConfigurationList, PriorityLevelConfigurationList, PriorityLevelConfigurationList, Probe, Processor, Project, PrometheusClientOutput, PrometheusInput, QuobyteVolumeSource, ReplicaSet, ReplicaSetList, ReplicationController, ReplicationControllerList, ResourceAttributes, ResourceAttributes, ResourceClaim, ResourceClaim, ResourceClaimList, ResourceClaimList, ResourceClaimParameters, ResourceClaimParametersList, ResourceClaimParametersReference, ResourceClaimSpec, ResourceClaimSpec, ResourceClaimTemplate, ResourceClaimTemplate, ResourceClaimTemplateList, ResourceClaimTemplateList, ResourceClass, ResourceClass, ResourceClassList, ResourceClassList, ResourceClassParameters, ResourceClassParametersList, ResourceClassParametersReference, ResourceFieldSelector, ResourceQuota, ResourceQuotaList, ResourceRequirements, ResourceSlice, ResourceSliceList, Role, Role, Role, RoleBinding, RoleBinding, RoleBinding, RoleBindingList, RoleBindingList, RoleBindingList, RoleList, RoleList, RoleList, RoleRef, RoleRef, RoleRef, RuleWithOperations, RuleWithOperations, RuntimeClass, RuntimeClass, RuntimeClass, RuntimeClassList, RuntimeClassList, RuntimeClassList, SELinuxOptions, Scale, SeccompProfile, Secret, SecretList, SecurityContext, SelfSubjectAccessReview, SelfSubjectAccessReview, SelfSubjectReview, SelfSubjectReview, SelfSubjectReview, SelfSubjectRulesReview, SelfSubjectRulesReview, ServerAddressByClientCIDR, Service, ServiceAccount, ServiceAccountList, ServiceCIDR, ServiceCIDRList, ServiceList, SocketListenerInput, SolrInput, StarlarkProcessor, StatefulSet, StatefulSetList, Status, StorageClass, StorageClass, StorageClassList, StorageClassList, StorageVersion, StorageVersionList, StorageVersionMigration, StorageVersionMigrationList, Subject, Subject, Subject, SubjectAccessReview, SubjectAccessReview, SubjectAccessReviewSpec, SubjectAccessReviewSpec, SubjectAccessReviewStatus, SubjectAccessReviewStatus, TCPSocketAction, TailInput, Telegraf, TokenRequest, TokenReview, TokenReview, Toleration, TopologySelectorTerm, TypedLocalObjectReference, UserInfo, ValidatingAdmissionPolicy, ValidatingAdmissionPolicy, ValidatingAdmissionPolicy, ValidatingAdmissionPolicyBinding, ValidatingAdmissionPolicyBinding, ValidatingAdmissionPolicyBinding, ValidatingAdmissionPolicyBindingList, ValidatingAdmissionPolicyBindingList, ValidatingAdmissionPolicyBindingList, ValidatingAdmissionPolicyList, ValidatingAdmissionPolicyList, ValidatingAdmissionPolicyList, ValidatingWebhookConfiguration, ValidatingWebhookConfiguration, ValidatingWebhookConfigurationList, ValidatingWebhookConfigurationList, Volume, VolumeAttachment, VolumeAttachment, VolumeAttachment, VolumeAttachmentList, VolumeAttachmentList, VolumeAttachmentList, VolumeAttributesClass, VolumeAttributesClassList, VolumeDevice, VolumeMount, VsphereVirtualDiskVolumeSource, WatchEvent, WebhookClientConfig, WebhookClientConfig, WindowsSecurityContextOptions, analyze, base, deepToTyped, generate, go, json, json, jsonnet, k8sSchema, math, platform, protobuf, reflect, release, semver, settings, shell, shellshortcuts, structuredRead, table, test, text, xml, yaml, yaml
Known usages:
All versions:: 0.29.0-dev, 0.28.1, 0.28.0, 0.28.0-dev, 0.27.2, 0.27.1, 0.27.0, 0.26.3, 0.26.2, 0.26.1, 0.26.0, 0.25.3, 0.25.2, 0.25.1, 0.25.0-dev

Properties

link

hidden

output: ModuleOutput

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)

Returns the class of this.
link

function

Any.toString(): String (pkl.base)

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String>

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```