client

package
v1.10.1 Latest Latest
Warning

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

 Go to latest Published: Mar 6, 2024 License: Apache-2.0 Imports: 31 Imported by: 243

Documentation

Overview

Copyright 2024 The Dapr Authors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

Constants

View Source 
const (
	// StateConsistencyUndefined is the undefined value for state consistency.
	StateConsistencyUndefined StateConsistency = 0
	// StateConsistencyEventual represents eventual state consistency value.
	StateConsistencyEventual StateConsistency = 1
	// StateConsistencyStrong represents strong state consistency value.
	StateConsistencyStrong StateConsistency = 2

	// StateConcurrencyUndefined is the undefined value for state concurrency.
	StateConcurrencyUndefined StateConcurrency = 0
	// StateConcurrencyFirstWrite represents first write concurrency value.
	StateConcurrencyFirstWrite StateConcurrency = 1
	// StateConcurrencyLastWrite represents last write concurrency value.
	StateConcurrencyLastWrite StateConcurrency = 2

	// StateOperationTypeUndefined is the undefined value for state operation type.
	StateOperationTypeUndefined OperationType = 0
	// StateOperationTypeUpsert represents upsert operation type value.
	StateOperationTypeUpsert OperationType = 1
	// StateOperationTypeDelete represents delete operation type value.
	StateOperationTypeDelete OperationType = 2

	// EventualType represents the eventual type value.
	EventualType = "eventual"
	// StrongType represents the strong type value.
	StrongType = "strong"
	// FirstWriteType represents the first write type value.
	FirstWriteType = "first-write"
	// LastWriteType represents the last write type value.
	LastWriteType = "last-write"
	// UpsertType represents the upsert type value.
	UpsertType = "upsert"
	// DeleteType represents the delete type value.
	DeleteType = "delete"
	// UndefinedType represents undefined type value.
	UndefinedType = "undefined"
)
View Source 
const (
	DefaultWorkflowComponent = "dapr"
)
View Source 
const StreamBufferSize = 2 << 10

Maximum size, in bytes, for the buffer used by stream invocations: 2KB.

Variables

This section is empty.

Functions

func SetLogger added in v1.10.0 

func SetLogger(l *log.Logger)

SetLogger sets the global logger for the Dapr client. The default logger has a destination of os.Stdout, SetLogger allows you to optionally specify a custom logger (with a custom destination). To disable client logging entirely, use a nil argument e.g.: client.SetLogger(nil)

Types

type ActorStateOperation added in v1.3.0 

type ActorStateOperation struct {
	OperationType string
	Key           string
	Value         []byte
	TTLInSeconds  *int64
}

type BindingEvent added in v0.10.0 

type BindingEvent struct {
	// Data is the input bindings sent
	Data []byte
	// Metadata is the input binding metadata
	Metadata map[string]string
}

BindingEvent represents the binding event handler input.

type BulkStateItem added in v1.0.0 

type BulkStateItem struct {
	Key      string
	Value    []byte
	Etag     string
	Metadata map[string]string
	Error    string
}

BulkStateItem represents a single state item.

type Client 

