client

package
v1.3.0 Latest Latest
Warning

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

Go to latest
Published: Nov 2, 2021 License: MIT Imports: 22 Imported by: 318

Documentation

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
	// UndefinedType represents undefined type value.
	UndefinedType = "undefined"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ActorStateOperation added in v1.3.0

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

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)

	// 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

	// 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, 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) (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)

	// DeleteState deletes content from store using default state options.
	DeleteState(ctx context.Context, storeName, key 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

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

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

	// Shutdown the sidecar.
	Shutdown(ctx context.Context) 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)
}

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

func NewClientWithAddress

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

NewClientWithAddress instantiates Dapr using specific address (including port).

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 port.

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 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 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) DeleteBulkState added in v1.0.0

func (c *GRPCClient) DeleteBulkState(ctx context.Context, storeName string, keys []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

DeleteBulkState deletes content for multiple keys from store.

func (*GRPCClient) DeleteState

func (c *GRPCClient) DeleteState(ctx context.Context, storeName, key 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) 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 (*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) 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) (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) 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) 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) 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.

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.

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, 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) Shutdown added in v1.1.0

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

Shutdown the sidecar.

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) 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 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 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 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.

type RegisterActorReminderRequest added in v1.3.0

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

type RegisterActorTimerRequest added in v1.3.0

type RegisterActorTimerRequest struct {
	ActorType string
	ActorID   string
	Name      string
	DueTime   string
	Period    string
	Data      []byte
	CallBack  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 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 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
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL