package dapr.proto.components.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Interface for input bindings

• rpc Init (InputBindingInitRequest, InputBindingInitResponse)

  bindings.proto:25

  Initializes the inputbinding component component with the given metadata.

  message InputBindingInitRequest

  bindings.proto:60

  InputBindingInitRequest is the request for initializing the input binding component.

  • optional MetadataRequest metadata = 1

    The metadata request.

  message InputBindingInitResponse

  bindings.proto:66

  reserved for future-proof extensibility

  (message has no fields)

• rpc Read (stream ReadRequest, stream ReadResponse)

  bindings.proto:31

  Establishes a stream with the server, which sends messages down to the client. The client streams acknowledgements back to the server. The server will close the stream and return the status on any error. In case of closed connection, the client should re-establish the stream.

  message ReadRequest

  bindings.proto:83

  • bytes response_data = 1

    The handle response.

  • string message_id = 2

    The unique message ID.

  • optional AckResponseError response_error = 3

    Optional, should not be fulfilled when the message was successfully handled.

  message ReadResponse

  bindings.proto:93

  • bytes data = 1

    The Read binding Data.

  • map<string, string> metadata = 2

    The message metadata

  • string content_type = 3

    The message content type.

  • string message_id = 4

    The {transient} message ID used for ACK-ing it later.

• rpc Ping (PingRequest, PingResponse)

  bindings.proto:34

  Ping the InputBinding. Used for liveness porpuses.

• rpc Init (OutputBindingInitRequest, OutputBindingInitResponse)

  bindings.proto:39

  Initializes the outputbinding component component with the given metadata.

  message OutputBindingInitRequest

  bindings.proto:70

  OutputBindingInitRequest is the request for initializing the output binding component.

  • optional MetadataRequest metadata = 1

    The metadata request.

  message OutputBindingInitResponse

  bindings.proto:76

  reserved for future-proof extensibility

  (message has no fields)

• rpc Invoke (InvokeRequest, InvokeResponse)

  bindings.proto:42

  Invoke remote systems with optional payloads.

  message InvokeRequest

  bindings.proto:105

  Used for invoking systems with optional payload.

  • bytes data = 1

    The invoke payload.

  • map<string, string> metadata = 2

    The invoke metadata.

  • string operation = 3

    The system supported operation.

  message InvokeResponse

  bindings.proto:115

  Response from the invoked system.

  • bytes data = 1

    The response payload.

  • map<string, string> metadata = 2

    The response metadata.

  • string content_type = 3

    The response content-type.

• rpc ListOperations (ListOperationsRequest, ListOperationsResponse)

  bindings.proto:45

  ListOperations list system supported operations.

  message ListOperationsRequest

  bindings.proto:51

  reserved for future-proof extensibility

  (message has no fields)

  message ListOperationsResponse

  bindings.proto:53

  • repeated string operations = 1

    the list of all supported component operations.

• rpc Ping (PingRequest, PingResponse)

  bindings.proto:48

  Ping the OutputBinding. Used for liveness porpuses.

PubSub service provides a gRPC interface for pubsub components.

• rpc Init (PubSubInitRequest, PubSubInitResponse)

  pubsub.proto:25

  Initializes the pubsub component with the given metadata.

  message PubSubInitRequest

  pubsub.proto:67

  PubSubInitRequest is the request for initializing the pubsub component.

  • optional MetadataRequest metadata = 1

    The metadata request.

  message PubSubInitResponse

  pubsub.proto:73

  reserved for future-proof extensibility

  (message has no fields)

• rpc Features (FeaturesRequest, FeaturesResponse)

  pubsub.proto:28

  Returns a list of implemented pubsub features.

• rpc Publish (PublishRequest, PublishResponse)

  pubsub.proto:31

  Publish publishes a new message for the given topic.

  message PublishRequest

  pubsub.proto:75

  • bytes data = 1

  • string pubsub_name = 2

    The pubsub name.

  • string topic = 3

    The publishing topic.

  • map<string, string> metadata = 4

    Message metadata.

  • string content_type = 5

    The data content type.

  message PublishResponse

  pubsub.proto:111

  reserved for future-proof extensibility

  (message has no fields)