type Client interface {
	// InvokeBinding invokes specific operation on the configured Dapr binding.
	// This method covers input, output, and bi-directional bindings.
	InvokeBinding(ctx context.Context, in *InvokeBindingRequest) (out *BindingEvent, err error)

	// InvokeOutputBinding invokes configured Dapr binding with data.InvokeOutputBinding
	// This method differs from InvokeBinding in that it doesn't expect any content being returned from the invoked method.
	InvokeOutputBinding(ctx context.Context, in *InvokeBindingRequest) error

	// InvokeMethod invokes service without raw data
	InvokeMethod(ctx context.Context, appID, methodName, verb string) (out []byte, err error)

	// InvokeMethodWithContent invokes service with content
	InvokeMethodWithContent(ctx context.Context, appID, methodName, verb string, content *DataContent) (out []byte, err error)

	// InvokeMethodWithCustomContent invokes app with custom content (struct + content type).
	InvokeMethodWithCustomContent(ctx context.Context, appID, methodName, verb string, contentType string, content interface{}) (out []byte, err error)

	// GetMetadata returns metadata from the sidecar.
	GetMetadata(ctx context.Context) (metadata *GetMetadataResponse, err error)

	// SetMetadata sets a key-value pair in the sidecar.
	SetMetadata(ctx context.Context, key, value string) error

	// PublishEvent publishes data onto topic in specific pubsub component.
	PublishEvent(ctx context.Context, pubsubName, topicName string, data interface{}, opts ...PublishEventOption) error

	// PublishEventfromCustomContent serializes an struct and publishes its contents as data (JSON) onto topic in specific pubsub component.
	// Deprecated: This method is deprecated and will be removed in a future version of the SDK. Please use `PublishEvent` instead.
	PublishEventfromCustomContent(ctx context.Context, pubsubName, topicName string, data interface{}) error

	// PublishEvents publishes multiple events onto topic in specific pubsub component.
	// If all events are successfully published, response Error will be nil.
	// The FailedEvents field will contain all events that failed to publish.
	PublishEvents(ctx context.Context, pubsubName, topicName string, events []interface{}, opts ...PublishEventsOption) PublishEventsResponse

	// GetSecret retrieves preconfigured secret from specified store using key.
	GetSecret(ctx context.Context, storeName, key string, meta map[string]string) (data map[string]string, err error)

	// GetBulkSecret retrieves all preconfigured secrets for this application.
	GetBulkSecret(ctx context.Context, storeName string, meta map[string]string) (data map[string]map[string]string, err error)

	// SaveState saves the raw data into store using default state options.
	SaveState(ctx context.Context, storeName, key string, data []byte, meta map[string]string, so ...StateOption) error

	// SaveState saves the raw data into store using provided state options and etag.
	SaveStateWithETag(ctx context.Context, storeName, key string, data []byte, etag string, meta map[string]string, so ...StateOption) error

	// SaveBulkState saves multiple state item to store with specified options.
	SaveBulkState(ctx context.Context, storeName string, items ...*SetStateItem) error

	// GetState retrieves state from specific store using default consistency option.
	GetState(ctx context.Context, storeName, key string, meta map[string]string) (item *StateItem, err error)

	// GetStateWithConsistency retrieves state from specific store using provided state consistency.
	GetStateWithConsistency(ctx context.Context, storeName, key string, meta map[string]string, sc StateConsistency) (item *StateItem, err error)

	// GetBulkState retrieves state for multiple keys from specific store.
	GetBulkState(ctx context.Context, storeName string, keys []string, meta map[string]string, parallelism int32) ([]*BulkStateItem, error)

	// QueryStateAlpha1 runs a query against state store.
	QueryStateAlpha1(ctx context.Context, storeName, query string, meta map[string]string) (*QueryResponse, error)

	// DeleteState deletes content from store using default state options.
	DeleteState(ctx context.Context, storeName, key string, meta map[string]string) error

	// DeleteStateWithETag deletes content from store using provided state options and etag.
	DeleteStateWithETag(ctx context.Context, storeName, key string, etag *ETag, meta map[string]string, opts *StateOptions) error

	// ExecuteStateTransaction provides way to execute multiple operations on a specified store.
	ExecuteStateTransaction(ctx context.Context, storeName string, meta map[string]string, ops []*StateOperation) error

	// GetConfigurationItem can get target configuration item by storeName and key
	GetConfigurationItem(ctx context.Context, storeName, key string, opts ...ConfigurationOpt) (*ConfigurationItem, error)

	// GetConfigurationItems can get a list of configuration item by storeName and keys
	GetConfigurationItems(ctx context.Context, storeName string, keys []string, opts ...ConfigurationOpt) (map[string]*ConfigurationItem, error)

	// SubscribeConfigurationItems can subscribe the change of configuration items by storeName and keys, and return subscription id
	SubscribeConfigurationItems(ctx context.Context, storeName string, keys []string, handler ConfigurationHandleFunction, opts ...ConfigurationOpt) (string, error)

	// UnsubscribeConfigurationItems stops the subscription with target store's and ID.
	// Deprecated: Closing the `SubscribeConfigurationItems` stream (closing the given context) will unsubscribe the client and should be used in favor of `UnsubscribeConfigurationItems`.
	// UnsubscribeConfigurationItems can stop the subscription with target store's and id
	UnsubscribeConfigurationItems(ctx context.Context, storeName string, id string, opts ...ConfigurationOpt) error

	// DeleteBulkState deletes content for multiple keys from store.
	DeleteBulkState(ctx context.Context, storeName string, keys []string, meta map[string]string) error

	// DeleteBulkStateItems deletes content for multiple items from store.
	DeleteBulkStateItems(ctx context.Context, storeName string, items []*DeleteStateItem) error

	// TryLockAlpha1 attempts to grab a lock from a lock store.
	TryLockAlpha1(ctx context.Context, storeName string, request *LockRequest) (*LockResponse, error)

	// UnlockAlpha1 deletes unlocks a lock from a lock store.
	UnlockAlpha1(ctx context.Context, storeName string, request *UnlockRequest) (*UnlockResponse, error)

	// Encrypt data read from a stream, returning a readable stream that receives the encrypted data.
	// This method returns an error if the initial call fails. Errors performed during the encryption are received by the out stream.
	Encrypt(ctx context.Context, in io.Reader, opts EncryptOptions) (io.Reader, error)

	// Decrypt data read from a stream, returning a readable stream that receives the decrypted data.
	// This method returns an error if the initial call fails. Errors performed during the encryption are received by the out stream.
	Decrypt(ctx context.Context, in io.Reader, opts DecryptOptions) (io.Reader, error)

	// Shutdown the sidecar.
	Shutdown(ctx context.Context) error

	// Wait for a  sidecar to become available for at most `timeout` seconds. Returns errWaitTimedOut if timeout is reached.
	Wait(ctx context.Context, timeout time.Duration) error

	// WithTraceID adds existing trace ID to the outgoing context.
	WithTraceID(ctx context.Context, id string) context.Context

	// WithAuthToken sets Dapr API token on the instantiated client.
	WithAuthToken(token string)

	// Close cleans up all resources created by the client.
	Close()

	// RegisterActorTimer registers an actor timer.
	RegisterActorTimer(ctx context.Context, req *RegisterActorTimerRequest) error

	// UnregisterActorTimer unregisters an actor timer.
	UnregisterActorTimer(ctx context.Context, req *UnregisterActorTimerRequest) error

	// RegisterActorReminder registers an actor reminder.
	RegisterActorReminder(ctx context.Context, req *RegisterActorReminderRequest) error

	// UnregisterActorReminder unregisters an actor reminder.
	UnregisterActorReminder(ctx context.Context, req *UnregisterActorReminderRequest) error

	// InvokeActor calls a method on an actor.
	InvokeActor(ctx context.Context, req *InvokeActorRequest) (*InvokeActorResponse, error)

	// GetActorState get actor state
	GetActorState(ctx context.Context, req *GetActorStateRequest) (data *GetActorStateResponse, err error)

	// SaveStateTransactionally save actor state
	SaveStateTransactionally(ctx context.Context, actorType, actorID string, operations []*ActorStateOperation) error

	// ImplActorClientStub is to impl user defined actor client stub
	ImplActorClientStub(actorClientStub actor.Client, opt ...config.Option)

	// StartWorkflowBeta1 starts a workflow.
	StartWorkflowBeta1(ctx context.Context, req *StartWorkflowRequest) (*StartWorkflowResponse, error)

	// GetWorkflowBeta1 gets a workflow.
	GetWorkflowBeta1(ctx context.Context, req *GetWorkflowRequest) (*GetWorkflowResponse, error)

	// PurgeWorkflowBeta1 purges a workflow.
	PurgeWorkflowBeta1(ctx context.Context, req *PurgeWorkflowRequest) error

	// TerminateWorkflowBeta1 terminates a workflow.
	TerminateWorkflowBeta1(ctx context.Context, req *TerminateWorkflowRequest) error

	// PauseWorkflowBeta1 pauses a workflow.
	PauseWorkflowBeta1(ctx context.Context, req *PauseWorkflowRequest) error

	// ResumeWorkflowBeta1 resumes a workflow.
	ResumeWorkflowBeta1(ctx context.Context, req *ResumeWorkflowRequest) error

	// RaiseEventWorkflowBeta1 raises an event for a workflow.
	RaiseEventWorkflowBeta1(ctx context.Context, req *RaiseEventWorkflowRequest) error

	// GrpcClient returns the base grpc client if grpc is used and nil otherwise
	GrpcClient() pb.DaprClient

	GrpcClientConn() *grpc.ClientConn
}

