JetPluginSDK.Tenant (JetPluginSDK v0.2.1)

The Tenant module.

Summary

Types

capabilities()
config()
id()
state()
t()

Functions

build_tenant_id(map)
build_tenant_id(project_id, environment_id, instance_id)
split_tenant_id(tenant_id)

Types

capabilities()

@type capabilities() :: [JetPluginSDK.Tenant.Capability.t()]

config()

@type config() :: JetPluginSDK.Tenant.Config.t()

id()

@type id() :: String.t()

state()

@type state() ::
  :pending
  | :installing
  | :running
  | :updating
  | :uninstalling
  | :error_occurred
  | :uninstalled

t()

@type t() :: %JetPluginSDK.Tenant{
  capabilities: capabilities(),
  config: config(),
  id: id(),
  state: state()
}

Functions

build_tenant_id(map)

@spec build_tenant_id(%{
  optional(:config) => config(),
  optional(:capabilities) => capabilities(),
  project_id: String.t(),
  env_id: String.t(),
  instance_id: String.t()
}) :: id()

build_tenant_id(project_id, environment_id, instance_id)

@spec build_tenant_id(
  project_id :: String.t(),
  environment_id :: String.t(),
  instance_id :: String.t()
) :: id()

split_tenant_id(tenant_id)

@spec split_tenant_id(id()) ::
  {project_id :: String.t(), environment_id :: String.t(),
   instance_id :: String.t()}