client

package
v0.19.904 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 30, 2026 License: AGPL-3.0 Imports: 26 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrSignalTimeout = errors.New("timeout waiting for signal completion")

Functions

This section is empty.

Types

type Client 

type Client struct {
	// contains filtered or unexported fields
}

func New 

func New(params Params) *Client

func (*Client) AwaitSignal 

func (c *Client) AwaitSignal(ctx context.Context, queueSignalID string) (*handler.FinishedResponse, error)

@temporal-gen-v2 activity @start-to-close-timeout 5m @schedule-to-close-timeout 2h @heartbeat-timeout 60s

func (*Client) CancelSignal added in v0.19.850 

func (c *Client) CancelSignal(ctx context.Context, queueSignalID string) (*handler.CancelResponse, error)

@temporal-gen-v2 activity @start-to-close-timeout 1m

func (*Client) ClearQueue added in v0.19.894 

func (c *Client) ClearQueue(ctx context.Context, queueID string) error

ClearQueue cancels all in-flight (non-terminal) signals in the given queue.

func (*Client) CompleteSignal added in v0.19.850 

func (c *Client) CompleteSignal(ctx context.Context, signalID, updateName string) error

@temporal-gen-v2 activity @start-to-close-timeout 1m

func (*Client) Create 

func (c *Client) Create(ctx context.Context, req *CreateQueueRequest) (*app.Queue, error)

@temporal-gen-v2 activity @start-to-close-timeout 1m

func (*Client) DirectExecuteSignal added in v0.19.901 

func (c *Client) DirectExecuteSignal(ctx context.Context, queueSignalID string) (*queue.DirectExecuteResponse, error)

@temporal-gen-v2 activity @start-to-close-timeout 5m

func (*Client) EnqueueSignal 

func (c *Client) EnqueueSignal(ctx context.Context, req *EnqueueSignalRequest) (*queue.EnqueueResponse, error)

@temporal-gen-v2 activity @start-to-close-timeout 1m

func (*Client) FetchEagerStepGroups added in v0.19.903 

func (c *Client) FetchEagerStepGroups(ctx context.Context, req FetchEagerStepGroupsRequest) (*app.GenerateStepsResult, error)

@temporal-gen-v2 activity @start-to-close-timeout 2m @heartbeat-timeout 60s

func (*Client) FetchSteps added in v0.19.894 

func (c *Client) FetchSteps(ctx context.Context, req FetchStepsRequest) (*app.GenerateStepsResult, error)

@temporal-gen-v2 activity @start-to-close-timeout 2m @heartbeat-timeout 60s

func (*Client) ForceRestart added in v0.19.901 

func (c *Client) ForceRestart(ctx context.Context, queueID string) error

@temporal-gen-v2 activity @start-to-close-timeout 1m

func (*Client) GetQueue 

func (c *Client) GetQueue(ctx context.Context, id string) (*app.Queue, error)

@temporal-gen-v2 activity @start-to-close-timeout 1m

func (*Client) GetQueueByOwner added in v0.19.850 

func (c *Client) GetQueueByOwner(ctx context.Context, ownerID, ownerType string) (*app.Queue, error)

@temporal-gen-v2 activity @start-to-close-timeout 1m

func (*Client) GetQueueByOwnerAndName added in v0.19.872 

func (c *Client) GetQueueByOwnerAndName(ctx context.Context, ownerID, ownerType, name string) (*app.Queue, error)

@temporal-gen-v2 activity @start-to-close-timeout 1m

func (*Client) GetQueueStatus added in v0.19.850 

func (c *Client) GetQueueStatus(ctx context.Context, queueID string) (*queue.StatusResponse, error)

@temporal-gen-v2 activity @start-to-close-timeout 1m

func (*Client) HintRestart added in v0.19.903 

func (c *Client) HintRestart(ctx context.Context, queueIDs []string) error

@temporal-gen-v2 activity @start-to-close-timeout 1m

func (*Client) HintRestartByOrg added in v0.19.903 

func (c *Client) HintRestartByOrg(ctx context.Context, orgID string) error

