serviceerror

package
v1.62.2 Latest Latest
Warning

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

 Go to latest Published: Feb 13, 2026 License: MIT Imports: 11 Imported by: 206

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func FromStatus 

func FromStatus(st *status.Status) error

FromStatus converts gRPC Status to service error.

func NewAborted added in v1.50.1 

func NewAborted(message string) error

NewAborted returns new Aborted error.

func NewAbortedf added in v1.50.1 

func NewAbortedf(format string, args ...any) error

NewAbortedf returns new Aborted error with formatted message.

func NewActivityExecutionAlreadyStarted added in v1.62.0 

func NewActivityExecutionAlreadyStarted(message, startRequestId, runId string) error

NewActivityExecutionAlreadyStarted returns new ActivityExecutionAlreadyStarted error.

func NewActivityExecutionAlreadyStartedf added in v1.62.0 

func NewActivityExecutionAlreadyStartedf(startRequestId, runId, format string, args ...any) error

NewActivityExecutionAlreadyStartedf returns new ActivityExecutionAlreadyStarted error with formatted message.

func NewAlreadyExist added in v1.8.0 

func NewAlreadyExist(message string) error

Deprecated. Typo in the name. Use NewAlreadyExists instead.

func NewAlreadyExists added in v1.50.0 

func NewAlreadyExists(message string) error

NewAlreadyExists returns new AlreadyExists error.

func NewAlreadyExistsf added in v1.50.0 

func NewAlreadyExistsf(format string, args ...any) error

NewAlreadyExistsf returns new AlreadyExists error with formatted message.

func NewCanceled 

func NewCanceled(message string) error

NewCanceled returns new Canceled error.

func NewCanceledf added in v1.50.0 

func NewCanceledf(format string, args ...any) error

NewCanceledf returns new Canceled error with formatted message.

func NewCancellationAlreadyRequested 

func NewCancellationAlreadyRequested(message string) error

NewCancellationAlreadyRequested returns new CancellationAlreadyRequested error.

func NewCancellationAlreadyRequestedf added in v1.50.0 

func NewCancellationAlreadyRequestedf(format string, args ...any) error

NewCancellationAlreadyRequestedf returns new CancellationAlreadyRequested error with formatted message.

func NewClientVersionNotSupported 

func NewClientVersionNotSupported(clientVersion, clientName, supportedVersions string) error

NewClientVersionNotSupported returns new ClientVersionNotSupported error.

func NewClientVersionNotSupportedf added in v1.50.0 

func NewClientVersionNotSupportedf(clientVersion, clientName, supportedVersions, format string, args ...any) error

NewClientVersionNotSupportedf returns new ClientVersionNotSupported error with formatted message.

func NewDataLoss 

func NewDataLoss(message string) error

NewDataLoss returns new DataLoss error.

func NewDataLossf added in v1.50.0 

func NewDataLossf(format string, args ...any) error

NewDataLossf returns new DataLoss error with formatted message.

func NewDeadlineExceeded 

func NewDeadlineExceeded(message string) error

NewDeadlineExceeded returns new DeadlineExceeded error.

func NewDeadlineExceededf added in v1.50.0 

func NewDeadlineExceededf(format string, args ...any) error

NewDeadlineExceededf returns new DeadlineExceeded error with formatted message.

func NewFailedPrecondition added in v1.8.0 

func NewFailedPrecondition(message string) error

NewFailedPrecondition returns new FailedPrecondition error.

func NewFailedPreconditionf added in v1.50.0 

func NewFailedPreconditionf(format string, args ...any) error

NewFailedPreconditionf returns new FailedPrecondition error with formatted message.

func NewInternal 

func NewInternal(message string) error

NewInternal returns new Internal error.

func NewInternalf added in v1.50.0 

func NewInternalf(format string, args ...any) error

NewInternalf returns new Internal error with formatted message.

func NewInvalidArgument 