Client is the interface for Dapr client implementation.

func NewClient 

func NewClient() (client Client, err error)

NewClient instantiates Dapr client using DAPR_GRPC_PORT environment variable as port. Note, this default factory function creates Dapr client only once. All subsequent invocations will return the already created instance. To create multiple instances of the Dapr client, use one of the parameterized factory functions: 

NewClientWithPort(port string) (client Client, err error)
NewClientWithAddress(address string) (client Client, err error)
NewClientWithConnection(conn *grpc.ClientConn) Client
NewClientWithSocket(socket string) (client Client, err error)

func NewClientWithAddress 

func NewClientWithAddress(address string) (client Client, err error)

NewClientWithAddress instantiates Dapr using specific address (including port). Deprecated: use NewClientWithAddressContext instead.

func NewClientWithAddressContext added in v1.8.0 

func NewClientWithAddressContext(ctx context.Context, address string) (client Client, err error)

NewClientWithAddressContext instantiates Dapr using specific address (including port). Uses the provided context to create the connection.

func NewClientWithConnection 

func NewClientWithConnection(conn *grpc.ClientConn) Client

NewClientWithConnection instantiates Dapr client using specific connection.

func NewClientWithPort 

func NewClientWithPort(port string) (client Client, err error)

NewClientWithPort instantiates Dapr using specific gRPC port.

func NewClientWithSocket added in v1.3.1 

func NewClientWithSocket(socket string) (client Client, err error)

NewClientWithSocket instantiates Dapr using specific socket.

type ConfigurationHandleFunction added in v1.4.0 

type ConfigurationHandleFunction func(string, map[string]*ConfigurationItem)

type ConfigurationItem added in v1.4.0 

type ConfigurationItem struct {
	Value    string
	Version  string
	Metadata map[string]string
}

type ConfigurationOpt added in v1.4.0 

type ConfigurationOpt func(map[string]string)

func WithConfigurationMetadata added in v1.4.0 

func WithConfigurationMetadata(key, value string) ConfigurationOpt

type DataContent added in v0.10.0 

type DataContent struct {
	// Data is the input data
	Data []byte
	// ContentType is the type of the data content
	ContentType string
}

DataContent the service invocation content.

type DecryptOptions added in v1.8.0 

type DecryptOptions struct {
	// Name of the component. Required.
	ComponentName string
	// Name (or name/version) of the key to decrypt the message.
	// Overrides any key reference included in the message if present.
	// This is required if the message doesn't include a key reference (i.e. was created with omit_decryption_key_name set to true).
	KeyName string
}

DecryptOptions contains options passed to the Decrypt method.

type DeleteStateItem added in v1.0.0 

type DeleteStateItem SetStateItem

DeleteStateItem represents a single state to be deleted.

type ETag added in v1.0.0 

type ETag struct {
	Value string
}

ETag represents an versioned record information.

type EncryptOptions added in v1.8.0 

