Help us shape the future of Go! Take the 2026 Go Developer Survey

universal

package
v1.17.17 Latest Latest
Warning

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

 Go to latest Published: Oct 20, 2026 License: Apache-2.0 Imports: 60 Imported by: 0

Documentation

Overview

Package universal contains the implementation of APIs that are shared between gRPC and HTTP servers. On HTTP servers, they use protojson to convert data to/from JSON.

Index

Constants

View Source 
const ForceShutdownMetadataKey = "dapr-force-shutdown"

ForceShutdownMetadataKey is the gRPC metadata key (and HTTP header, after transport bridging) that, when set to "true", causes the sidecar to exit immediately via os.Exit(1) instead of performing a graceful shutdown.

Variables

This section is empty.

Functions

This section is empty.

Types

type Options 

type Options struct {
	AppID                       string
	Namespace                   string
	Logger                      logger.Logger
	Resiliency                  resiliency.Provider
	CompStore                   *compstore.ComponentStore
	ShutdownFn                  func()
	ExitFn                      func(int)
	GetComponentsCapabilitiesFn func() map[string][]string
	ExtendedMetadata            map[string]string
	AppConnectionConfig         config.AppConnectionConfig
	GlobalConfig                *config.Configuration
	Scheduler                   schedclient.Interface
	Actors                      actors.Interface
	WorkflowEngine              wfengine.Interface
}

type Universal 

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

Universal contains the implementation of gRPC APIs that are also used by the HTTP server.

func New 

func New(opts Options) *Universal

func (*Universal) ActorReminders added in v1.15.0 

func (a *Universal) ActorReminders(ctx context.Context) (reminders.Interface, error)

func (*Universal) ActorRouter added in v1.16.0 

func (a *Universal) ActorRouter(ctx context.Context) (router.Interface, error)

func (*Universal) ActorState added in v1.15.0 

func (a *Universal) ActorState(ctx context.Context) (state.Interface, error)

func (*Universal) ActorTimers added in v1.15.0 

func (a *Universal) ActorTimers(ctx context.Context) (timers.Interface, error)

func (*Universal) AppConnectionConfig 

func (a *Universal) AppConnectionConfig() config.AppConnectionConfig

func (*Universal) AppID 

func (a *Universal) AppID() string

func (*Universal) CompStore 

func (a *Universal) CompStore() *compstore.ComponentStore

func (*Universal) ConverseAlpha1 added in v1.15.0 

func (a *Universal) ConverseAlpha1(ctx context.Context, req *runtimev1pb.ConversationRequest) (*runtimev1pb.ConversationResponse, error)

func (*Universal) ConverseAlpha2 added in v1.16.0 

func (a *Universal) ConverseAlpha2(ctx context.Context, req *runtimev1pb.ConversationRequestAlpha2) (*runtimev1pb.ConversationResponseAlpha2, error)

func (*Universal) CryptoGetUnwrapKeyFn 

func (a *Universal) CryptoGetUnwrapKeyFn(ctx context.Context, componentName string, component contribCrypto.SubtleCrypto) encv1.UnwrapKeyFn

func (*Universal) CryptoGetWrapKeyFn 

func (a *Universal) CryptoGetWrapKeyFn(ctx context.Context, componentName string, component contribCrypto.SubtleCrypto) encv1.WrapKeyFn

func (*Universal) CryptoValidateRequest 

func (a *Universal) CryptoValidateRequest(componentName string) (contribCrypto.SubtleCrypto, error)

CryptoValidateRequest is an internal method that checks if the request is for a valid crypto component.

func (*Universal) DeleteJobAlpha1 added in v1.14.0 

func (a *Universal) DeleteJobAlpha1(ctx context.Context, inReq *runtimev1pb.DeleteJobRequest) (*runtimev1pb.DeleteJobResponse, error)

func (*Universal) DeleteJobsByPrefixAlpha1 added in v1.17.0 

func (a *Universal) DeleteJobsByPrefixAlpha1(ctx context.Context, req *runtimev1pb.DeleteJobsByPrefixRequestAlpha1) (*runtimev1pb.DeleteJobsByPrefixResponseAlpha1, error)

func (*Universal) GetActorReminder added in v1.17.0 

func (a *Universal) GetActorReminder(ctx context.Context, in *runtimev1pb.GetActorReminderRequest) (*runtimev1pb.GetActorReminderResponse, error)

func (*Universal) GetBulkSecret 

