Go SDKFeature Clients

Workers Client

Accessed via client.Workers() on the Hatchet client.

WorkersClient

WorkersClient provides methods for interacting with workers

Methods:

NameDescription
GetGet retrieves a worker by its ID.
ListList retrieves all workers for the tenant.
PausePause pauses a worker.
UnpauseUnpause unpauses a worker.

Functions

Get

Get retrieves a worker by its ID.

func (w *WorkersClient) Get(ctx context.Context, workerId string) (*rest.Worker, error)

Parameters:

NameType
ctxcontext.Context
workerIdstring

Returns:

Type
*rest.Worker
error

List

List retrieves all workers for the tenant.

func (w *WorkersClient) List(ctx context.Context) (*rest.WorkerList, error)

Parameters:

NameType
ctxcontext.Context

Returns:

Type
*rest.WorkerList
error

Pause

Pause pauses a worker.

func (w *WorkersClient) Pause(ctx context.Context, workerId string) (*rest.Worker, error)

Parameters:

NameType
ctxcontext.Context
workerIdstring

Returns:

Type
*rest.Worker
error

Unpause

Unpause unpauses a worker.

func (w *WorkersClient) Unpause(ctx context.Context, workerId string) (*rest.Worker, error)

Parameters:

NameType
ctxcontext.Context
workerIdstring

Returns:

Type
*rest.Worker
error

Last updated on August 24, 2026

On this page