package dapr.proto.runtime.v1

Get desktop application:
View/edit binary Protocol Buffers messages

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

• rpc ListInputBindings (google.protobuf.Empty, ListInputBindingsResponse)

  appcallback.proto:32

  Lists all input bindings subscribed by this app.

  message ListInputBindingsResponse

  appcallback.proto:150

  ListInputBindingsResponse is the message including the list of input bindings.

  • repeated string bindings = 1

    The list of input bindings.

• rpc ListTopicSubscriptions (google.protobuf.Empty, ListTopicSubscriptionsResponse)

  appcallback.proto:26

  Lists all topics subscribed by this app.

  message ListTopicSubscriptionsResponse

  appcallback.proto:132

  ListTopicSubscriptionsResponse is the message including the list of the subscribing topics.

  • repeated TopicSubscription subscriptions = 1

    The list of topics.

• rpc OnBindingEvent (BindingEventRequest, BindingEventResponse)

  appcallback.proto:38

  Listens events from the input bindings User application can save the states or send the events to the output bindings optionally by returning BindingEventResponse.

  message BindingEventRequest

  appcallback.proto:92

  BindingEventRequest 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 BindingEventResponse

  appcallback.proto:105

  BindingEventResponse 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 common.v1.StateItem 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 (common.v1.InvokeRequest, common.v1.InvokeResponse)

  appcallback.proto:23

  Invokes service method with InvokeRequest.

• rpc OnTopicEvent (TopicEventRequest, TopicEventResponse)

  appcallback.proto:29

  Subscribes events from Pubsub

  message TopicEventRequest

  appcallback.proto:43

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

  message TopicEventResponse

  appcallback.proto:76

  TopicEventResponse is response from app on published message

  • TopicEventResponse.TopicEventResponseStatus status = 1

    The list of output bindings.

Dapr service provides APIs to user application to access Dapr building blocks.

• rpc DeleteBulkState (DeleteBulkStateRequest, google.protobuf.Empty)

  dapr.proto:37

  Deletes a bulk of state items for a list of keys

  message DeleteBulkStateRequest

  dapr.proto:181

  DeleteBulkStateRequest 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 common.v1.StateItem states = 2

    The array of the state key values.

• rpc DeleteState (DeleteStateRequest, google.protobuf.Empty)

  dapr.proto:34

  Deletes the state for a specific key.

  message DeleteStateRequest

  dapr.proto:161

  DeleteStateRequest 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 common.v1.Etag etag = 3

    The entity tag which represents the specific version of data. The exact ETag format is defined by the corresponding data store.

  • optional common.v1.StateOptions 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.

• rpc ExecuteActorStateTransaction (ExecuteActorStateTransactionRequest, google.protobuf.Empty)

  dapr.proto:70

  Executes state transactions for a specified actor

  message ExecuteActorStateTransactionRequest

  dapr.proto:358

  ExecuteActorStateTransactionRequest is the message to execute multiple operations on a specified actor.

  • string actor_type = 1

  • string actor_id = 2

  • repeated TransactionalActorStateOperation operations = 3

• rpc ExecuteStateTransaction (ExecuteStateTransactionRequest, google.protobuf.Empty)

  dapr.proto:40

  Executes transactions for a specified store

  message ExecuteStateTransactionRequest

  dapr.proto:299

  ExecuteStateTransactionRequest is the message to execute multiple operations on a specified store.

  • string storeName = 1

    Required. name of state store.

  • repeated TransactionalStateOperation operations = 2

    Required. transactional operation list.

  • map<string, string> metadata = 3

    The metadata used for transactional operations.

• rpc GetActorState (GetActorStateRequest, GetActorStateResponse)

  dapr.proto:67

  Gets the state for a specific actor.

  message GetActorStateRequest

  dapr.proto:346

  GetActorStateRequest is the message to get key-value states from specific actor.

  • string actor_type = 1

  • string actor_id = 2

  • string key = 3

  message GetActorStateResponse

  dapr.proto:353

  GetActorStateResponse is the response conveying the actor's state value.

  • bytes data = 1

• rpc GetBulkSecret (GetBulkSecretRequest, GetBulkSecretResponse)

  dapr.proto:52

  Gets a bulk of secrets

  message GetBulkSecretRequest

  dapr.proto:269

  GetBulkSecretRequest 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 GetBulkSecretResponse

  dapr.proto:283

  GetBulkSecretResponse is the response message to convey the requested secrets.

  • map<string, SecretResponse> 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 (GetBulkStateRequest, GetBulkStateResponse)

  dapr.proto:28

  Gets a bulk of state items for a list of keys

  message GetBulkStateRequest

  dapr.proto:107

  GetBulkStateRequest 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 GetBulkStateResponse

  dapr.proto:122

  GetBulkStateResponse is the response conveying the list of state values.

  • repeated BulkStateItem items = 1

    The list of items containing the keys to get values for.

• rpc GetMetadata (google.protobuf.Empty, GetMetadataResponse)

  dapr.proto:76

  Gets metadata of the sidecar

  message GetMetadataResponse

  dapr.proto:385

  GetMetadataResponse is a message that is returned on GetMetadata rpc call

  • string id = 1

  • repeated ActiveActorsCount active_actors_count = 2

  • repeated RegisteredComponents registered_components = 3

  • map<string, string> extended_metadata = 4

