View Source EtcdEx.Types (EtcdEx v1.3.0)

Etcd-related types.

Link to this section Summary

Link to this section Types

@type delete_opt() ::
  {:range_end, range_end()}
  | {:prefix, boolean()}
  | {:from_key, boolean()}
  | {:prev_kv, boolean()}
@type error() ::
  {:grpc_error, %{grpc_status: pos_integer(), grpc_message: binary()}}
  | {:http_error, %{status: pos_integer()}}
@type filter() :: :NOPUT | :NODELETE
@type filters() :: [filter()]
@type get_opt() ::
  {:range_end, range_end()}
  | {:prefix, boolean()}
  | {:from_key, boolean()}
  | {:limit, limit()}
  | {:revision, revision()}
  | {:sort, sort()}
  | {:serializable, boolean()}
  | {:keys_only, boolean()}
  | {:count_only, boolean()}
  | {:min_mod_revision, revision()}
  | {:max_mod_revision, revision()}
  | {:min_create_revision, revision()}
  | {:max_create_revision, revision()}
@type key() :: binary()
@type lease_id() :: integer()
@type limit() :: non_neg_integer()
@type member_id() :: pos_integer()
@type name() :: binary()
@type peer_url() :: binary()
@type put_opt() ::
  {:lease, lease_id()}
  | {:prev_kv, boolean()}
  | {:ignore_value, boolean()}
  | {:ignore_lease, boolean()}
@type range_end() :: binary()
@type response() ::
  {:status, Mint.Types.request_ref(), Mint.Types.status()}
  | {:headers, Mint.Types.request_ref(), Mint.Types.headers()}
  | {:data, Mint.Types.request_ref(), map()}
  | {:done, Mint.Types.request_ref()}
  | {:error, Mint.Types.request_ref(), reason :: term()}
@type revision() :: pos_integer()
@type sort() :: {sort_target(), sort_order()}
@type sort_order() :: :NONE | :ASCEND | :DESCEND
@type sort_target() :: :KEY | :VERSION | :VALUE | :CREATE | :MOD
@type ttl() :: pos_integer()
@type ttl_opt() :: {:keys, boolean()}
@type value() :: binary()
@type watch_id() :: integer()
@type watch_opt() ::
  {:range_end, range_end()}
  | {:prefix, boolean()}
  | {:from_key, boolean()}
  | {:start_revision, revision()}
  | {:filters, filters()}
  | {:prev_kv, boolean()}
  | {:progress_notify, boolean()}