func (a *Universal) GetBulkSecret(ctx context.Context, in *runtimev1pb.GetBulkSecretRequest) (*runtimev1pb.GetBulkSecretResponse, error)

func (*Universal) GetJobAlpha1 added in v1.14.0 

func (a *Universal) GetJobAlpha1(ctx context.Context, inReq *runtimev1pb.GetJobRequest) (*runtimev1pb.GetJobResponse, error)

func (*Universal) GetMetadata 

func (a *Universal) GetMetadata(ctx context.Context, in *runtimev1pb.GetMetadataRequest) (*runtimev1pb.GetMetadataResponse, error)

func (*Universal) GetSecret 

func (a *Universal) GetSecret(ctx context.Context, in *runtimev1pb.GetSecretRequest) (*runtimev1pb.GetSecretResponse, error)

func (*Universal) GetStateStore 

func (a *Universal) GetStateStore(name string) (state.Store, error)

func (*Universal) GetWorkflow added in v1.15.0 

func (a *Universal) GetWorkflow(ctx context.Context, in *runtimev1pb.GetWorkflowRequest) (*runtimev1pb.GetWorkflowResponse, error)

GetWorkflow is the API handler for getting workflow details

func (*Universal) GetWorkflowAlpha1 

func (a *Universal) GetWorkflowAlpha1(ctx context.Context, in *runtimev1pb.GetWorkflowRequest) (*runtimev1pb.GetWorkflowResponse, error)

GetWorkflowAlpha1 is the API handler for getting workflow details Deprecated: Use GetWorkflow instead.

func (*Universal) GetWorkflowBeta1 

func (a *Universal) GetWorkflowBeta1(ctx context.Context, in *runtimev1pb.GetWorkflowRequest) (*runtimev1pb.GetWorkflowResponse, error)

GetWorkflowBeta1 is the API handler for getting workflow details

func (*Universal) ListActorReminders added in v1.17.0 

func (a *Universal) ListActorReminders(ctx context.Context, req *runtimev1pb.ListActorRemindersRequest) (*runtimev1pb.ListActorRemindersResponse, error)

func (*Universal) ListJobsAlpha1 added in v1.17.0 

func (a *Universal) ListJobsAlpha1(ctx context.Context, req *runtimev1pb.ListJobsRequestAlpha1) (*runtimev1pb.ListJobsResponseAlpha1, error)

func (*Universal) Namespace added in v1.14.0 

func (a *Universal) Namespace() string

func (*Universal) PauseWorkflow added in v1.15.0 

func (a *Universal) PauseWorkflow(ctx context.Context, in *runtimev1pb.PauseWorkflowRequest) (*emptypb.Empty, error)

PauseWorkflow is the API handler for pausing a workflow

func (*Universal) PauseWorkflowAlpha1 

func (a *Universal) PauseWorkflowAlpha1(ctx context.Context, in *runtimev1pb.PauseWorkflowRequest) (*emptypb.Empty, error)

PauseWorkflowAlpha1 is the API handler for pausing a workflow Deprecated: Use PauseWorkflow instead.

func (*Universal) PauseWorkflowBeta1 

func (a *Universal) PauseWorkflowBeta1(ctx context.Context, in *runtimev1pb.PauseWorkflowRequest) (*emptypb.Empty, error)

PauseWorkflowBeta1 is the API handler for pausing a workflow

func (*Universal) PurgeWorkflow added in v1.15.0 

func (a *Universal) PurgeWorkflow(ctx context.Context, in *runtimev1pb.PurgeWorkflowRequest) (*emptypb.Empty, error)

PurgeWorkflow is the API handler for purging a workflow

func (*Universal) PurgeWorkflowAlpha1 

func (a *Universal) PurgeWorkflowAlpha1(ctx context.Context, in *runtimev1pb.PurgeWorkflowRequest) (*emptypb.Empty, error)

PurgeWorkflowAlpha1 is the API handler for purging a workflow Deprecated: Use PurgeWorkflow instead.

func (*Universal) PurgeWorkflowBeta1 

func (a *Universal) PurgeWorkflowBeta1(ctx context.Context, in *runtimev1pb.PurgeWorkflowRequest) (*emptypb.Empty, error)

PurgeWorkflowBeta1 is the API handler for purging a workflow

func (*Universal) QueryStateAlpha1 

func (a *Universal) QueryStateAlpha1(ctx context.Context, in *runtimev1pb.QueryStateRequest) (*runtimev1pb.QueryStateResponse, error)

func (*Universal) RaiseEventWorkflow added in v1.15.0 

func (a *Universal) RaiseEventWorkflow(ctx context.Context, in *runtimev1pb.RaiseEventWorkflowRequest) (*emptypb.Empty, error)

RaiseEventWorkflow is the API handler for raising an event to a workflow

func (*Universal) RaiseEventWorkflowAlpha1 

func (a *Universal) RaiseEventWorkflowAlpha1(ctx context.Context, in *runtimev1pb.RaiseEventWorkflowRequest) (*emptypb.Empty, error)

RaiseEventWorkflowAlpha1 is the API handler for raising an event to a workflow Deprecated: Use RaiseEventWorkflow instead.

func (*Universal) RaiseEventWorkflowBeta1 

func (a *Universal) RaiseEventWorkflowBeta1(ctx context.Context, in *runtimev1pb.RaiseEventWorkflowRequest) (*emptypb.Empty, error)

RaiseEventWorkflowBeta1 is the API handler for raising an event to a workflow

func (*Universal) RegisterActorReminder added in v1.14.0 

func (a *Universal) RegisterActorReminder(ctx context.Context, in *runtimev1pb.RegisterActorReminderRequest) (*emptypb.Empty, error)

func (*Universal) RegisterActorTimer added in v1.14.0 

func (a *Universal) RegisterActorTimer(ctx context.Context, in *runtimev1pb.RegisterActorTimerRequest) (*emptypb.Empty, error)

func (*Universal) Resiliency 

func (a *Universal) Resiliency() resiliency.Provider

func (*Universal) ResumeWorkflow added in v1.15.0 

func (a *Universal) ResumeWorkflow(ctx context.Context, in *runtimev1pb.ResumeWorkflowRequest) (*emptypb.Empty, error)

ResumeWorkflow is the API handler for resuming a workflow

func (*Universal) ResumeWorkflowAlpha1 

func (a *Universal) ResumeWorkflowAlpha1(ctx context.Context, in *runtimev1pb.ResumeWorkflowRequest) (*emptypb.Empty, error)

ResumeWorkflowAlpha1 is the API handler for resuming a workflow Deprecated: Use ResumeWorkflow instead.

func (*Universal) ResumeWorkflowBeta1 

func (a *Universal) ResumeWorkflowBeta1(ctx context.Context, in *runtimev1pb.ResumeWorkflowRequest) (*emptypb.Empty, error)

ResumeWorkflowBeta1 is the API handler for resuming a workflow

func (*Universal) ScheduleJobAlpha1 added in v1.14.0 

func (a *Universal) ScheduleJobAlpha1(ctx context.Context, inReq *runtimev1pb.ScheduleJobRequest) (*runtimev1pb.ScheduleJobResponse, error)

func (*Universal) ScheduleJobAlpha1HTTP added in v1.14.3 

func (a *Universal) ScheduleJobAlpha1HTTP(ctx context.Context, job *internalsv1pb.JobHTTPRequest) (*runtimev1pb.ScheduleJobResponse, error)

func (*Universal) SetMetadata 

func (a *Universal) SetMetadata(ctx context.Context, in *runtimev1pb.SetMetadataRequest) (*emptypb.Empty, error)

SetMetadata Sets value in extended metadata of the sidecar.

func (*Universal) Shutdown 

func (a *Universal) Shutdown(ctx context.Context, _ *runtimev1pb.ShutdownRequest) (*emptypb.Empty, error)

Shutdown the sidecar.

func (*Universal) StartWorkflow added in v1.15.0 

func (a *Universal) StartWorkflow(ctx context.Context, in *runtimev1pb.StartWorkflowRequest) (*runtimev1pb.StartWorkflowResponse, error)

StartWorkflow is the API handler for starting a workflow

func (*Universal) StartWorkflowAlpha1 

func (a *Universal) StartWorkflowAlpha1(ctx context.Context, in *runtimev1pb.StartWorkflowRequest) (*runtimev1pb.StartWorkflowResponse, error)

StartWorkflowAlpha1 is the API handler for starting a workflow Deprecated: Use StartWorkflow instead.

func (*Universal) StartWorkflowBeta1 

func (a *Universal) StartWorkflowBeta1(ctx context.Context, in *runtimev1pb.StartWorkflowRequest) (*runtimev1pb.StartWorkflowResponse, error)

StartWorkflowBeta1 is the API handler for starting a workflow

func (*Universal) SubtleDecryptAlpha1 