func NewInvalidArgument(message string) error

NewInvalidArgument returns new InvalidArgument error.

func NewInvalidArgumentf added in v1.50.0 

func NewInvalidArgumentf(format string, args ...any) error

NewInvalidArgumentf returns new InvalidArgument error with formatted message.

func NewMultiOperationAborted added in v1.32.1 

func NewMultiOperationAborted(message string) error

NewMultiOperationAborted returns MultiOperationAborted.

func NewMultiOperationAbortedf added in v1.50.0 

func NewMultiOperationAbortedf(format string, args ...any) error

NewMultiOperationAbortedf returns MultiOperationAborted with formatted message.

func NewMultiOperationExecution added in v1.32.1 

func NewMultiOperationExecution(message string, errs []error) error

NewMultiOperationExecution returns a new MultiOperationExecution error.

func NewMultiOperationExecutionf added in v1.50.0 

func NewMultiOperationExecutionf(errs []error, format string, args ...any) error

NewMultiOperationExecutionf returns a new MultiOperationExecution error with formatted message.

func NewNamespaceAlreadyExists 

func NewNamespaceAlreadyExists(message string) error

NewNamespaceAlreadyExists returns new NamespaceAlreadyExists error.

func NewNamespaceAlreadyExistsf added in v1.50.0 

func NewNamespaceAlreadyExistsf(format string, args ...any) error

NewNamespaceAlreadyExistsf returns new NamespaceAlreadyExists error with formatted message.

func NewNamespaceInvalidState added in v1.8.0 

func NewNamespaceInvalidState(namespace string, state enumspb.NamespaceState, allowedStates []enumspb.NamespaceState) error

NewNamespaceInvalidState returns new NamespaceInvalidState error.

func NewNamespaceNotActive 

func NewNamespaceNotActive(namespace, currentCluster, activeCluster string) error

NewNamespaceNotActive returns new NamespaceNotActive error.

func NewNamespaceNotFound added in v1.8.0 

func NewNamespaceNotFound(namespace string) error

NewNamespaceNotFound returns new NamespaceNotFound error.

func NewNamespaceUnavailable added in v1.43.1 

func NewNamespaceUnavailable(namespace string) error

NewNamespaceUnavailable returns new NamespaceUnavailable error.

func NewNewerBuildExists added in v1.21.0 

func NewNewerBuildExists(defaultBuildID string) error

NewNewerBuildExists returns new NewerBuildExists error.

func NewNotFound 

func NewNotFound(message string) error

NewNotFound returns new NotFound error.

func NewNotFoundf added in v1.50.0 

func NewNotFoundf(format string, args ...any) error

NewNotFoundf returns new NotFound error with formatted message.

func NewPermissionDenied 

func NewPermissionDenied(message, reason string) error

NewPermissionDenied returns new PermissionDenied error.

func NewPermissionDeniedf added in v1.50.0 

func NewPermissionDeniedf(reason, format string, args ...any) error

NewPermissionDeniedf returns new PermissionDenied error with formatted message.

func NewQueryFailed 

func NewQueryFailed(message string) error

NewQueryFailed returns new QueryFailed error.

func NewQueryFailedWithFailure added in v1.43.1 

func NewQueryFailedWithFailure(message string, failure *failure.Failure) error

NewQueryFailed returns new QueryFailed error.

func NewQueryFailedWithFailuref added in v1.50.0 

func NewQueryFailedWithFailuref(failure *failure.Failure, format string, args ...any) error

NewQueryFailedWithFailuref returns new QueryFailed error with failure and formatted message.

func NewQueryFailedf added in v1.50.0 

func NewQueryFailedf(format string, args ...any) error

NewQueryFailedf returns new QueryFailed error with formatted message.

func NewResourceExhausted 

func NewResourceExhausted(cause enumspb.ResourceExhaustedCause, message string) error

NewResourceExhausted returns new ResourceExhausted error.