• rpc GetSecret (GetSecretRequest, GetSecretResponse)

  dapr.proto:49

  Gets secrets from secret stores.

  message GetSecretRequest

  dapr.proto:250

  GetSecretRequest 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 GetSecretResponse

  dapr.proto:262

  GetSecretResponse 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 (GetStateRequest, GetStateResponse)

  dapr.proto:25

  Gets the state for a specific key.

  message GetStateRequest

  dapr.proto:92

  GetStateRequest 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 GetStateResponse

  dapr.proto:148

  GetStateResponse 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 (InvokeActorRequest, InvokeActorResponse)

  dapr.proto:73

  InvokeActor calls a method on an actor.

  message InvokeActorRequest

  dapr.proto:372

  InvokeActorRequest is the message to call an actor.

  • string actor_type = 1

  • string actor_id = 2

  • string method = 3

  • bytes data = 4

  message InvokeActorResponse

  dapr.proto:380

  InvokeActorResponse is the method that returns an actor invocation response.

  • bytes data = 1

• rpc InvokeBinding (InvokeBindingRequest, InvokeBindingResponse)

  dapr.proto:46

  Invokes binding data to specific output bindings

  message InvokeBindingRequest

  dapr.proto:220

  InvokeBindingRequest 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 InvokeBindingResponse

  dapr.proto:241

  InvokeBindingResponse 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 (InvokeServiceRequest, common.v1.InvokeResponse)

  dapr.proto:22

  Invokes a method on a remote Dapr app.

  message InvokeServiceRequest

  dapr.proto:83

  InvokeServiceRequest represents the request message for Service invocation.

  • string id = 1

    Required. Callee's app id.

  • optional common.v1.InvokeRequest message = 3

    Required. message which will be delivered to callee.

• rpc PublishEvent (PublishEventRequest, google.protobuf.Empty)

  dapr.proto:43

  Publishes events to the specific topic.

  message PublishEventRequest

  dapr.proto:199

  PublishEventRequest 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 RegisterActorReminder (RegisterActorReminderRequest, google.protobuf.Empty)

  dapr.proto:61

  Register an actor reminder.

  message RegisterActorReminderRequest

  dapr.proto:329

  RegisterActorReminderRequest 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

• rpc RegisterActorTimer (RegisterActorTimerRequest, google.protobuf.Empty)

  dapr.proto:55

  Register an actor timer.

  message RegisterActorTimerRequest

  dapr.proto:311

  RegisterActorTimerRequest 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

• rpc SaveState (SaveStateRequest, google.protobuf.Empty)

  dapr.proto:31

  Saves the state for a specific key.

  message SaveStateRequest

  dapr.proto:190

  SaveStateRequest is the message to save multiple states into state store.

  • string store_name = 1

    The name of state store.

  • repeated common.v1.StateItem states = 2

    The array of the state key values.

• rpc SetMetadata (SetMetadataRequest, google.protobuf.Empty)

  dapr.proto:79

  Sets value in extended metadata of the sidecar

  message SetMetadataRequest

  dapr.proto:403

  • string key = 1

  • string value = 2

• rpc UnregisterActorReminder (UnregisterActorReminderRequest, google.protobuf.Empty)

  dapr.proto:64

  Unregister an actor reminder.

  message UnregisterActorReminderRequest

  dapr.proto:339

  UnregisterActorReminderRequest is the message to unregister an actor reminder.

  • string actor_type = 1

  • string actor_id = 2

  • string name = 3

• rpc UnregisterActorTimer (UnregisterActorTimerRequest, google.protobuf.Empty)

  dapr.proto:58

  Unregister an actor timer.

  message UnregisterActorTimerRequest

  dapr.proto:322

  UnregisterActorTimerRequest is the message to unregister an actor timer

  • string actor_type = 1

  • string actor_id = 2

  • string name = 3

Used in: GetMetadataResponse

• string type = 1

• int32 count = 2

BindingEventConcurrency is the kind of concurrency

Used in: BindingEventResponse

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

BulkStateItem is the response item for a bulk get operation. Return values include the item key, data and etag.

Used in: GetBulkStateResponse

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

Used in: GetMetadataResponse

• string name = 1

• string type = 2

• string version = 3

SecretResponse is a map of decrypted string/string values

Used in: GetBulkSecretResponse

• map<string, string> secrets = 1

TopicEventResponseStatus allows apps to have finer control over handling of the message.

Used in: TopicEventResponse

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

TopicSubscription represents topic and metadata.

Used in: ListTopicSubscriptionsResponse

• 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

TransactionalAcorStateOperation is the message to execute a specified operation with a key-value pair.

Used in: ExecuteActorStateTransactionRequest

• string operationType = 1

• string key = 2

• optional google.protobuf.Any value = 3

TransactionalStateOperation is the message to execute a specified operation with a key-value pair.

Used in: ExecuteStateTransactionRequest

• string operationType = 1

  The type of operation to be executed

• optional common.v1.StateItem request = 2

  State values to be operated on