type EncryptOptions struct {
	// Name of the component. Required.
	ComponentName string
	// Name (or name/version) of the key. Required.
	KeyName string
	// Key wrapping algorithm to use. Required.
	// Supported options include: A256KW, A128CBC, A192CBC, A256CBC, RSA-OAEP-256.
	KeyWrapAlgorithm string
	// DataEncryptionCipher to use to encrypt data (optional): "aes-gcm" (default) or "chacha20-poly1305"
	DataEncryptionCipher string
	// If true, the encrypted document does not contain a key reference.
	// In that case, calls to the Decrypt method must provide a key reference (name or name/version).
	// Defaults to false.
	OmitDecryptionKeyName bool
	// Key reference to embed in the encrypted document (name or name/version).
	// This is helpful if the reference of the key used to decrypt the document is different from the one used to encrypt it.
	// If unset, uses the reference of the key used to encrypt the document (this is the default behavior).
	// This option is ignored if omit_decryption_key_name is true.
	DecryptionKeyName string
}

EncryptOptions contains options passed to the Encrypt method.

type GRPCClient 

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

GRPCClient is the gRPC implementation of Dapr client.

func (*GRPCClient) Close 

func (c *GRPCClient) Close()

Close cleans up all resources created by the client.

func (*GRPCClient) Decrypt added in v1.8.0 

func (c *GRPCClient) Decrypt(ctx context.Context, in io.Reader, opts DecryptOptions) (io.Reader, error)

Decrypt data read from a stream, returning a readable stream that receives the decrypted data. This method returns an error if the initial call fails. Errors performed during the encryption are received by the out stream.

func (*GRPCClient) DeleteBulkState added in v1.0.0 

func (c *GRPCClient) DeleteBulkState(ctx context.Context, storeName string, keys []string, meta map[string]string) error

DeleteBulkState deletes content for multiple keys from store.

func (*GRPCClient) DeleteBulkStateItems added in v1.0.0 

func (c *GRPCClient) DeleteBulkStateItems(ctx context.Context, storeName string, items []*DeleteStateItem) error

DeleteBulkStateItems deletes content for multiple items from store.

func (*GRPCClient) DeleteState 

func (c *GRPCClient) DeleteState(ctx context.Context, storeName, key string, meta map[string]string) error

DeleteState deletes content from store using default state options.

func (*GRPCClient) DeleteStateWithETag added in v0.10.0 

func (c *GRPCClient) DeleteStateWithETag(ctx context.Context, storeName, key string, etag *ETag, meta map[string]string, opts *StateOptions) error

DeleteStateWithETag deletes content from store using provided state options and etag.

func (*GRPCClient) Encrypt added in v1.8.0 

func (c *GRPCClient) Encrypt(ctx context.Context, in io.Reader, opts EncryptOptions) (io.Reader, error)

Encrypt data read from a stream, returning a readable stream that receives the encrypted data. This method returns an error if the initial call fails. Errors performed during the encryption are received by the out stream.

func (*GRPCClient) ExecuteStateTransaction added in v0.10.0 

func (c *GRPCClient) ExecuteStateTransaction(ctx context.Context, storeName string, meta map[string]string, ops []*StateOperation) error

ExecuteStateTransaction provides way to execute multiple operations on a specified store.

func (*GRPCClient) GetActorState added in v1.3.0 

func (c *GRPCClient) GetActorState(ctx context.Context, in *GetActorStateRequest) (*GetActorStateResponse, error)

func (*GRPCClient) GetBulkSecret added in v1.0.0 

func (c *GRPCClient) GetBulkSecret(ctx context.Context, storeName string, meta map[string]string) (data map[string]map[string]string, err error)

GetBulkSecret retrieves all preconfigured secrets for this application.

func (*GRPCClient) GetBulkState added in v1.0.0 

func (c *GRPCClient) GetBulkState(ctx context.Context, storeName string, keys []string, meta map[string]string, parallelism int32) ([]*BulkStateItem, error)

GetBulkState retrieves state for multiple keys from specific store.

func (*GRPCClient) GetConfigurationItem added in v1.4.0 

func (c *GRPCClient) GetConfigurationItem(ctx context.Context, storeName, key string, opts ...ConfigurationOpt) (*ConfigurationItem, error)

func (*GRPCClient) GetConfigurationItems added in v1.4.0 

func (c *GRPCClient) GetConfigurationItems(ctx context.Context, storeName string, keys []string, opts ...ConfigurationOpt) (map[string]*ConfigurationItem, error)

func (*GRPCClient) GetMetadata added in v1.9.0 

func (c *GRPCClient) GetMetadata(ctx context.Context) (metadata *GetMetadataResponse, err error)

GetMetadata returns the metadata of the sidecar

func (*GRPCClient) GetSecret 

func (c *GRPCClient) GetSecret(ctx context.Context, storeName, key string, meta map[string]string) (data map[string]string, err error)

GetSecret retrieves preconfigured secret from specified store using key.

func (*GRPCClient) GetState 

func (c *GRPCClient) GetState(ctx context.Context, storeName, key string, meta map[string]string) (item *StateItem, err error)

GetState retrieves state from specific store using default consistency option.

func (*GRPCClient) GetStateWithConsistency 

func (c *GRPCClient) GetStateWithConsistency(ctx context.Context, storeName, key string, meta map[string]string, sc StateConsistency) (*StateItem, error)