func NewResourceExhaustedf added in v1.50.0 

func NewResourceExhaustedf(cause enumspb.ResourceExhaustedCause, format string, args ...any) error

NewResourceExhaustedf returns new ResourceExhausted error with formatted message.

func NewServerVersionNotSupported added in v1.0.0 

func NewServerVersionNotSupported(serverVersion, supportedVersions string) error

NewServerVersionNotSupported returns new ServerVersionNotSupported error.

func NewSystemWorkflow added in v1.8.0 

func NewSystemWorkflow(workflowExecution *common.WorkflowExecution, workflowError error) error

NewSystemWorkflow returns new SystemWorkflow error.

func NewSystemWorkflowf added in v1.50.0 

func NewSystemWorkflowf(workflowExecution *common.WorkflowExecution, format string, args ...any) error

NewSystemWorkflowf returns new SystemWorkflow error with formatted workflow error.

func NewUnavailable 

func NewUnavailable(message string) error

NewUnavailable returns new Unavailable error.

func NewUnavailablef added in v1.50.0 

func NewUnavailablef(format string, args ...any) error

NewUnavailablef returns new Unavailable error with formatted message.

func NewUnimplemented 

func NewUnimplemented(message string) error

NewUnimplemented returns new Unimplemented error.

func NewUnimplementedf added in v1.50.0 

func NewUnimplementedf(format string, args ...any) error

NewUnimplementedf returns new Unimplemented error with formatted message.

func NewWorkflowExecutionAlreadyStarted 

func NewWorkflowExecutionAlreadyStarted(message, startRequestId, runId string) error

NewWorkflowExecutionAlreadyStarted returns new WorkflowExecutionAlreadyStarted error.

func NewWorkflowExecutionAlreadyStartedf added in v1.50.0 

func NewWorkflowExecutionAlreadyStartedf(startRequestId, runId, format string, args ...any) error

NewWorkflowExecutionAlreadyStartedf returns new WorkflowExecutionAlreadyStarted error with formatted message.

func NewWorkflowNotReady added in v1.8.0 

func NewWorkflowNotReady(message string) error

NewWorkflowNotReady returns new WorkflowNotReady

func NewWorkflowNotReadyf added in v1.50.0 

func NewWorkflowNotReadyf(format string, args ...any) error

NewWorkflowNotReadyf returns new WorkflowNotReady error with formatted message.

func ToStatus 

func ToStatus(err error) *status.Status

ToStatus converts service error to gRPC Status. If error is not a service error it returns status with code Unknown.

Types

type Aborted added in v1.50.1 

type Aborted struct {
	Message string
	// contains filtered or unexported fields
}

Aborted represents an aborted error.

func (*Aborted) Error added in v1.50.1 

func (e *Aborted) Error() string

Error returns string message.

func (*Aborted) Status added in v1.50.1 

func (e *Aborted) Status() *status.Status

type ActivityExecutionAlreadyStarted added in v1.62.0 

type ActivityExecutionAlreadyStarted struct {
	Message        string
	StartRequestId string
	RunId          string
	// contains filtered or unexported fields
}

ActivityExecutionAlreadyStarted represents workflow execution already started error.

func (*ActivityExecutionAlreadyStarted) Error added in v1.62.0 

func (e *ActivityExecutionAlreadyStarted) Error() string

Error returns string message.

func (*ActivityExecutionAlreadyStarted) Status added in v1.62.0 

func (e *ActivityExecutionAlreadyStarted) Status() *status.Status

type AlreadyExists added in v1.8.0 

type AlreadyExists struct {
	Message string
	// contains filtered or unexported fields
}

AlreadyExists represents general AlreadyExists gRPC error.

func (*AlreadyExists) Error added in v1.8.0 

func (e *AlreadyExists) Error() string

Error returns string message.

func (*AlreadyExists) Status added in v1.8.0 

func (e *AlreadyExists) Status() *status.Status

type Canceled 