@temporal-gen-v2 activity @start-to-close-timeout 1m

func (*Client) ListQueues added in v0.19.850 

func (c *Client) ListQueues(ctx context.Context, orgID, ownerID, ownerType string, limit, offset int) ([]app.Queue, error)

@temporal-gen-v2 activity @start-to-close-timeout 1m

func (*Client) ListQueuesByOrgID added in v0.19.895 

func (c *Client) ListQueuesByOrgID(ctx context.Context, orgID string) ([]app.Queue, error)

@temporal-gen-v2 activity @start-to-close-timeout 1m

func (*Client) Pause added in v0.19.850 

func (c *Client) Pause(ctx context.Context, queueID string) error

@temporal-gen-v2 activity @start-to-close-timeout 1m

func (*Client) PollSignal added in v0.19.850 

func (c *Client) PollSignal(ctx context.Context, queueSignalID string, opts *PollSignalOptions) (*handler.StatusResponse, error)

func (*Client) QuerySignalStatus added in v0.19.872 

func (c *Client) QuerySignalStatus(ctx context.Context, queueSignalID string) (*handler.StatusResponse, error)

QuerySignalStatus queries the status of a signal handler. If the handler workflow is sleeping or completed, it falls back to the database status.

func (*Client) QueueReady 

func (c *Client) QueueReady(ctx context.Context, queueID string) error

@temporal-gen-v2 activity @start-to-close-timeout 1m

func (*Client) RequestCANAll added in v0.19.903 

func (c *Client) RequestCANAll(ctx context.Context, _ *RequestCANAllRequest) (*RequestCANAllResponse, error)

RequestCANAll sets restart_hint on all queues via status_v2 metadata. @temporal-gen-v2 activity @start-to-close-timeout 1m

func (*Client) Restart 

func (c *Client) Restart(ctx context.Context, queueID string) error

@temporal-gen-v2 activity @start-to-close-timeout 1m

func (*Client) Resume added in v0.19.850 

func (c *Client) Resume(ctx context.Context, queueID string) error

@temporal-gen-v2 activity @start-to-close-timeout 1m

func (*Client) Stop added in v0.19.850 

func (c *Client) Stop(ctx context.Context, queueID string) error

@temporal-gen-v2 activity @start-to-close-timeout 1m

func (*Client) Terminate added in v0.19.894 

func (c *Client) Terminate(ctx context.Context, queueID string) error

Terminate stops all emitters (cancelling their Temporal workflows), deletes the emitter records, stops the queue workflow, and soft-deletes the queue record.

type CreateQueueRequest 

type CreateQueueRequest struct {
	OrgID *string

	OwnerID   string `validate:"required"`
	OwnerType string `validate:"required"`
	Namespace string `validate:"required"`

	Name     string
	Metadata pgtype.Hstore

	MaxInFlight int
	MaxDepth    int
}

type EnqueueSignalRequest added in v0.19.850 

type EnqueueSignalRequest struct {
	QueueID   string        `validate:"required"`
	Signal    signal.Signal `validate:"required"`
	OwnerID   string
	OwnerType string
}

type FetchEagerStepGroupsRequest added in v0.19.903 

type FetchEagerStepGroupsRequest struct {
	QueueSignalID string `json:"queue_signal_id" validate:"required"`
}

type FetchStepsRequest added in v0.19.894 

type FetchStepsRequest struct {
	QueueSignalID string `json:"queue_signal_id" validate:"required"`
}

type Params 

type Params struct {
	fx.In

	DB       *gorm.DB `name:"psql"`
	Cfg      *internal.Config
	TClient  temporalclient.Client
	L        *zap.Logger
	Enqueuer *enqueuer.Enqueuer
}

type PollSignalOptions added in v0.19.850 

type PollSignalOptions struct {
	Timeout      *time.Duration
	PollInterval time.Duration
}

type RequestCANAllRequest added in v0.19.903 

type RequestCANAllRequest struct{}

type RequestCANAllResponse added in v0.19.903 

type RequestCANAllResponse struct {
	RowsAffected int64 `json:"rows_affected"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.