GetStateWithConsistency retrieves state from specific store using provided state consistency.

func (*GRPCClient) GetWorkflowBeta1 added in v1.10.0 

func (c *GRPCClient) GetWorkflowBeta1(ctx context.Context, req *GetWorkflowRequest) (*GetWorkflowResponse, error)

GetWorkflowBeta1 gets the status of a workflow using the beta1 spec.

func (*GRPCClient) GrpcClient added in v1.5.0 

func (c *GRPCClient) GrpcClient() pb.DaprClient

GrpcClient returns the base grpc client.

func (*GRPCClient) GrpcClientConn added in v1.6.0 

func (c *GRPCClient) GrpcClientConn() *grpc.ClientConn

GrpcClientConn returns the grpc.ClientConn object used by this client.

func (*GRPCClient) ImplActorClientStub added in v1.3.0 

func (c *GRPCClient) ImplActorClientStub(actorClientStub actor.Client, opt ...config.Option)

ImplActorClientStub impls the given client stub @actorClientStub, an example of client stub is as followed

type ClientStub struct { // User defined function 

	GetUser       func(context.Context, *User) (*User, error)
	Invoke        func(context.Context, string) (string, error)
	Get           func(context.Context) (string, error)
	Post          func(context.Context, string) error
	StartTimer    func(context.Context, *TimerRequest) error
	StopTimer     func(context.Context, *TimerRequest) error
	...
}

// Type defined the target type, which should be compatible with server side actor 

func (a *ClientStub) Type() string {
	return "testActorType"
}

// ID defined actor ID to be invoked 

func (a *ClientStub) ID() string {
	return "ActorImplID123456"
}.

func (*GRPCClient) InvokeActor added in v1.3.0 

func (c *GRPCClient) InvokeActor(ctx context.Context, in *InvokeActorRequest) (out *InvokeActorResponse, err error)

InvokeActor invokes specific operation on the configured Dapr binding. This method covers input, output, and bi-directional bindings.

func (*GRPCClient) InvokeBinding 

func (c *GRPCClient) InvokeBinding(ctx context.Context, in *InvokeBindingRequest) (*BindingEvent, error)

InvokeBinding invokes specific operation on the configured Dapr binding. This method covers input, output, and bi-directional bindings.

func (*GRPCClient) InvokeMethod added in v1.0.0 

func (c *GRPCClient) InvokeMethod(ctx context.Context, appID, methodName, verb string) (out []byte, err error)

InvokeMethod invokes service without raw data ([]byte).

func (*GRPCClient) InvokeMethodWithContent added in v1.0.0 

func (c *GRPCClient) InvokeMethodWithContent(ctx context.Context, appID, methodName, verb string, content *DataContent) (out []byte, err error)

InvokeMethodWithContent invokes service with content (data + content type).

func (*GRPCClient) InvokeMethodWithCustomContent added in v1.0.0 

func (c *GRPCClient) InvokeMethodWithCustomContent(ctx context.Context, appID, methodName, verb string, contentType string, content interface{}) ([]byte, error)

InvokeMethodWithCustomContent invokes service with custom content (struct + content type).

func (*GRPCClient) InvokeOutputBinding 

func (c *GRPCClient) InvokeOutputBinding(ctx context.Context, in *InvokeBindingRequest) error

InvokeOutputBinding invokes configured Dapr binding with data (allows nil).InvokeOutputBinding This method differs from InvokeBinding in that it doesn't expect any content being returned from the invoked method.

func (*GRPCClient) PauseWorkflowBeta1 added in v1.10.0 

func (c *GRPCClient) PauseWorkflowBeta1(ctx context.Context, req *PauseWorkflowRequest) error

PauseWorkflowBeta1 pauses a workflow that can be resumed later using the beta1 spec.

func (*GRPCClient) PublishEvent 

func (c *GRPCClient) PublishEvent(ctx context.Context, pubsubName, topicName string, data interface{}, opts ...PublishEventOption) error

PublishEvent publishes data onto specific pubsub topic.

func (*GRPCClient) PublishEventfromCustomContent added in v1.0.0 

func (c *GRPCClient) PublishEventfromCustomContent(ctx context.Context, pubsubName, topicName string, data interface{}) error

PublishEventfromCustomContent serializes an struct and publishes its contents as data (JSON) onto topic in specific pubsub component. Deprecated: This method is deprecated and will be removed in a future version of the SDK. Please use `PublishEvent` instead.

func (*GRPCClient) PublishEvents added in v1.8.0 

func (c *GRPCClient) PublishEvents(ctx context.Context, pubsubName, topicName string, events []interface{}, opts ...PublishEventsOption) PublishEventsResponse

PublishEvents publishes multiple events onto topic in specific pubsub component. If all events are successfully published, response Error will be nil. The FailedEvents field will contain all events that failed to publish.

func (*GRPCClient) PurgeWorkflowBeta1 added in v1.10.0 

func (c *GRPCClient) PurgeWorkflowBeta1(ctx context.Context, req *PurgeWorkflowRequest) error

PurgeWorkflowBeta1 removes all metadata relating to a specific workflow using the beta1 spec.

func (*GRPCClient) QueryStateAlpha1 added in v1.3.1 

