WeaviateEx.Cluster.Replication.Operation (WeaviateEx v0.7.4)

A shard replication operation.

Summary

Types

t()

Functions

completed?(arg1)

Check if operation is complete (success, failure, or cancelled).

from_api(map)

Parse operation from API response.

in_progress?(arg1)

Check if operation is still in progress.

success?(arg1)

Check if operation succeeded.

Types

t()

@type t() :: %WeaviateEx.Cluster.Replication.Operation{
  collection: String.t(),
  completed_at: DateTime.t() | nil,
  created_at: DateTime.t() | nil,
  error: String.t() | nil,
  id: String.t(),
  progress: float() | nil,
  shard: String.t(),
  source_node: String.t(),
  status: atom(),
  target_node: String.t(),
  type: atom()
}

Functions

completed?(arg1)

@spec completed?(t()) :: boolean()

Check if operation is complete (success, failure, or cancelled).

Examples

iex> Operation.completed?(%Operation{status: :completed})
true

iex> Operation.completed?(%Operation{status: :running})
false

from_api(map)

@spec from_api(map()) :: t()

Parse operation from API response.

Examples

iex> Operation.from_api(%{"id" => "uuid-123", "status" => "RUNNING", "progress" => 0.5})
%Operation{id: "uuid-123", status: :running, progress: 0.5}

in_progress?(arg1)

@spec in_progress?(t()) :: boolean()

Check if operation is still in progress.

Examples

iex> Operation.in_progress?(%Operation{status: :running})
true

success?(arg1)

@spec success?(t()) :: boolean()

Check if operation succeeded.

Examples

iex> Operation.success?(%Operation{status: :completed})
true