• rpc BulkPublish (BulkPublishRequest, BulkPublishResponse)

  pubsub.proto:33

  message BulkPublishRequest

  pubsub.proto:87

  • repeated BulkMessageEntry entries = 1

  • string pubsub_name = 2

  • string topic = 3

  • map<string, string> metadata = 4

  message BulkPublishResponse

  pubsub.proto:101

  • repeated BulkPublishResponseFailedEntry failed_entries = 1

• rpc PullMessages (stream PullMessagesRequest, stream PullMessagesResponse)

  pubsub.proto:41

  Establishes a stream with the server (PubSub component), which sends messages down to the client (daprd). The client streams acknowledgements back to the server. The server will close the stream and return the status on any error. In case of closed connection, the client should re-establish the stream. The first message MUST contain a `topic` attribute on it that should be used for the entire streaming pull.

  message PullMessagesRequest

  pubsub.proto:54

  Used for acknowledge a message.

  • optional Topic topic = 1

    Required. The subscribed topic for which to initialize the new stream. This must be provided in the first request on the stream, and must not be set in subsequent requests from client to server.

  • string ack_message_id = 2

    The unique message ID.

  • optional AckMessageError ack_error = 3

    Optional, should not be fulfilled when the message was successfully handled.

  message PullMessagesResponse

  pubsub.proto:120

  • bytes data = 1

    The message content.

  • string topic_name = 2

    The topic where the message come from.

  • map<string, string> metadata = 3

    The message related metadata.

  • string content_type = 4

    The message content type.

  • string id = 5

    The message {transient} ID. Its used for ack'ing it later.

• rpc Ping (PingRequest, PingResponse)

  pubsub.proto:45

  Ping the pubsub. Used for liveness porpuses.

QueriableStateStore service provides a gRPC interface for querier state store components. It was designed to embed query features to the StateStore Service as a complementary service.

• rpc Query (QueryRequest, QueryResponse)

  state.proto:28

  Query performs a query request on the statestore.

  message QueryRequest

  state.proto:59

  QueryRequest is for querying state store.

  • optional Query query = 1

    The query to be performed.

  • map<string, string> metadata = 2

    Request associated metadata.

  message QueryResponse

  state.proto:81

  QueryResponse is the query response.

  • repeated QueryItem items = 1

    The query response items.

  • string token = 2

    The response token.

  • map<string, string> metadata = 3

    Response associated metadata.

Interface for secret store.

• rpc Init (SecretStoreInitRequest, SecretStoreInitResponse)

  secretstore.proto:25

  Initializes the secret store with the given metadata.

  message SecretStoreInitRequest

  secretstore.proto:41

  Request to initialize the secret store.

  • optional MetadataRequest metadata = 1

  message SecretStoreInitResponse

  secretstore.proto:46

  Response from initialization.

  (message has no fields)

• rpc Features (FeaturesRequest, FeaturesResponse)

  secretstore.proto:28

  Returns a list of implemented secret store features.

• rpc Get (GetSecretRequest, GetSecretResponse)

  secretstore.proto:31

  Get an individual secret from the store.

  message GetSecretRequest

  secretstore.proto:49

  GetSecretRequest is the message to get secret from secret store.

  • string key = 1

    The name of secret key.

  • map<string, string> metadata = 2

    The metadata which will be sent to secret store components.

  message GetSecretResponse

  secretstore.proto:58

  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 BulkGet (BulkGetSecretRequest, BulkGetSecretResponse)

  secretstore.proto:34

  Get all secrets from the store.

  message BulkGetSecretRequest

  secretstore.proto:65

  BulkGetSecretRequest is the message to get the secrets from secret store.

  • map<string, string> metadata = 1

    The metadata which will be sent to secret store components.

  message BulkGetSecretResponse

  secretstore.proto:76

  BulkGetSecretResponse 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 Ping (PingRequest, PingResponse)

  secretstore.proto:37

  Ping the pubsub. Used for liveness porpuses.

StateStore service provides a gRPC interface for state store components.