func (c *GRPCClient) QueryStateAlpha1(ctx context.Context, storeName, query string, meta map[string]string) (*QueryResponse, error)

QueryStateAlpha1 runs a query against state store.

func (*GRPCClient) RaiseEventWorkflowBeta1 added in v1.10.0 

func (c *GRPCClient) RaiseEventWorkflowBeta1(ctx context.Context, req *RaiseEventWorkflowRequest) error

RaiseEventWorkflowBeta1 raises an event on a workflow using the beta1 spec.

func (*GRPCClient) RegisterActorReminder added in v1.3.0 

func (c *GRPCClient) RegisterActorReminder(ctx context.Context, in *RegisterActorReminderRequest) (err error)

RegisterActorReminder registers a new reminder to target actor. Then, a reminder would be created and invoke actor's ReminderCall function if implemented. If server side actor impls this function, it's asserted to actor.ReminderCallee and can be invoked with call period and state data as param @in defined. Scheduling parameters 'DueTime', 'Period', and 'TTL' are optional.

func (*GRPCClient) RegisterActorTimer added in v1.3.0 

func (c *GRPCClient) RegisterActorTimer(ctx context.Context, in *RegisterActorTimerRequest) (err error)

RegisterActorTimer register actor timer as given param @in defined. Scheduling parameters 'DueTime', 'Period', and 'TTL' are optional.

func (*GRPCClient) ResumeWorkflowBeta1 added in v1.10.0 

func (c *GRPCClient) ResumeWorkflowBeta1(ctx context.Context, req *ResumeWorkflowRequest) error

ResumeWorkflowBeta1 resumes a paused workflow using the beta1 spec.

func (*GRPCClient) SaveBulkState added in v1.0.0 

func (c *GRPCClient) SaveBulkState(ctx context.Context, storeName string, items ...*SetStateItem) error

SaveBulkState saves the multiple state item to store.

func (*GRPCClient) SaveState 

func (c *GRPCClient) SaveState(ctx context.Context, storeName, key string, data []byte, meta map[string]string, so ...StateOption) error

SaveState saves the raw data into store, default options: strong, last-write.

func (*GRPCClient) SaveStateTransactionally added in v1.3.0 

func (c *GRPCClient) SaveStateTransactionally(ctx context.Context, actorType, actorID string, operations []*ActorStateOperation) error

func (*GRPCClient) SaveStateWithETag added in v1.6.0 

func (c *GRPCClient) SaveStateWithETag(ctx context.Context, storeName, key string, data []byte, etag string, meta map[string]string, so ...StateOption) error

SaveStateWithETag saves the raw data into store using provided state options and etag.

func (*GRPCClient) SetMetadata added in v1.9.0 

func (c *GRPCClient) SetMetadata(ctx context.Context, key, value string) error

SetMetadata sets a value in the extended metadata of the sidecar

func (*GRPCClient) Shutdown added in v1.1.0 

func (c *GRPCClient) Shutdown(ctx context.Context) error

Shutdown the sidecar.

func (*GRPCClient) StartWorkflowBeta1 added in v1.10.0 

func (c *GRPCClient) StartWorkflowBeta1(ctx context.Context, req *StartWorkflowRequest) (*StartWorkflowResponse, error)

StartWorkflowBeta1 starts a workflow using the beta1 spec.

func (*GRPCClient) SubscribeConfigurationItems added in v1.4.0 

func (c *GRPCClient) SubscribeConfigurationItems(ctx context.Context, storeName string, keys []string, handler ConfigurationHandleFunction, opts ...ConfigurationOpt) (string, error)

func (*GRPCClient) TerminateWorkflowBeta1 added in v1.10.0 

func (c *GRPCClient) TerminateWorkflowBeta1(ctx context.Context, req *TerminateWorkflowRequest) error

TerminateWorkflowBeta1 stops a workflow using the beta1 spec.

func (*GRPCClient) TryLockAlpha1 added in v1.5.0 

func (c *GRPCClient) TryLockAlpha1(ctx context.Context, storeName string, request *LockRequest) (*LockResponse, error)

TryLockAlpha1 attempts to grab a lock from a lock store.

func (*GRPCClient) UnlockAlpha1 added in v1.5.0 

func (c *GRPCClient) UnlockAlpha1(ctx context.Context, storeName string, request *UnlockRequest) (*UnlockResponse, error)

UnlockAlpha1 deletes unlocks a lock from a lock store.

func (*GRPCClient) UnregisterActorReminder added in v1.3.0 

func (c *GRPCClient) UnregisterActorReminder(ctx context.Context, in *UnregisterActorReminderRequest) error

UnregisterActorReminder would unregister the actor reminder.

func (*GRPCClient) UnregisterActorTimer added in v1.3.0 

func (c *GRPCClient) UnregisterActorTimer(ctx context.Context, in *UnregisterActorTimerRequest) error

UnregisterActorTimer unregisters actor timer.

func (*GRPCClient) UnsubscribeConfigurationItems added in v1.4.0 

func (c *GRPCClient) UnsubscribeConfigurationItems(ctx context.Context, storeName string, id string, opts ...ConfigurationOpt) error

func (*GRPCClient) Wait added in v1.7.0 

