package dapr.proto.runtime.v1
Get desktop application:
View/edit binary Protocol Buffers messages
service AppCallback
appcallback.proto:30AppCallback 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:306ListInputBindingsResponse 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:246ListTopicSubscriptionsResponse is the message including the list of the subscribing topics.
repeated subscriptions = 1
The list of topics.
rpc OnBindingEvent (, )
appcallback.proto:47Listens 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:206BindingEventRequest 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:219BindingEventResponse 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:32Invokes service method with InvokeRequest.
rpc OnTopicEvent (, )
appcallback.proto:38Subscribes events from Pubsub
message
appcallback.proto:66TopicEventRequest 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.
optional extensions = 10
The map of additional custom properties to be sent to the app. These are considered to be cloud event extensions.
message
appcallback.proto:106TopicEventResponse is response from app on published message
TopicEventResponse.TopicEventResponseStatus status = 1
The list of output bindings.
AppCallbackAlpha V1 is an optional extension to AppCallback V1 to opt for Alpha RPCs.
Subscribes bulk events from Pubsub
message
appcallback.proto:164TopicEventBulkRequest represents request for bulk message
string id = 1
Unique identifier for the bulk request.
repeated entries = 2
The list of items inside this bulk request.
map<string, string> metadata = 3
The metadata associated with the this bulk request.
string topic = 4
The pubsub topic which publisher sent to.
string pubsub_name = 5
The name of the pubsub the publisher sent to.
string type = 6
The type of event related to the originating occurrence.
string path = 7
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:199AppBulkResponse is response from app on published message
repeated statuses = 1
The list of all responses for the bulk request.
AppCallbackHealthCheck V1 is an optional extension to AppCallback V1 to implement the HealthCheck method.
rpc HealthCheck (, )
appcallback.proto:54Health check.
message
appcallback.proto:313HealthCheckResponse is the message with the response to the health check. This message is currently empty as used as placeholder.
(message has no fields)
service Dapr
dapr.proto:29Dapr service provides APIs to user application to access Dapr building blocks.
rpc BulkPublishEventAlpha1 (, )
dapr.proto:59Bulk Publishes multiple events to the specified topic.
message
dapr.proto:370BulkPublishRequest is the message to bulk publish events to pubsub topic
string pubsub_name = 1
The name of the pubsub component
string topic = 2
The pubsub topic
repeated entries = 3
The entries which contain the individual events and associated details to be published
map<string, string> metadata = 4
The request level metadata passing to to the pubsub components
message
dapr.proto:400BulkPublishResponse is the message returned from a BulkPublishEvent call
repeated failedEntries = 1
The entries for different events that failed publish in the BulkPublishEvent call
rpc DecryptAlpha1 (stream , stream )
dapr.proto:119DecryptAlpha1 decrypts a message using the Dapr encryption scheme and a key stored in the vault.
message
dapr.proto:996DecryptRequest is the request for DecryptAlpha1.
optional options = 1
Request details. Must be present in the first message only.
optional payload = 2
Chunk of data of arbitrary size.
message
dapr.proto:1014DecryptResponse is the response for DecryptAlpha1.
optional payload = 1
Chunk of data.
rpc DeleteBulkState (, )
dapr.proto:50Deletes a bulk of state items for a list of keys
message
dapr.proto:292DeleteBulkStateRequest 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:47Deletes the state for a specific key.
message
dapr.proto:272DeleteStateRequest 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.
rpc EncryptAlpha1 (stream , stream )
dapr.proto:116EncryptAlpha1 encrypts a message using the Dapr encryption scheme and a key stored in the vault.
message
dapr.proto:960EncryptRequest is the request for EncryptAlpha1.
optional options = 1
Request details. Must be present in the first message only.
optional payload = 2
Chunk of data of arbitrary size.
message
dapr.proto:990EncryptResponse is the response for EncryptAlpha1.
optional payload = 1
Chunk of data.
Executes state transactions for a specified actor
message
dapr.proto:558ExecuteActorStateTransactionRequest 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:53Executes transactions for a specified store
message
dapr.proto:494ExecuteStateTransactionRequest 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:83Gets the state for a specific actor.
message
dapr.proto:543GetActorStateRequest 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:550GetActorStateResponse is the response conveying the actor's state value.
bytes data = 1
map<string, string> metadata = 2
The metadata which will be sent to app.
rpc GetBulkSecret (, )
dapr.proto:68Gets a bulk of secrets
message
dapr.proto:464GetBulkSecretRequest 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:478GetBulkSecretResponse 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:38Gets a bulk of state items for a list of keys
message
dapr.proto:218GetBulkStateRequest 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:233GetBulkStateResponse is the response conveying the list of state values.
repeated items = 1
The list of items containing the keys to get values for.
rpc GetConfiguration (, )
dapr.proto:95GetConfiguration gets configuration from configuration store.
rpc GetConfigurationAlpha1 (, )
dapr.proto:92GetConfiguration gets configuration from configuration store.
rpc GetMetadata (, )
dapr.proto:122Gets metadata of the sidecar
message
dapr.proto:591GetMetadataRequest is the message for the GetMetadata request.
Empty
(message has no fields)
message
dapr.proto:596GetMetadataResponse is a message that is returned on GetMetadata rpc call.
string id = 1
repeated active_actors_count = 2
Deprecated alias for actor_runtime.active_actors.
repeated registered_components = 3
map<string, string> extended_metadata = 4
repeated subscriptions = 5
repeated http_endpoints = 6
optional app_connection_properties = 7
string runtime_version = 8
repeated string enabled_features = 9
optional actor_runtime = 10
rpc GetSecret (, )
dapr.proto:65Gets secrets from secret stores.
message
dapr.proto:445GetSecretRequest 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:457GetSecretResponse 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:35Gets the state for a specific key.
message
dapr.proto:203GetStateRequest 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:259GetStateResponse 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 GetWorkflowAlpha1 (, )
dapr.proto:152Gets details about a started workflow instance
rpc GetWorkflowBeta1 (, )
dapr.proto:173Gets details about a started workflow instance
rpc InvokeActor (, )
dapr.proto:89InvokeActor calls a method on an actor.
message
dapr.proto:577InvokeActorRequest is the message to call an actor.
string actor_type = 1
string actor_id = 2
string method = 3
bytes data = 4
map<string, string> metadata = 5
message
dapr.proto:586InvokeActorResponse is the method that returns an actor invocation response.
bytes data = 1
rpc InvokeBinding (, )
dapr.proto:62Invokes binding data to specific output bindings
message
dapr.proto:415InvokeBindingRequest 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:436InvokeBindingResponse 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:32Invokes a method on a remote Dapr app. Deprecated: Use proxy mode service invocation instead.
message
dapr.proto:194InvokeServiceRequest 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 PauseWorkflowAlpha1 (, )
dapr.proto:161Pauses a running workflow instance
rpc PauseWorkflowBeta1 (, )
dapr.proto:182Pauses a running workflow instance
rpc PublishEvent (, )
dapr.proto:56Publishes events to the specific topic.
message
dapr.proto:349PublishEventRequest 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 PurgeWorkflowAlpha1 (, )
dapr.proto:155Purge Workflow
rpc PurgeWorkflowBeta1 (, )
dapr.proto:176Purge Workflow
rpc QueryStateAlpha1 (, )
dapr.proto:44Queries the state.
message
dapr.proto:310QueryStateRequest 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:337QueryStateResponse 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.
Raise an event to a running workflow instance
Raise an event to a running workflow instance
rpc RegisterActorReminder (, )
dapr.proto:77Register an actor reminder.
message
dapr.proto:525RegisterActorReminderRequest 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:71Register an actor timer.
message
dapr.proto:506RegisterActorTimerRequest 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 ResumeWorkflowAlpha1 (, )
dapr.proto:164Resumes a paused workflow instance
rpc ResumeWorkflowBeta1 (, )
dapr.proto:185Resumes a paused workflow instance
rpc SaveState (, )
dapr.proto:41Saves the state for a specific key.
message
dapr.proto:301SaveStateRequest 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:125Sets value in extended metadata of the sidecar
message
dapr.proto:679string key = 1
string value = 2
rpc Shutdown (, )
dapr.proto:190Shutdown the sidecar
message
dapr.proto:1108ShutdownRequest is the request for Shutdown.
Empty
(message has no fields)
rpc StartWorkflowAlpha1 (, )
dapr.proto:149Starts a new instance of a workflow
rpc StartWorkflowBeta1 (, )
dapr.proto:170Starts a new instance of a workflow
rpc SubscribeConfiguration (, stream )
dapr.proto:101SubscribeConfiguration gets configuration from configuration store and subscribe the updates event by grpc stream
rpc SubscribeConfigurationAlpha1 (, stream )
dapr.proto:98SubscribeConfiguration gets configuration from configuration store and subscribe the updates event by grpc stream
rpc SubtleDecryptAlpha1 (, )
dapr.proto:134SubtleDecryptAlpha1 decrypts a small message using a key stored in the vault.
message
dapr.proto:844SubtleDecryptRequest is the request for SubtleDecryptAlpha1.
string component_name = 1
Name of the component
bytes ciphertext = 2
Message to decrypt.
string algorithm = 3
Algorithm to use, as in the JWA standard.
string key_name = 4
Name (or name/version) of the key.
bytes nonce = 5
Nonce / initialization vector. Ignored with asymmetric ciphers.
bytes tag = 6
Authentication tag. This is nil when not using an authenticated cipher.
bytes associated_data = 7
Associated Data when using AEAD ciphers (optional).
message
dapr.proto:864SubtleDecryptResponse is the response for SubtleDecryptAlpha1.
bytes plaintext = 1
Decrypted plaintext.
rpc SubtleEncryptAlpha1 (, )
dapr.proto:131SubtleEncryptAlpha1 encrypts a small message using a key stored in the vault.
message
dapr.proto:818SubtleEncryptRequest is the request for SubtleEncryptAlpha1.
string component_name = 1
Name of the component
bytes plaintext = 2
Message to encrypt.
string algorithm = 3
Algorithm to use, as in the JWA standard.
string key_name = 4
Name (or name/version) of the key.
bytes nonce = 5
Nonce / initialization vector. Ignored with asymmetric ciphers.
bytes associated_data = 6
Associated Data when using AEAD ciphers (optional).
message
dapr.proto:835SubtleEncryptResponse is the response for SubtleEncryptAlpha1.
bytes ciphertext = 1
Encrypted ciphertext.
bytes tag = 2
Authentication tag. This is nil when not using an authenticated cipher.
rpc SubtleGetKeyAlpha1 (, )
dapr.proto:128SubtleGetKeyAlpha1 returns the public part of an asymmetric key stored in the vault.
message
dapr.proto:792SubtleGetKeyRequest is the request object for SubtleGetKeyAlpha1.
string component_name = 1
Name of the component
string name = 2
Name (or name/version) of the key to use in the key vault
SubtleGetKeyRequest.KeyFormat format = 3
Response format
message
dapr.proto:809SubtleGetKeyResponse is the response for SubtleGetKeyAlpha1.
string name = 1
Name (or name/version) of the key. This is returned as response too in case there is a version.
string public_key = 2
Public key, encoded in the requested format
rpc SubtleSignAlpha1 (, )
dapr.proto:143SubtleSignAlpha1 signs a message using a key stored in the vault.
message
dapr.proto:922SubtleSignRequest is the request for SubtleSignAlpha1.
string component_name = 1
Name of the component
bytes digest = 2
Digest to sign.
string algorithm = 3
Algorithm to use, as in the JWA standard.
string key_name = 4
Name (or name/version) of the key.
message
dapr.proto:934SubtleSignResponse is the response for SubtleSignAlpha1.
bytes signature = 1
The signature that was computed
rpc SubtleUnwrapKeyAlpha1 (, )
dapr.proto:140SubtleUnwrapKeyAlpha1 unwraps a key using a key stored in the vault.
message
dapr.proto:896SubtleUnwrapKeyRequest is the request for SubtleUnwrapKeyAlpha1.
string component_name = 1
Name of the component
bytes wrapped_key = 2
Wrapped key.
string algorithm = 3
Algorithm to use, as in the JWA standard.
string key_name = 4
Name (or name/version) of the key.
bytes nonce = 5
Nonce / initialization vector. Ignored with asymmetric ciphers.
bytes tag = 6
Authentication tag. This is nil when not using an authenticated cipher.
bytes associated_data = 7
Associated Data when using AEAD ciphers (optional).
message
dapr.proto:916SubtleUnwrapKeyResponse is the response for SubtleUnwrapKeyAlpha1.
bytes plaintext_key = 1
Key in plaintext
rpc SubtleVerifyAlpha1 (, )
dapr.proto:146SubtleVerifyAlpha1 verifies the signature of a message using a key stored in the vault.
message
dapr.proto:940SubtleVerifyRequest is the request for SubtleVerifyAlpha1.
string component_name = 1
Name of the component
bytes digest = 2
Digest of the message.
string algorithm = 3
Algorithm to use, as in the JWA standard.
string key_name = 4
Name (or name/version) of the key.
bytes signature = 5
Signature to verify.
message
dapr.proto:954SubtleVerifyResponse is the response for SubtleVerifyAlpha1.
bool valid = 1
True if the signature is valid.
rpc SubtleWrapKeyAlpha1 (, )
dapr.proto:137SubtleWrapKeyAlpha1 wraps a key using a key stored in the vault.
message
dapr.proto:870SubtleWrapKeyRequest is the request for SubtleWrapKeyAlpha1.
string component_name = 1
Name of the component
bytes plaintext_key = 2
Key to wrap
string algorithm = 3
Algorithm to use, as in the JWA standard.
string key_name = 4
Name (or name/version) of the key.
bytes nonce = 5
Nonce / initialization vector. Ignored with asymmetric ciphers.
bytes associated_data = 6
Associated Data when using AEAD ciphers (optional).
message
dapr.proto:887SubtleWrapKeyResponse is the response for SubtleWrapKeyAlpha1.
bytes wrapped_key = 1
Wrapped key.
bytes tag = 2
Authentication tag. This is nil when not using an authenticated cipher.
Terminates a running workflow instance
rpc TerminateWorkflowBeta1 (, )
dapr.proto:179Terminates a running workflow instance
rpc TryLockAlpha1 (, )
dapr.proto:110TryLockAlpha1 tries to get a lock with an expiry.
message
dapr.proto:740string store_name = 1
Required. The lock store name,e.g. `redis`.
string resource_id = 2
Required. resource_id is the lock key. e.g. `order_id_111` It stands for "which resource I want to protect"
string lock_owner = 3
Required. lock_owner indicate the identifier of lock owner. You can generate a uuid as lock_owner.For example,in golang: req.LockOwner = uuid.New().String() This field is per request,not per process,so it is different for each request, which aims to prevent multi-thread in the same process trying the same lock concurrently. The reason why we don't make it automatically generated is: 1. If it is automatically generated,there must be a 'my_lock_owner_id' field in the response. This name is so weird that we think it is inappropriate to put it into the api spec 2. If we change the field 'my_lock_owner_id' in the response to 'lock_owner',which means the current lock owner of this lock, we find that in some lock services users can't get the current lock owner.Actually users don't need it at all. 3. When reentrant lock is needed,the existing lock_owner is required to identify client and check "whether this client can reenter this lock". So this field in the request shouldn't be removed.
int32 expiry_in_seconds = 4
Required. The time before expiry.The time unit is second.
message
dapr.proto:769bool success = 1
rpc UnlockAlpha1 (, )
dapr.proto:113UnlockAlpha1 unlocks a lock.
message
dapr.proto:773string store_name = 1
string resource_id = 2
resource_id is the lock key.
string lock_owner = 3
message
dapr.proto:780UnlockResponse.Status status = 1
rpc UnregisterActorReminder (, )
dapr.proto:80Unregister an actor reminder.
message
dapr.proto:536UnregisterActorReminderRequest is the message to unregister an actor reminder.
string actor_type = 1
string actor_id = 2
string name = 3
rpc UnregisterActorTimer (, )
dapr.proto:74Unregister an actor timer.
message
dapr.proto:518UnregisterActorTimerRequest is the message to unregister an actor timer
string actor_type = 1
string actor_id = 2
string name = 3
UnSubscribeConfiguration unsubscribe the subscription of configuration
UnSubscribeConfiguration unsubscribe the subscription of configuration
message
dapr.proto:631Used in: ,
string type = 1
int32 count = 2
message
dapr.proto:610Used in:
ActorRuntime.ActorRuntimeStatus runtime_status = 1
Contains an enum indicating whether the actor runtime has been initialized.
repeated active_actors = 2
Count of active actors per type.
bool host_ready = 3
Indicates whether the actor runtime is ready to host actors.
string placement = 4
Custom message from the placement provider.
Used in:
INITIALIZING = 0
Indicates that the actor runtime is still being initialized.
DISABLED = 1
Indicates that the actor runtime is disabled. This normally happens when Dapr is started without "placement-host-address"
RUNNING = 2
Indicates the actor runtime is running, either as an actor host or client.
message
dapr.proto:655Used in:
string health_check_path = 1
string health_probe_interval = 2
string health_probe_timeout = 3
int32 health_threshold = 4
message
dapr.proto:647Used in:
int32 port = 1
string protocol = 2
string channel_address = 3
int32 max_concurrency = 4
optional health = 5
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:385BulkPublishRequestEntry is the message containing the event to be bulk published
Used in:
string entry_id = 1
The request scoped unique ID referring to this message. Used to map status in response
bytes event = 2
The event which will be pulished to the topic
string content_type = 3
The content type for the event
map<string, string> metadata = 4
The event level metadata passing to the pubsub component
message
dapr.proto:406BulkPublishResponseFailedEntry is the message containing the entryID and error of a failed event in BulkPublishEvent call
Used in:
string entry_id = 1
The response scoped unique ID referring to this message
string error = 2
The error message if any on failure
message
dapr.proto:240BulkStateItem 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
appcallback.proto:294BulkSubscribeConfig is the message to pass settings for bulk subscribe
Used in:
bool enabled = 1
Required. Flag to enable/disable bulk subscribe
int32 max_messages_count = 2
Optional. Max number of messages to be sent in a single bulk request
int32 max_await_duration_ms = 3
Optional. Max duration to wait for messages to be sent in a single bulk request
message
dapr.proto:1004DecryptRequestOptions contains options for the first message in the DecryptAlpha1 request.
Used in:
string component_name = 1
Name of the component
string key_name = 12
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).
message
dapr.proto:968EncryptRequestOptions contains options for the first message in the EncryptAlpha1 request.
Used in:
string component_name = 1
Name of the component. Required.
string key_name = 2
Name (or name/version) of the key. Required.
string key_wrap_algorithm = 3
Key wrapping algorithm to use. Required. Supported options include: A256KW (alias: AES), A128CBC, A192CBC, A256CBC, RSA-OAEP-256 (alias: RSA).
string data_encryption_cipher = 10
Cipher used to encrypt data (optional): "aes-gcm" (default) or "chacha20-poly1305"
bool omit_decryption_key_name = 11
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.
string decryption_key_name = 12
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.
message
dapr.proto:685GetConfigurationRequest is the message to get a list of key-value configuration from specified configuration store.
Used as request type in: Dapr.GetConfiguration, Dapr.GetConfigurationAlpha1
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:700GetConfigurationResponse 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.
Used as response type in: Dapr.GetConfiguration, Dapr.GetConfigurationAlpha1
map<string, > items = 1
message
dapr.proto:1020GetWorkflowRequest is the request for GetWorkflowBeta1.
Used as request type in: Dapr.GetWorkflowAlpha1, Dapr.GetWorkflowBeta1
string instance_id = 1
ID of the workflow instance to query.
string workflow_component = 2
Name of the workflow component.
message
dapr.proto:1028GetWorkflowResponse is the response for GetWorkflowBeta1.
Used as response type in: Dapr.GetWorkflowAlpha1, Dapr.GetWorkflowBeta1
string instance_id = 1
ID of the workflow instance.
string workflow_name = 2
Name of the workflow.
optional created_at = 3
The time at which the workflow instance was created.
optional last_updated_at = 4
The last time at which the workflow instance had its state changed.
string runtime_status = 5
The current status of the workflow instance, for example, "PENDING", "RUNNING", "SUSPENDED", "COMPLETED", "FAILED", and "TERMINATED".
map<string, string> properties = 6
Additional component-specific properties of the workflow instance.
message
dapr.proto:643Used in:
string name = 1
message
dapr.proto:1072PauseWorkflowRequest is the request for PauseWorkflowBeta1.
Used as request type in: Dapr.PauseWorkflowAlpha1, Dapr.PauseWorkflowBeta1
string instance_id = 1
ID of the workflow instance to pause.
string workflow_component = 2
Name of the workflow component.
message
dapr.proto:662Used in:
string pubsub_name = 1
string topic = 2
map<string, string> metadata = 3
optional rules = 4
string dead_letter_topic = 5
message
dapr.proto:674Used in:
string match = 1
string path = 2
message
dapr.proto:670Used in:
repeated rules = 1
message
dapr.proto:1100PurgeWorkflowRequest is the request for PurgeWorkflowBeta1.
Used as request type in: Dapr.PurgeWorkflowAlpha1, Dapr.PurgeWorkflowBeta1
string instance_id = 1
ID of the workflow instance to purge.
string workflow_component = 2
Name of the workflow component.
message
dapr.proto:321Used 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:1088RaiseEventWorkflowRequest is the request for RaiseEventWorkflowBeta1.
Used as request type in: Dapr.RaiseEventWorkflowAlpha1, Dapr.RaiseEventWorkflowBeta1
string instance_id = 1
ID of the workflow instance to raise an event for.
string workflow_component = 2
Name of the workflow component.
string event_name = 3
Name of the event.
bytes event_data = 4
Data associated with the event.
message
dapr.proto:636Used in:
string name = 1
string type = 2
string version = 3
repeated string capabilities = 4
message
dapr.proto:1080ResumeWorkflowRequest is the request for ResumeWorkflowBeta1.
Used as request type in: Dapr.ResumeWorkflowAlpha1, Dapr.ResumeWorkflowBeta1
string instance_id = 1
ID of the workflow instance to resume.
string workflow_component = 2
Name of the workflow component.
message
dapr.proto:473SecretResponse is a map of decrypted string/string values
Used in:
map<string, string> secrets = 1
message
dapr.proto:1044StartWorkflowRequest is the request for StartWorkflowBeta1.
Used as request type in: Dapr.StartWorkflowAlpha1, Dapr.StartWorkflowBeta1
string instance_id = 1
The ID to assign to the started workflow instance. If empty, a random ID is generated.
string workflow_component = 2
Name of the workflow component.
string workflow_name = 3
Name of the workflow.
map<string, string> options = 4
Additional component-specific options for starting the workflow instance.
bytes input = 5
Input data for the workflow instance.
message
dapr.proto:1058StartWorkflowResponse is the response for StartWorkflowBeta1.
Used as response type in: Dapr.StartWorkflowAlpha1, Dapr.StartWorkflowBeta1
string instance_id = 1
ID of the started workflow instance.
message
dapr.proto:705SubscribeConfigurationRequest is the message to get a list of key-value configuration from specified configuration store.
Used as request type in: Dapr.SubscribeConfiguration, Dapr.SubscribeConfigurationAlpha1
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:727Used as response type in: Dapr.SubscribeConfiguration, Dapr.SubscribeConfigurationAlpha1
string id = 1
Subscribe id, used to stop subscription.
map<string, > items = 2
The list of items containing configuration values
Used in:
PEM = 0
PEM (PKIX) (default)
JSON = 1
JSON (JSON Web Key) as string
message
dapr.proto:1064TerminateWorkflowRequest is the request for TerminateWorkflowBeta1.
Used as request type in: Dapr.TerminateWorkflowAlpha1, Dapr.TerminateWorkflowBeta1
string instance_id = 1
ID of the workflow instance to terminate.
string workflow_component = 2
Name of the workflow component.
message
appcallback.proto:146TopicEventBulkRequestEntry represents a single message inside a bulk request
Used in:
string entry_id = 1
Unique identifier for the message.
oneof event
The content of the event.
bytes bytes = 2
cloud_event = 3
string content_type = 4
content type of the event contained.
map<string, string> metadata = 5
The metadata associated with the event.
message
appcallback.proto:190TopicEventBulkResponseEntry Represents single response, as part of TopicEventBulkResponse, to be sent by subscibed App for the corresponding single message during bulk subscribe
Used in:
string entry_id = 1
Unique identifier associated the message.
TopicEventResponse.TopicEventResponseStatus status = 2
The status of the response.
message
appcallback.proto:122TopicEventCERequest message is compatible with CloudEvent spec v1.0
Used in:
string id = 1
The unique identifier of this cloud event.
string source = 2
source identifies the context in which an event happened.
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 = 6
The content of the event.
optional extensions = 7
Custom attributes which includes cloud event extensions.
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:273Used in:
repeated rules = 1
The list of rules for this topic.
string default = 2
The default path for this topic.
message
appcallback.proto:281Used 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:252TopicSubscription 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.
string dead_letter_topic = 6
The optional dead letter queue for this topic to send events to.
optional bulk_subscribe = 7
The optional bulk subscribe settings for this topic.
message
dapr.proto:565TransactionalActorStateOperation is the message to execute a specified operation with a key-value pair.
Used in:
string operationType = 1
string key = 2
optional value = 3
map<string, string> metadata = 4
The metadata used for transactional operations. Common metadata property: - ttlInSeconds : the time to live in seconds for the stored value.
message
dapr.proto:485TransactionalStateOperation 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
Used in:
SUCCESS = 0
LOCK_DOES_NOT_EXIST = 1
LOCK_BELONGS_TO_OTHERS = 2
INTERNAL_ERROR = 3
message
dapr.proto:719UnSubscribeConfigurationRequest is the message to stop watching the key-value configuration.
Used as request type in: Dapr.UnsubscribeConfiguration, Dapr.UnsubscribeConfigurationAlpha1
string store_name = 1
The name of configuration store.
string id = 2
The id to unsubscribe.
message
dapr.proto:735Used as response type in: Dapr.UnsubscribeConfiguration, Dapr.UnsubscribeConfigurationAlpha1
bool ok = 1
string message = 2