Current section

Files

Jump to
dagger lib dagger gen host.ex
Raw

lib/dagger/gen/host.ex

# This file generated by `dagger_codegen`. Please DO NOT EDIT.
defmodule Dagger.Host do
@moduledoc """
Information about the host environment.
"""
alias Dagger.Core.Client
alias Dagger.Core.QueryBuilder, as: QB
@derive Dagger.ID
defstruct [:query_builder, :client]
@type t() :: %__MODULE__{}
@doc """
Accesses a directory on the host.
"""
@spec directory(t(), String.t(), [{:exclude, [String.t()]}, {:include, [String.t()]}]) ::
Dagger.Directory.t()
def directory(%__MODULE__{} = host, path, optional_args \\ []) do
query_builder =
host.query_builder
|> QB.select("directory")
|> QB.put_arg("path", path)
|> QB.maybe_put_arg("exclude", optional_args[:exclude])
|> QB.maybe_put_arg("include", optional_args[:include])
%Dagger.Directory{
query_builder: query_builder,
client: host.client
}
end
@doc """
Accesses a file on the host.
"""
@spec file(t(), String.t()) :: Dagger.File.t()
def file(%__MODULE__{} = host, path) do
query_builder =
host.query_builder |> QB.select("file") |> QB.put_arg("path", path)
%Dagger.File{
query_builder: query_builder,
client: host.client
}
end
@doc """
A unique identifier for this Host.
"""
@spec id(t()) :: {:ok, Dagger.HostID.t()} | {:error, term()}
def id(%__MODULE__{} = host) do
query_builder =
host.query_builder |> QB.select("id")
Client.execute(host.client, query_builder)
end
@doc """
Creates a service that forwards traffic to a specified address via the host.
"""
@spec service(t(), [Dagger.PortForward.t()], [{:host, String.t() | nil}]) :: Dagger.Service.t()
def service(%__MODULE__{} = host, ports, optional_args \\ []) do
query_builder =
host.query_builder
|> QB.select("service")
|> QB.put_arg("ports", ports)
|> QB.maybe_put_arg("host", optional_args[:host])
%Dagger.Service{
query_builder: query_builder,
client: host.client
}
end
@deprecated """
setSecretFile is superceded by use of the secret API with file:// URIs
"""
@doc """
Sets a secret given a user-defined name and the file path on the host, and returns the secret.
The file is limited to a size of 512000 bytes.
"""
@spec set_secret_file(t(), String.t(), String.t()) :: Dagger.Secret.t()
def set_secret_file(%__MODULE__{} = host, name, path) do
query_builder =
host.query_builder
|> QB.select("setSecretFile")
|> QB.put_arg("name", name)
|> QB.put_arg("path", path)
%Dagger.Secret{
query_builder: query_builder,
client: host.client
}
end
@doc """
Creates a tunnel that forwards traffic from the host to a service.
"""
@spec tunnel(t(), Dagger.Service.t(), [
{:native, boolean() | nil},
{:ports, [Dagger.PortForward.t()]}
]) :: Dagger.Service.t()
def tunnel(%__MODULE__{} = host, service, optional_args \\ []) do
query_builder =
host.query_builder
|> QB.select("tunnel")
|> QB.put_arg("service", Dagger.ID.id!(service))
|> QB.maybe_put_arg("native", optional_args[:native])
|> QB.maybe_put_arg("ports", optional_args[:ports])
%Dagger.Service{
query_builder: query_builder,
client: host.client
}
end
@doc """
Accesses a Unix socket on the host.
"""
@spec unix_socket(t(), String.t()) :: Dagger.Socket.t()
def unix_socket(%__MODULE__{} = host, path) do
query_builder =
host.query_builder |> QB.select("unixSocket") |> QB.put_arg("path", path)
%Dagger.Socket{
query_builder: query_builder,
client: host.client
}
end
end
defimpl Jason.Encoder, for: Dagger.Host do
def encode(host, opts) do
{:ok, id} = Dagger.Host.id(host)
Jason.Encode.string(id, opts)
end
end
defimpl Nestru.Decoder, for: Dagger.Host do
def decode_fields_hint(_struct, _context, id) do
{:ok, Dagger.Client.load_host_from_id(Dagger.Global.dag(), id)}
end
end