func (c *GRPCClient) Wait(ctx context.Context, timeout time.Duration) error

func (*GRPCClient) WithAuthToken added in v0.11.0 

func (c *GRPCClient) WithAuthToken(token string)

WithAuthToken sets Dapr API token on the instantiated client. Allows empty string to reset token on existing client.

func (*GRPCClient) WithTraceID added in v0.11.0 

func (c *GRPCClient) WithTraceID(ctx context.Context, id string) context.Context

WithTraceID adds existing trace ID to the outgoing context.

type GetActorStateRequest added in v1.3.0 

type GetActorStateRequest struct {
	ActorType string
	ActorID   string
	KeyName   string
}

type GetActorStateResponse added in v1.3.0 

type GetActorStateResponse struct {
	Data []byte
}

type GetMetadataResponse added in v1.9.0 

type GetMetadataResponse struct {
	ID                   string
	ActiveActorsCount    []*MetadataActiveActorsCount
	RegisteredComponents []*MetadataRegisteredComponents
	ExtendedMetadata     map[string]string
	Subscriptions        []*MetadataSubscription
	HTTPEndpoints        []*MetadataHTTPEndpoint
}

type GetWorkflowRequest added in v1.10.0 

type GetWorkflowRequest struct {
	InstanceID        string
	WorkflowComponent string
}

type GetWorkflowResponse added in v1.10.0 

type GetWorkflowResponse struct {
	InstanceID    string
	WorkflowName  string
	CreatedAt     time.Time
	LastUpdatedAt time.Time
	RuntimeStatus string
	Properties    map[string]string
}

type InvokeActorRequest added in v1.3.0 

type InvokeActorRequest struct {
	ActorType string
	ActorID   string
	Method    string
	Data      []byte
}

type InvokeActorResponse added in v1.3.0 

type InvokeActorResponse struct {
	Data []byte
}

type InvokeBindingRequest added in v1.0.0 

type InvokeBindingRequest struct {
	// Name is name of binding to invoke.
	Name string
	// Operation is the name of the operation type for the binding to invoke
	Operation string
	// Data is the input bindings sent
	Data []byte
	// Metadata is the input binding metadata
	Metadata map[string]string
}

InvokeBindingRequest represents binding invocation request.

type LockRequest added in v1.5.0 

type LockRequest struct {
	ResourceID      string
	LockOwner       string
	ExpiryInSeconds int32
}

LockRequest is the lock request object.

type LockResponse added in v1.5.0 

type LockResponse struct {
	Success bool
}

LockResponse is the lock operation response object.

type MetadataActiveActorsCount added in v1.9.0 

type MetadataActiveActorsCount struct {
	Type  string
	Count int32
}

type MetadataHTTPEndpoint added in v1.9.0 

type MetadataHTTPEndpoint struct {
	Name string
}

type MetadataRegisteredComponents added in v1.9.0 

type MetadataRegisteredComponents struct {
	Name         string
	Type         string
	Version      string
	Capabilities []string
}

type MetadataSubscription added in v1.9.0 

type MetadataSubscription struct {
	PubsubName      string
	Topic           string
	Metadata        map[string]string
	Rules           *PubsubSubscriptionRules
	DeadLetterTopic string
}

type OperationType added in v0.10.0 

type OperationType int

OperationType is the operation enum type.

func (OperationType) String added in v0.10.0 

func (o OperationType) String() string

String returns the string value of the OperationType.

type PauseWorkflowRequest added in v1.10.0 

type PauseWorkflowRequest struct {
	InstanceID        string
	WorkflowComponent string
}

type PublishEventOption added in v1.3.0 

type PublishEventOption func(*pb.PublishEventRequest)

PublishEventOption is the type for the functional option.

func PublishEventWithContentType added in v1.3.0 

func PublishEventWithContentType(contentType string) PublishEventOption

PublishEventWithContentType can be passed as option to PublishEvent to set an explicit Content-Type.

func PublishEventWithMetadata added in v1.3.0 

func PublishEventWithMetadata(metadata map[string]string) PublishEventOption

PublishEventWithMetadata can be passed as option to PublishEvent to set metadata.

func PublishEventWithRawPayload added in v1.4.0 

func PublishEventWithRawPayload() PublishEventOption

PublishEventWithRawPayload can be passed as option to PublishEvent to set rawPayload metadata.

type PublishEventsEvent added in v1.8.0 

type PublishEventsEvent struct {
	EntryID     string
	Data        []byte
	ContentType string
	Metadata    map[string]string
}

PublishEventsEvent is a type of event that can be published using PublishEvents.

type PublishEventsOption added in v1.8.0 

type PublishEventsOption func(*pb.BulkPublishRequest)

PublishEventsOption is the type for the functional option.

func PublishEventsWithContentType added in v1.8.0 

func PublishEventsWithContentType(contentType string) PublishEventsOption

PublishEventsWithContentType can be passed as option to PublishEvents to explicitly set the same Content-Type for all events.

func PublishEventsWithMetadata added in v1.8.0 

func PublishEventsWithMetadata(metadata map[string]string) PublishEventsOption

PublishEventsWithMetadata can be passed as option to PublishEvents to set request metadata.

func PublishEventsWithRawPayload added in v1.8.0 

func PublishEventsWithRawPayload() PublishEventsOption