func (a *Universal) SubtleDecryptAlpha1(ctx context.Context, in *runtimev1pb.SubtleDecryptRequest) (*runtimev1pb.SubtleDecryptResponse, error)

SubtleDecryptAlpha1 decrypts a small message using a key stored in the vault.

func (*Universal) SubtleEncryptAlpha1 

func (a *Universal) SubtleEncryptAlpha1(ctx context.Context, in *runtimev1pb.SubtleEncryptRequest) (*runtimev1pb.SubtleEncryptResponse, error)

SubtleEncryptAlpha1 encrypts a small message using a key stored in the vault.

func (*Universal) SubtleGetKeyAlpha1 

func (a *Universal) SubtleGetKeyAlpha1(ctx context.Context, in *runtimev1pb.SubtleGetKeyRequest) (*runtimev1pb.SubtleGetKeyResponse, error)

SubtleGetKeyAlpha1 returns the public part of an asymmetric key stored in the vault.

func (*Universal) SubtleSignAlpha1 

func (a *Universal) SubtleSignAlpha1(ctx context.Context, in *runtimev1pb.SubtleSignRequest) (*runtimev1pb.SubtleSignResponse, error)

SubtleSignAlpha1 signs a message using a key stored in the vault.

func (*Universal) SubtleUnwrapKeyAlpha1 

func (a *Universal) SubtleUnwrapKeyAlpha1(ctx context.Context, in *runtimev1pb.SubtleUnwrapKeyRequest) (*runtimev1pb.SubtleUnwrapKeyResponse, error)

SubtleUnwrapKeyAlpha1 unwraps a key using a key stored in the vault.

func (*Universal) SubtleVerifyAlpha1 

func (a *Universal) SubtleVerifyAlpha1(ctx context.Context, in *runtimev1pb.SubtleVerifyRequest) (*runtimev1pb.SubtleVerifyResponse, error)

SubtleVerifyAlpha1 verifies the signature of a message using a key stored in the vault.

func (*Universal) SubtleWrapKeyAlpha1 

func (a *Universal) SubtleWrapKeyAlpha1(ctx context.Context, in *runtimev1pb.SubtleWrapKeyRequest) (*runtimev1pb.SubtleWrapKeyResponse, error)

SubtleWrapKeyAlpha1 wraps a key using a key stored in the vault.

func (*Universal) TerminateWorkflow added in v1.15.0 

func (a *Universal) TerminateWorkflow(ctx context.Context, in *runtimev1pb.TerminateWorkflowRequest) (*emptypb.Empty, error)

TerminateWorkflow is the API handler for terminating a workflow

func (*Universal) TerminateWorkflowAlpha1 

func (a *Universal) TerminateWorkflowAlpha1(ctx context.Context, in *runtimev1pb.TerminateWorkflowRequest) (*emptypb.Empty, error)

TerminateWorkflowAlpha1 is the API handler for terminating a workflow Deprecated: Use TerminateWorkflow instead.

func (*Universal) TerminateWorkflowBeta1 

func (a *Universal) TerminateWorkflowBeta1(ctx context.Context, in *runtimev1pb.TerminateWorkflowRequest) (*emptypb.Empty, error)

TerminateWorkflowBeta1 is the API handler for terminating a workflow

func (*Universal) TryLockAlpha1 

func (a *Universal) TryLockAlpha1(ctx context.Context, req *runtimev1pb.TryLockRequest) (*runtimev1pb.TryLockResponse, error)

func (*Universal) UnlockAlpha1 

func (a *Universal) UnlockAlpha1(ctx context.Context, req *runtimev1pb.UnlockRequest) (*runtimev1pb.UnlockResponse, error)

func (*Universal) UnregisterActorReminder added in v1.14.0 

func (a *Universal) UnregisterActorReminder(ctx context.Context, in *runtimev1pb.UnregisterActorReminderRequest) (*emptypb.Empty, error)

func (*Universal) UnregisterActorRemindersByType added in v1.17.0 

func (a *Universal) UnregisterActorRemindersByType(ctx context.Context, in *runtimev1pb.UnregisterActorRemindersByTypeRequest) (*runtimev1pb.UnregisterActorRemindersByTypeResponse, error)

func (*Universal) UnregisterActorTimer added in v1.14.0 

func (a *Universal) UnregisterActorTimer(ctx context.Context, in *runtimev1pb.UnregisterActorTimerRequest) (*emptypb.Empty, error)

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.