• rpc Init (InitRequest, InitResponse)

  state.proto:125

  Initializes the state store component with the given metadata.

  message InitRequest

  state.proto:179

  InitRequest is the request for initializing the component.

  • optional MetadataRequest metadata = 1

  message InitResponse

  state.proto:184

  reserved for future-proof extensibility

  (message has no fields)

• rpc Features (FeaturesRequest, FeaturesResponse)

  state.proto:128

  Returns a list of implemented state store features.

• rpc Delete (DeleteRequest, DeleteResponse)

  state.proto:131

  Deletes the specified key from the state store.

  message DeleteResponse

  state.proto:218

  reserved for future-proof extensibility

  (message has no fields)

• rpc Get (GetRequest, GetResponse)

  state.proto:134

  Get data from the given key.

  message GetResponse

  state.proto:195

  • bytes data = 1

    The data of the GetRequest response.

  • optional Etag etag = 2

    The etag of the associated key.

  • map<string, string> metadata = 3

    Metadata related to the response.

  • string content_type = 4

    The response data contenttype

• rpc Set (SetRequest, SetResponse)

  state.proto:137

  Sets the value of the specified key.

  message SetResponse

  state.proto:237

  reserved for future-proof extensibility

  (message has no fields)

• rpc Ping (PingRequest, PingResponse)

  state.proto:140

  Ping the state store. Used for liveness porpuses.

• rpc BulkDelete (BulkDeleteRequest, BulkDeleteResponse)

  state.proto:143

  Deletes many keys at once.

  message BulkDeleteRequest

  state.proto:243

  • repeated DeleteRequest items = 1

  • optional BulkDeleteRequestOptions options = 2

  message BulkDeleteResponse

  state.proto:249

  reserved for future-proof extensibility

  (message has no fields)

• rpc BulkGet (BulkGetRequest, BulkGetResponse)

  state.proto:146

  Retrieves many keys at once.

  message BulkGetRequest

  state.proto:255

  • repeated GetRequest items = 1

  • optional BulkGetRequestOptions options = 2

  message BulkGetResponse

  state.proto:275

  • repeated BulkStateItem items = 1

• rpc BulkSet (BulkSetRequest, BulkSetResponse)

  state.proto:149

  Set the value of many keys at once.

  message BulkSetRequest

  state.proto:283

  • repeated SetRequest items = 1

  • optional BulkSetRequestOptions options = 2

  message BulkSetResponse

  state.proto:289

  reserved for future-proof extensibility

  (message has no fields)

TransactionalStateStore service provides a gRPC interface for transactional state store components. It was designed to embed transactional features to the StateStore Service as a complementary service.

• rpc Transact (TransactionalStateRequest, TransactionalStateResponse)

  state.proto:95

  Transact executes multiples operation in a transactional environment.

  message TransactionalStateRequest

  state.proto:112

  TransactionalStateRequest describes a transactional operation against a state store that comprises multiple types of operations The Request field is either a DeleteRequest or SetRequest.

  • repeated TransactionalStateOperation operations = 1

    Operations that should be performed.

  • map<string, string> metadata = 2

    Request associated metadata.

  message TransactionalStateResponse

  state.proto:120

  reserved for future-proof extensibility

  (message has no fields)

Used for describing errors when ack'ing messages.

Used in: PullMessagesRequest

• string message = 1

Used for describing errors when ack'ing messages.

Used in: ReadRequest

• string message = 1

Used in: BulkDeleteRequest

• int64 parallelism = 1

Used in: BulkGetRequest

• int64 parallelism = 1

Used in: BulkPublishRequest

• string entry_id = 1

• bytes event = 2

• string content_type = 3

• map<string, string> metadata = 4

Used in: BulkPublishResponse

• string entry_id = 1

• string error = 2

Used in: BulkSetRequest

• int64 parallelism = 1

Used in: BulkGetResponse

• string key = 1

  The key of the fetched item.

• bytes data = 2

  The associated data of the fetched item.

• optional Etag etag = 3

  The item ETag

• string error = 4

  A fetch error if there's some.

• map<string, string> metadata = 5

  The State Item metadata.

