package dapr.proto.runtime.v1
Get desktop application:
View/edit binary Protocol Buffers messages
service AppCallback
appcallback.proto:21AppCallback V1 allows user application to interact with Dapr runtime. User application needs to implement AppCallback service if it needs to receive message from dapr runtime.
Lists all input bindings subscribed by this app.
message
appcallback.proto:178ListInputBindingsResponse is the message including the list of input bindings.
repeated string bindings = 1
The list of input bindings.
Lists all topics subscribed by this app.
message
appcallback.proto:136ListTopicSubscriptionsResponse is the message including the list of the subscribing topics.
repeated subscriptions = 1
The list of topics.
rpc OnBindingEvent (, )
appcallback.proto:38Listens events from the input bindings User application can save the states or send the events to the output bindings optionally by returning BindingEventResponse.
message
appcallback.proto:96BindingEventRequest represents input bindings event.
string name = 1
Required. The name of the input binding component.
bytes data = 2
Required. The payload that the input bindings sent
map<string, string> metadata = 3
The metadata set by the input binging components.
message
appcallback.proto:109BindingEventResponse includes operations to save state or send data to output bindings optionally.
string store_name = 1
The name of state store where states are saved.
repeated states = 2
The state key values which will be stored in store_name.
repeated string to = 3
The list of output bindings.
bytes data = 4
The content which will be sent to "to" output bindings.
BindingEventResponse.BindingEventConcurrency concurrency = 5
The concurrency of output bindings to send data to "to" output bindings list. The default is SEQUENTIAL.
rpc OnInvoke (, )
appcallback.proto:23Invokes service method with InvokeRequest.
rpc OnTopicEvent (, )
appcallback.proto:29Subscribes events from Pubsub
message
appcallback.proto:43TopicEventRequest message is compatible with CloudEvent spec v1.0 https://github.com/cloudevents/spec/blob/v1.0/spec.md
string id = 1
id identifies the event. Producers MUST ensure that source + id is unique for each distinct event. If a duplicate event is re-sent (e.g. due to a network error) it MAY have the same id.
string source = 2
source identifies the context in which an event happened. Often this will include information such as the type of the event source, the organization publishing the event or the process that produced the event. The exact syntax and semantics behind the data encoded in the URI is defined by the event producer.
string type = 3
The type of event related to the originating occurrence.
string spec_version = 4
The version of the CloudEvents specification.
string data_content_type = 5
The content type of data value.
bytes data = 7
The content of the event.
string topic = 6
The pubsub topic which publisher sent to.
string pubsub_name = 8
The name of the pubsub the publisher sent to.
string path = 9
The matching path from TopicSubscription/routes (if specified) for this event. This value is used by OnTopicEvent to "switch" inside the handler.
message
appcallback.proto:80TopicEventResponse is response from app on published message
TopicEventResponse.TopicEventResponseStatus status = 1
The list of output bindings.
service Dapr
dapr.proto:20Dapr service provides APIs to user application to access Dapr building blocks.
rpc DeleteBulkState (, )
dapr.proto:40Deletes a bulk of state items for a list of keys
message
dapr.proto:193DeleteBulkStateRequest is the message to delete a list of key-value states from specific state store.
string store_name = 1
The name of state store.
repeated states = 2
The array of the state key values.
rpc DeleteState (, )
dapr.proto:37Deletes the state for a specific key.
message
dapr.proto:173DeleteStateRequest is the message to delete key-value states in the specific state store.
string store_name = 1
The name of state store.
string key = 2
The key of the desired state
optional etag = 3
The entity tag which represents the specific version of data. The exact ETag format is defined by the corresponding data store.
optional options = 4
State operation options which includes concurrency/ consistency/retry_policy.
map<string, string> metadata = 5
The metadata which will be sent to state store components.
Executes state transactions for a specified actor
message
dapr.proto:411ExecuteActorStateTransactionRequest is the message to execute multiple operations on a specified actor.
string actor_type = 1
string actor_id = 2
repeated operations = 3
rpc ExecuteStateTransaction (, )
dapr.proto:43Executes transactions for a specified store
message
dapr.proto:350ExecuteStateTransactionRequest is the message to execute multiple operations on a specified store.
string storeName = 1
Required. name of state store.
repeated operations = 2
Required. transactional operation list.
map<string, string> metadata = 3
The metadata used for transactional operations.
rpc GetActorState (, )
dapr.proto:70Gets the state for a specific actor.
message
dapr.proto:399GetActorStateRequest is the message to get key-value states from specific actor.
string actor_type = 1
string actor_id = 2
string key = 3
message
dapr.proto:406GetActorStateResponse is the response conveying the actor's state value.
bytes data = 1
rpc GetBulkSecret (, )
dapr.proto:55Gets a bulk of secrets
message
dapr.proto:320GetBulkSecretRequest is the message to get the secrets from secret store.
string store_name = 1
The name of secret store.
map<string, string> metadata = 2
The metadata which will be sent to secret store components.
message
dapr.proto:334GetBulkSecretResponse is the response message to convey the requested secrets.
map<string, > data = 1
data hold the secret values. Some secret store, such as kubernetes secret store, can save multiple secrets for single secret key.
rpc GetBulkState (, )
dapr.proto:28Gets a bulk of state items for a list of keys
message
dapr.proto:119GetBulkStateRequest is the message to get a list of key-value states from specific state store.
string store_name = 1
The name of state store.
repeated string keys = 2
The keys to get.
int32 parallelism = 3
The number of parallel operations executed on the state store for a get operation.
map<string, string> metadata = 4
The metadata which will be sent to state store components.
message
dapr.proto:134GetBulkStateResponse is the response conveying the list of state values.
repeated items = 1
The list of items containing the keys to get values for.
rpc GetConfigurationAlpha1 (, )
dapr.proto:79GetConfiguration gets configuration from configuration store.
message
dapr.proto:462GetConfigurationRequest is the message to get a list of key-value configuration from specified configuration store.
string store_name = 1
Required. The name of configuration store.
repeated string keys = 2
Optional. The key of the configuration item to fetch. If set, only query for the specified configuration items. Empty list means fetch all.
map<string, string> metadata = 3
Optional. The metadata which will be sent to configuration store components.
message
dapr.proto:477GetConfigurationResponse is the response conveying the list of configuration values. It should be the FULL configuration of specified application which contains all of its configuration items.
repeated items = 1
rpc GetMetadata (, )
dapr.proto:85Gets metadata of the sidecar
message
dapr.proto:438GetMetadataResponse is a message that is returned on GetMetadata rpc call
string id = 1
repeated active_actors_count = 2
repeated registered_components = 3
map<string, string> extended_metadata = 4
rpc GetSecret (, )
dapr.proto:52Gets secrets from secret stores.
message
dapr.proto:301GetSecretRequest is the message to get secret from secret store.
string store_name = 1
The name of secret store.
string key = 2
The name of secret key.
map<string, string> metadata = 3
The metadata which will be sent to secret store components.
message
dapr.proto:313GetSecretResponse is the response message to convey the requested secret.
map<string, string> data = 1
data is the secret value. Some secret store, such as kubernetes secret store, can save multiple secrets for single secret key.
rpc GetState (, )
dapr.proto:25Gets the state for a specific key.
message
dapr.proto:104GetStateRequest is the message to get key-value states from specific state store.
string store_name = 1
The name of state store.
string key = 2
The key of the desired state
common.v1.StateOptions.StateConsistency consistency = 3
The read consistency of the state store.
map<string, string> metadata = 4
The metadata which will be sent to state store components.
message
dapr.proto:160GetStateResponse is the response conveying the state value and etag.
bytes data = 1
The byte array data
string etag = 2
The entity tag which represents the specific version of data. ETag format is defined by the corresponding data store.
map<string, string> metadata = 3
The metadata which will be sent to app.
rpc InvokeActor (, )
dapr.proto:76InvokeActor calls a method on an actor.
message
dapr.proto:425InvokeActorRequest is the message to call an actor.
string actor_type = 1
string actor_id = 2
string method = 3
bytes data = 4
message
dapr.proto:433InvokeActorResponse is the method that returns an actor invocation response.
bytes data = 1
rpc InvokeBinding (, )
dapr.proto:49Invokes binding data to specific output bindings
message
dapr.proto:271InvokeBindingRequest is the message to send data to output bindings
string name = 1
The name of the output binding to invoke.
bytes data = 2
The data which will be sent to output binding.
map<string, string> metadata = 3
The metadata passing to output binding components Common metadata property: - ttlInSeconds : the time to live in seconds for the message. If set in the binding definition will cause all messages to have a default time to live. The message ttl overrides any value in the binding definition.
string operation = 4
The name of the operation type for the binding to invoke
message
dapr.proto:292InvokeBindingResponse is the message returned from an output binding invocation
bytes data = 1
The data which will be sent to output binding.
map<string, string> metadata = 2
The metadata returned from an external system
rpc InvokeService (, )
dapr.proto:22Invokes a method on a remote Dapr app.
message
dapr.proto:95InvokeServiceRequest represents the request message for Service invocation.
string id = 1
Required. Callee's app id.
optional message = 3
Required. message which will be delivered to callee.
rpc PublishEvent (, )
dapr.proto:46Publishes events to the specific topic.
message
dapr.proto:250PublishEventRequest is the message to publish event data to pubsub topic
string pubsub_name = 1
The name of the pubsub component
string topic = 2
The pubsub topic
bytes data = 3
The data which will be published to topic.
string data_content_type = 4
The content type for the data (optional).
map<string, string> metadata = 5
The metadata passing to pub components metadata property: - key : the key of the message.
rpc QueryStateAlpha1 (, )
dapr.proto:34Queries the state.
message
dapr.proto:211QueryStateRequest is the message to query state store.
string store_name = 1
The name of state store.
string query = 2
The query in JSON format.
map<string, string> metadata = 3
The metadata which will be sent to state store components.
message
dapr.proto:238QueryStateResponse is the response conveying the query results.
repeated results = 1
An array of query results.
string token = 2
Pagination token.
map<string, string> metadata = 3
The metadata which will be sent to app.
rpc RegisterActorReminder (, )
dapr.proto:64Register an actor reminder.
message
dapr.proto:381RegisterActorReminderRequest is the message to register a reminder for an actor of a given type and id.
string actor_type = 1
string actor_id = 2
string name = 3
string due_time = 4
string period = 5
bytes data = 6
string ttl = 7
rpc RegisterActorTimer (, )
dapr.proto:58Register an actor timer.
message
dapr.proto:362RegisterActorTimerRequest is the message to register a timer for an actor of a given type and id.
string actor_type = 1
string actor_id = 2
string name = 3
string due_time = 4
string period = 5
string callback = 6
bytes data = 7
string ttl = 8
rpc SaveState (, )
dapr.proto:31Saves the state for a specific key.
message
dapr.proto:202SaveStateRequest is the message to save multiple states into state store.
string store_name = 1
The name of state store.
repeated states = 2
The array of the state key values.
rpc SetMetadata (, )
dapr.proto:88Sets value in extended metadata of the sidecar
message
dapr.proto:456string key = 1
string value = 2
rpc Shutdown (, )
dapr.proto:91Shutdown the sidecar
rpc SubscribeConfigurationAlpha1 (, stream )
dapr.proto:82SubscribeConfiguration gets configuration from configuration store and subscribe the updates event by grpc stream
message
dapr.proto:482SubscribeConfigurationRequest is the message to get a list of key-value configuration from specified configuration store.
string store_name = 1
The name of configuration store.
repeated string keys = 2
Optional. The key of the configuration item to fetch. If set, only query for the specified configuration items. Empty list means fetch all.
map<string, string> metadata = 3
The metadata which will be sent to configuration store components.
message
dapr.proto:495repeated items = 1
The list of items containing configuration values
rpc UnregisterActorReminder (, )
dapr.proto:67Unregister an actor reminder.
message
dapr.proto:392UnregisterActorReminderRequest is the message to unregister an actor reminder.
string actor_type = 1
string actor_id = 2
string name = 3
rpc UnregisterActorTimer (, )
dapr.proto:61Unregister an actor timer.
message
dapr.proto:374UnregisterActorTimerRequest is the message to unregister an actor timer
string actor_type = 1
string actor_id = 2
string name = 3
message
dapr.proto:445Used in:
string type = 1
int32 count = 2
BindingEventConcurrency is the kind of concurrency
Used in:
SEQUENTIAL = 0
SEQUENTIAL sends data to output bindings specified in "to" sequentially.
PARALLEL = 1
PARALLEL sends data to output bindings specified in "to" in parallel.
message
dapr.proto:141BulkStateItem is the response item for a bulk get operation. Return values include the item key, data and etag.
Used in:
string key = 1
state item key
bytes data = 2
The byte array data
string etag = 3
The entity tag which represents the specific version of data. ETag format is defined by the corresponding data store.
string error = 4
The error that was returned from the state store in case of a failed get operation.
map<string, string> metadata = 5
The metadata which will be sent to app.
message
dapr.proto:222Used in:
string key = 1
The object key.
bytes data = 2
The object value.
string etag = 3
The entity tag which represents the specific version of data. ETag format is defined by the corresponding data store.
string error = 4
The error message indicating an error in processing of the query result.
message
dapr.proto:450Used in:
string name = 1
string type = 2
string version = 3
message
dapr.proto:329SecretResponse is a map of decrypted string/string values
Used in:
map<string, string> secrets = 1
TopicEventResponseStatus allows apps to have finer control over handling of the message.
Used in:
SUCCESS = 0
SUCCESS is the default behavior: message is acknowledged and not retried or logged.
RETRY = 1
RETRY status signals Dapr to retry the message as part of an expected scenario (no warning is logged).
DROP = 2
DROP status signals Dapr to drop the message as part of an unexpected scenario (warning is logged).
message
appcallback.proto:157Used in:
repeated rules = 1
The list of rules for this topic.
string default = 2
The default path for this topic.
message
appcallback.proto:165Used in:
string match = 1
The optional CEL expression used to match the event. If the match is not specified, then the route is considered the default.
string path = 2
The path used to identify matches for this subscription. This value is passed in TopicEventRequest and used by OnTopicEvent to "switch" inside the handler.
message
appcallback.proto:142TopicSubscription represents topic and metadata.
Used in:
string pubsub_name = 1
Required. The name of the pubsub containing the topic below to subscribe to.
string topic = 2
Required. The name of topic which will be subscribed
map<string, string> metadata = 3
The optional properties used for this topic's subscription e.g. session id
optional routes = 5
The optional routing rules to match against. In the gRPC interface, OnTopicEvent is still invoked but the matching path is sent in the TopicEventRequest.
message
dapr.proto:418TransactionalAcorStateOperation is the message to execute a specified operation with a key-value pair.
Used in:
string operationType = 1
string key = 2
optional value = 3
message
dapr.proto:341TransactionalStateOperation is the message to execute a specified operation with a key-value pair.
Used in:
string operationType = 1
The type of operation to be executed
optional request = 2
State values to be operated on