type Canceled struct {
	Message string
	// contains filtered or unexported fields
}

Canceled represents canceled error.

func (*Canceled) Error 

func (e *Canceled) Error() string

Error returns string message.

func (*Canceled) Status added in v0.31.0 

func (e *Canceled) Status() *status.Status

type CancellationAlreadyRequested 

type CancellationAlreadyRequested struct {
	Message string
	// contains filtered or unexported fields
}

CancellationAlreadyRequested represents cancellation already requested error.

func (*CancellationAlreadyRequested) Error 

func (e *CancellationAlreadyRequested) Error() string

Error returns string message.

func (*CancellationAlreadyRequested) Status added in v0.31.0 

func (e *CancellationAlreadyRequested) Status() *status.Status

type ClientVersionNotSupported 

type ClientVersionNotSupported struct {
	Message           string
	ClientVersion     string
	ClientName        string
	SupportedVersions string
	// contains filtered or unexported fields
}

ClientVersionNotSupported represents client version is not supported error.

func (*ClientVersionNotSupported) Error 

func (e *ClientVersionNotSupported) Error() string

Error returns string message.

func (*ClientVersionNotSupported) Status added in v0.31.0 

func (e *ClientVersionNotSupported) Status() *status.Status

type DataLoss 

type DataLoss struct {
	Message string
	// contains filtered or unexported fields
}

DataLoss represents data loss error.

func (*DataLoss) Error 

func (e *DataLoss) Error() string

Error returns string message.

func (*DataLoss) Status added in v0.31.0 

func (e *DataLoss) Status() *status.Status

type DeadlineExceeded 

type DeadlineExceeded struct {
	Message string
	// contains filtered or unexported fields
}

DeadlineExceeded represents deadline exceeded error.

func (*DeadlineExceeded) Error 

func (e *DeadlineExceeded) Error() string

Error returns string message.

func (*DeadlineExceeded) Status added in v0.31.0 

func (e *DeadlineExceeded) Status() *status.Status

type FailedPrecondition added in v1.8.0 

type FailedPrecondition struct {
	Message string
	// contains filtered or unexported fields
}

FailedPrecondition represents failed precondition error.

func (*FailedPrecondition) Error added in v1.8.0 

func (e *FailedPrecondition) Error() string

Error returns string message.

func (*FailedPrecondition) Status added in v1.8.0 

func (e *FailedPrecondition) Status() *status.Status

type Internal 

type Internal struct {
	Message string
	// contains filtered or unexported fields
}

Internal represents internal error.

func (*Internal) Error 

func (e *Internal) Error() string

Error returns string message.

func (*Internal) Status added in v0.31.0 

func (e *Internal) Status() *status.Status

type InvalidArgument 

type InvalidArgument struct {
	Message string
	// contains filtered or unexported fields
}

InvalidArgument represents invalid argument error.

func (*InvalidArgument) Error 

func (e *InvalidArgument) Error() string

Error returns string message.

func (*InvalidArgument) Status added in v0.31.0 

func (e *InvalidArgument) Status() *status.Status

type MultiOperationAborted added in v1.32.1 

type MultiOperationAborted struct {
	Message string
	// contains filtered or unexported fields
}

MultiOperationAborted represents an aborted operation from a MultiOperationExecution.

func (MultiOperationAborted) Error added in v1.32.1 

func (e MultiOperationAborted) Error() string

Error returns string message.

func (MultiOperationAborted) Status added in v1.32.1 

func (e MultiOperationAborted) Status() *status.Status

type MultiOperationExecution added in v1.32.1 

type MultiOperationExecution struct {
	Message string
	// contains filtered or unexported fields
}

MultiOperationExecution represents a MultiOperationExecution error.

func (*MultiOperationExecution) Error added in v1.32.1 

func (e *MultiOperationExecution) Error() string

Error returns string message.

func (*MultiOperationExecution) OperationErrors added in v1.32.1 