PublishEventsWithRawPayload can be passed as option to PublishEvents to set rawPayload request metadata.

type PublishEventsResponse added in v1.8.0 

type PublishEventsResponse struct {
	Error        error
	FailedEvents []interface{}
}

PublishEventsResponse is the response type for PublishEvents.

type PubsubSubscriptionRule added in v1.9.0 

type PubsubSubscriptionRule struct {
	Match string
	Path  string
}

type PubsubSubscriptionRules added in v1.9.0 

type PubsubSubscriptionRules struct {
	Rules []*PubsubSubscriptionRule
}

type PurgeWorkflowRequest added in v1.10.0 

type PurgeWorkflowRequest struct {
	InstanceID        string
	WorkflowComponent string
}

type QueryItem added in v1.3.1 

type QueryItem struct {
	Key   string
	Value []byte
	Etag  string
	Error string
}

QueryItem represents a single query result item.

type QueryResponse added in v1.3.1 

type QueryResponse struct {
	Results  []QueryItem
	Token    string
	Metadata map[string]string
}

QueryResponse represents a query result.

type RaiseEventWorkflowRequest added in v1.10.0 

type RaiseEventWorkflowRequest struct {
	InstanceID        string
	WorkflowComponent string
	EventName         string
	EventData         any
	SendRawData       bool // Set to True in order to disable serialization on the data
}

type RegisterActorReminderRequest added in v1.3.0 

type RegisterActorReminderRequest struct {
	ActorType string
	ActorID   string
	Name      string
	DueTime   string
	Period    string
	TTL       string
	Data      []byte
}

type RegisterActorTimerRequest added in v1.3.0 

type RegisterActorTimerRequest struct {
	ActorType string
	ActorID   string
	Name      string
	DueTime   string
	Period    string
	TTL       string
	Data      []byte
	CallBack  string
}

type ResumeWorkflowRequest added in v1.10.0 

type ResumeWorkflowRequest struct {
	InstanceID        string
	WorkflowComponent string
}

type SetStateItem added in v0.10.0 

type SetStateItem struct {
	Key      string
	Value    []byte
	Etag     *ETag
	Metadata map[string]string
	Options  *StateOptions
}

SetStateItem represents a single state to be persisted.

type StartWorkflowRequest added in v1.10.0 

type StartWorkflowRequest struct {
	InstanceID        string // Optional instance identifier
	WorkflowComponent string
	WorkflowName      string
	Options           map[string]string // Optional metadata
	Input             any               // Optional input
	SendRawInput      bool              // Set to True in order to disable serialization on the input
}

type StartWorkflowResponse added in v1.10.0 

type StartWorkflowResponse struct {
	InstanceID string
}

type StateConcurrency 

type StateConcurrency int

StateConcurrency is the concurrency enum type.

func (StateConcurrency) GetPBConcurrency added in v1.2.0 

func (s StateConcurrency) GetPBConcurrency() v1.StateOptions_StateConcurrency

GetPBConcurrency get concurrency pb value.

func (StateConcurrency) String 

func (s StateConcurrency) String() string

String returns the string value of the StateConcurrency.

type StateConsistency 

type StateConsistency int

StateConsistency is the consistency enum type.

func (StateConsistency) GetPBConsistency added in v1.2.0 

func (s StateConsistency) GetPBConsistency() v1.StateOptions_StateConsistency

GetPBConsistency get consistency pb value.

func (StateConsistency) String 

func (s StateConsistency) String() string

String returns the string value of the StateConsistency.

type StateItem 

type StateItem struct {
	Key      string
	Value    []byte
	Etag     string
	Metadata map[string]string
}

StateItem represents a single state item.

type StateOperation added in v0.10.0 

type StateOperation struct {
	Type OperationType
	Item *SetStateItem
}

StateOperation is a collection of StateItems with a store name.

type StateOption added in v1.2.0 

type StateOption func(*StateOptions)

StateOption StateOptions's function type.

func WithConcurrency added in v1.2.0 

func WithConcurrency(concurrency StateConcurrency) StateOption

WithConcurrency set StateOptions's Concurrency.

func WithConsistency added in v1.2.0 

func WithConsistency(consistency StateConsistency) StateOption

WithConsistency set StateOptions's consistency.

type StateOptions 

type StateOptions struct {
	Concurrency StateConcurrency
	Consistency StateConsistency
}

StateOptions represents the state store persistence policy.

type TerminateWorkflowRequest added in v1.10.0 

type TerminateWorkflowRequest struct {
	InstanceID        string
	WorkflowComponent string
}

type UnlockRequest added in v1.5.0 

type UnlockRequest struct {
	ResourceID string
	LockOwner  string
}

UnlockRequest is the unlock request object.

type UnlockResponse added in v1.5.0 

type UnlockResponse struct {
	StatusCode int32
	Status     string
}

UnlockResponse is the unlock operation response object.

type UnregisterActorReminderRequest added in v1.3.0 

type UnregisterActorReminderRequest struct {
	ActorType string
	ActorID   string
	Name      string
}

type UnregisterActorTimerRequest added in v1.3.0 

type UnregisterActorTimerRequest struct {
	ActorType string
	ActorID   string
	Name      string
}

Source Files

View all Source files

Directories

Path Synopsis

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.