Module golem_rust::bindings::golem::api::host

Structs

• ComponentId
  Represents a Golem component
• GetWorkers
• PromiseId
  A promise ID is a value that can be passed to an external Golem API to complete that promise from an arbitrary external source, while Golem workers can await for this completion.
• RetryPolicy
  Configures how the executor retries failures
• Uuid
  UUID
• WorkerAllFilter
• WorkerAnyFilter
• WorkerCreatedAtFilter
• WorkerEnvFilter
• WorkerId
  Represents a Golem worker
• WorkerMetadata
• WorkerNameFilter
• WorkerStatusFilter
• WorkerVersionFilter

Enums

• FilterComparator
• PersistenceLevel
  Configurable persistence level for workers
• StringFilterComparator
• UpdateMode
  Describes how to update a worker to a different component version
• WorkerPropertyFilter
• WorkerStatus

Functions

• generate_idempotency_key
  Generates an idempotency key. This operation will never be replayed — i.e. not only is this key generated, but it is persisted and committed, such that the key can be used in third-party systems (e.g. payment processing) to introduce idempotence.
• get_idempotence_mode
  Gets the current idempotence mode. See set-idempotence-mode for details.
• get_oplog_index
  Returns the current position in the persistent op log
• get_oplog_persistence_level
  Gets the worker’s current persistence level.
• get_retry_policy
  Gets the current retry policy associated with the worker
• get_self_uri
  Returns a Golem worker URI that can be used to invoke a given function on the current worker
• golem_await_promise
  Suspends execution until the given promise gets completed, and returns the payload passed to the promise completion.
• golem_complete_promise
  Completes the given promise with the given payload. Returns true if the promise was completed, false if the promise was already completed. The payload is passed to the worker that is awaiting the promise.
• golem_create_promise
  Create a new promise
• golem_delete_promise
  Deletes the given promise
• mark_begin_operation
  Marks the beginning of an atomic operation. In case of a failure within the region selected by mark-begin-operation and mark-end-operation the whole region will be reexecuted on retry. The end of the region is when mark-end-operation is called with the returned oplog-index.
• mark_end_operation
  Commits this atomic operation. After mark-end-operation is called for a given index, further calls with the same parameter will do nothing.
• oplog_commit
  Blocks the execution until the oplog has been written to at least the specified number of replicas, or the maximum number of replicas if the requested number is higher.
• set_idempotence_mode
  Sets the current idempotence mode. The default is true. True means side-effects are treated idempotent and Golem guarantees at-least-once semantics. In case of false the executor provides at-most-once semantics, failing the worker in case it is not known if the side effect was already executed.
• set_oplog_index
  Makes the current worker travel back in time and continue execution from the given position in the persistent op log.
• set_oplog_persistence_level
  Sets the worker’s current persistence level. This can increase the performance of execution in cases where durable execution is not required.
• set_retry_policy
  Overrides the current retry policy associated with the worker. Following this call, get-retry-policy will return the new retry policy.
• update_worker
  Initiates an update attempt for the given worker. The function returns immediately once the request has been processed, not waiting for the worker to get updated.

Type Aliases

• ComponentVersion
  Represents a Golem component’s version
• Duration
• OplogIndex
  An index into the persistent log storing all performed operations of a worker
• Uri