func (e *MultiOperationExecution) OperationErrors() []error

func (*MultiOperationExecution) Status added in v1.32.1 

func (e *MultiOperationExecution) Status() *status.Status

type NamespaceAlreadyExists 

type NamespaceAlreadyExists struct {
	Message string
	// contains filtered or unexported fields
}

NamespaceAlreadyExists represents namespace already exists error.

func (*NamespaceAlreadyExists) Error 

func (e *NamespaceAlreadyExists) Error() string

Error returns string message.

func (*NamespaceAlreadyExists) Status added in v0.31.0 

func (e *NamespaceAlreadyExists) Status() *status.Status

type NamespaceInvalidState added in v1.8.0 

type NamespaceInvalidState struct {
	Message       string
	Namespace     string
	State         enumspb.NamespaceState
	AllowedStates []enumspb.NamespaceState
	// contains filtered or unexported fields
}

NamespaceInvalidState represents namespace not active error.

func (*NamespaceInvalidState) Error added in v1.8.0 

func (e *NamespaceInvalidState) Error() string

Error returns string message.

func (*NamespaceInvalidState) Status added in v1.8.0 

func (e *NamespaceInvalidState) Status() *status.Status

type NamespaceNotActive 

type NamespaceNotActive struct {
	Message        string
	Namespace      string
	CurrentCluster string
	ActiveCluster  string
	// contains filtered or unexported fields
}

NamespaceNotActive represents namespace not active error.

func (*NamespaceNotActive) Error 

func (e *NamespaceNotActive) Error() string

Error returns string message.

func (*NamespaceNotActive) Status added in v0.31.0 

func (e *NamespaceNotActive) Status() *status.Status

type NamespaceNotFound added in v1.8.0 

type NamespaceNotFound struct {
	Message   string
	Namespace string
	// contains filtered or unexported fields
}

NamespaceNotFound represents namespace not found error.

func (*NamespaceNotFound) Error added in v1.8.0 

func (e *NamespaceNotFound) Error() string

Error returns string message.

func (*NamespaceNotFound) Status added in v1.8.0 

func (e *NamespaceNotFound) Status() *status.Status

type NamespaceUnavailable added in v1.43.1 

type NamespaceUnavailable struct {
	Namespace string
	// contains filtered or unexported fields
}

NamespaceUnavailable is returned by the service when a request addresses a namespace that is unavailable. For example, when a namespace is in the process of failing over between clusters. This is a transient error that should be automatically retried by clients.

func (*NamespaceUnavailable) Error added in v1.43.1 

func (e *NamespaceUnavailable) Error() string

Error returns string message.

func (*NamespaceUnavailable) Status added in v1.43.1 

func (e *NamespaceUnavailable) Status() *status.Status

type NewerBuildExists added in v1.21.0 

type NewerBuildExists struct {
	Message        string
	DefaultBuildID string
	// contains filtered or unexported fields
}

NewerBuildExists is returned to a poll request from a build that has been superceded by a newer build in versioning metadata.

func (*NewerBuildExists) Error added in v1.21.0 

func (e *NewerBuildExists) Error() string

Error returns string message.

func (*NewerBuildExists) Status added in v1.21.0 

func (e *NewerBuildExists) Status() *status.Status

type NotFound 

type NotFound struct {
	Message        string
	CurrentCluster string
	ActiveCluster  string
	// contains filtered or unexported fields
}

NotFound represents not found error.

func (*NotFound) Error 

func (e *NotFound) Error() string

Error returns string message.

func (*NotFound) Status added in v0.31.0 

func (e *NotFound) Status() *status.Status

type PermissionDenied 

type PermissionDenied struct {
	Message string
	Reason  string
	// contains filtered or unexported fields
}

PermissionDenied represents permission denied error.

func (*PermissionDenied) Error 

func (e *PermissionDenied) Error() string

Error returns string message.

func (*PermissionDenied) Status added in v0.31.0 

func (e *PermissionDenied) Status() *status.Status

type QueryFailed 

type QueryFailed struct {
	Message string
	// The full reason for this query failure. May not be available if the response is generated by an old SDK.
	Failure *failure.Failure
	// contains filtered or unexported fields
}

QueryFailed represents query failed error.

func (*QueryFailed) Error 

func (e *QueryFailed) Error() string

Error returns string message.

func (*QueryFailed) Status added in v0.31.0 

func (e *QueryFailed) Status() *status.Status

type ResourceExhausted 

type ResourceExhausted struct {
	Cause   enumspb.ResourceExhaustedCause
	Scope   enumspb.ResourceExhaustedScope
	Message string
	// contains filtered or unexported fields
}

ResourceExhausted represents resource exhausted error.

func (*ResourceExhausted) Error 

func (e *ResourceExhausted) Error() string

Error returns string message.

func (*ResourceExhausted) Status added in v0.31.0 

func (e *ResourceExhausted) Status() *status.Status

type ServerVersionNotSupported added in v1.0.0 

type ServerVersionNotSupported struct {
	Message                       string
	ServerVersion                 string
	ClientSupportedServerVersions string
	// contains filtered or unexported fields
}

ServerVersionNotSupported represents client version is not supported error.

func (*ServerVersionNotSupported) Error added in v1.0.0 

func (e *ServerVersionNotSupported) Error() string

Error returns string message.

func (*ServerVersionNotSupported) Status added in v1.0.0 

func (e *ServerVersionNotSupported) Status() *status.Status

type ServiceError 

type ServiceError interface {
	error
	Status() *status.Status
}

type SystemWorkflow added in v1.8.0 

type SystemWorkflow struct {
	WorkflowExecution *common.WorkflowExecution
	WorkflowError     string
	// contains filtered or unexported fields
}

SystemWorkflow represents an error that happens during execution of the underlying system workflow

func (*SystemWorkflow) Error added in v1.8.0 

func (e *SystemWorkflow) Error() string

Error returns string message.

func (*SystemWorkflow) Status added in v1.8.0 

func (e *SystemWorkflow) Status() *status.Status

type Unavailable 

type Unavailable struct {
	Message string
	// contains filtered or unexported fields
}

Unavailable represents unavailable error.

func (*Unavailable) Error 

func (e *Unavailable) Error() string

Error returns string message.

func (*Unavailable) Status added in v0.31.0 

func (e *Unavailable) Status() *status.Status

type Unimplemented 

type Unimplemented struct {
	Message string
	// contains filtered or unexported fields
}

Unimplemented represents unimplemented error.

func (*Unimplemented) Error 

func (e *Unimplemented) Error() string

Error returns string message.

func (*Unimplemented) Status added in v0.31.0 

func (e *Unimplemented) Status() *status.Status

type WorkflowExecutionAlreadyStarted 

type WorkflowExecutionAlreadyStarted struct {
	Message        string
	StartRequestId string
	RunId          string
	// contains filtered or unexported fields
}

WorkflowExecutionAlreadyStarted represents workflow execution already started error.

func (*WorkflowExecutionAlreadyStarted) Error 

func (e *WorkflowExecutionAlreadyStarted) Error() string

Error returns string message.

func (*WorkflowExecutionAlreadyStarted) Status added in v0.31.0 

func (e *WorkflowExecutionAlreadyStarted) Status() *status.Status

type WorkflowNotReady added in v1.8.0 

type WorkflowNotReady struct {
	Message string
	// contains filtered or unexported fields
}

WorkflowNotReady represents workflow state is not ready to handle the request error.

func (*WorkflowNotReady) Error added in v1.8.0 

func (e *WorkflowNotReady) Error() string

Error returns string message.

func (*WorkflowNotReady) Status added in v1.8.0 

func (e *WorkflowNotReady) Status() *status.Status

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.