• string content_type = 6

  The data contenttype

Used as request type in: StateStore.Delete

Used as field type in: BulkDeleteRequest, TransactionalStateOperation

• string key = 1

  The key that should be deleted.

• optional Etag etag = 2

  The etag is used as a If-Match header, to allow certain levels of consistency.

• map<string, string> metadata = 3

  The request metadata.

• optional StateOptions options = 4

Etag represents a state item version

Used in: BulkStateItem, DeleteRequest, GetResponse, QueryItem, SetRequest

• string value = 1

  value sets the etag value

reserved for future-proof extensibility

Used as request type in: PubSub.Features, SecretStore.Features, StateStore.Features

(message has no fields)

Used as response type in: PubSub.Features, SecretStore.Features, StateStore.Features

• repeated string features = 1

Used as request type in: StateStore.Get

Used as field type in: BulkGetRequest

• string key = 1

  The key that should be retrieved.

• map<string, string> metadata = 2

  Request associated metadata.

• StateOptions.StateConsistency consistency = 3

  The get consistency level.

Base metadata request for all components

Used in: InitRequest, InputBindingInitRequest, OutputBindingInitRequest, PubSubInitRequest, SecretStoreInitRequest

• map<string, string> properties = 1

Used in: Query

• int64 limit = 1

  Maximum of results that should be returned.

• string token = 2

  The pagination token.

reserved for future-proof extensibility

Used as request type in: InputBinding.Ping, OutputBinding.Ping, PubSub.Ping, SecretStore.Ping, StateStore.Ping

(message has no fields)

reserved for future-proof extensibility

Used as response type in: InputBinding.Ping, OutputBinding.Ping, PubSub.Ping, SecretStore.Ping, StateStore.Ping

(message has no fields)

Used in: QueryRequest

• map<string, google.protobuf.Any> filter = 1

  Filters that should be applied.

• repeated Sorting sort = 2

  The sort order.

• optional Pagination pagination = 3

  The query pagination params.

QueryItem is an object representing a single entry in query results.

Used in: QueryResponse

• string key = 1

  The returned item Key.

• bytes data = 2

  The returned item Data.

• optional Etag etag = 3

  The returned item ETag

• string error = 4

  The returned error string.

• string content_type = 5

  The returned contenttype

SecretResponse is a map of decrypted string/string values

Used in: BulkGetSecretResponse

• map<string, string> secrets = 1

Used as request type in: StateStore.Set

Used as field type in: BulkSetRequest, TransactionalStateOperation

• string key = 1

  The key that should be set.

• bytes value = 2

  Value is the desired content of the given key.

• optional Etag etag = 3

  The etag is used as a If-Match header, to allow certain levels of consistency.

• map<string, string> metadata = 4

  The request metadata.

• optional StateOptions options = 5

  The Set request options.

• string content_type = 6

  The data contenttype

Used in: Query

• string key = 1

  The key that should be used for sorting.

• Sorting.Order order = 2

  The order that should be used.

Used in: Sorting

• ASC = 0

• DESC = 1

StateOptions configures concurrency and consistency for state operations

Used in: DeleteRequest, SetRequest

• StateOptions.StateConcurrency concurrency = 1

• StateOptions.StateConsistency consistency = 2

Enum describing the supported concurrency for state.

Used in: StateOptions

• CONCURRENCY_UNSPECIFIED = 0

• CONCURRENCY_FIRST_WRITE = 1

• CONCURRENCY_LAST_WRITE = 2

Enum describing the supported consistency for state.

Used in: GetRequest, StateOptions

• CONSISTENCY_UNSPECIFIED = 0

• CONSISTENCY_EVENTUAL = 1

• CONSISTENCY_STRONG = 2

Used in: PullMessagesRequest

• string name = 1

  The topic name desired to be subscribed

• map<string, string> metadata = 2

  Metadata related subscribe request.

TransactionalStateOperation describes operation type, key, and value for transactional operation.

Used in: TransactionalStateRequest

• oneof request

  request is either delete or set.

  • DeleteRequest delete = 1

  • SetRequest set = 2