package dapr.proto.common.v1

Get desktop application:
View/edit binary Protocol Buffers messages

ConfigurationItem represents all the configuration with its name(key).

Used in: runtime.v1.GetConfigurationResponse, runtime.v1.SubscribeConfigurationResponse

• string value = 1

  Required. The value of configuration item.

• string version = 2

  Version is response only and cannot be fetched. Store is not expected to keep all versions available

• map<string, string> metadata = 3

  the metadata which will be passed to/from configuration store component.

Etag represents a state item version

Used in: StateItem, runtime.v1.DeleteStateRequest

• string value = 1

  value sets the etag value

HTTPExtension includes HTTP verb and querystring when Dapr runtime delivers HTTP content. For example, when callers calls http invoke api POST http://localhost:3500/v1.0/invoke/<app_id>/method/<method>?query1=value1&query2=value2 Dapr runtime will parse POST as a verb and extract querystring to quersytring map.

Used in: InvokeRequest

• HTTPExtension.Verb verb = 1

  Required. HTTP verb.

• string querystring = 2

  Optional. querystring represents an encoded HTTP url query string in the following format: name=value&name2=value2

Type of HTTP 1.1 Methods RFC 7231: https://tools.ietf.org/html/rfc7231#page-24 RFC 5789: https://datatracker.ietf.org/doc/html/rfc5789

Used in: HTTPExtension

• NONE = 0

• GET = 1

• HEAD = 2

• POST = 3

• PUT = 4

• DELETE = 5

• CONNECT = 6

• OPTIONS = 7

• TRACE = 8

• PATCH = 9

InvokeRequest is the message to invoke a method with the data. This message is used in InvokeService of Dapr gRPC Service and OnInvoke of AppCallback gRPC service.

Used as request type in: runtime.v1.AppCallback.OnInvoke

Used as field type in: runtime.v1.InvokeServiceRequest

• string method = 1

  Required. method is a method name which will be invoked by caller.

• optional google.protobuf.Any data = 2

  Required in unary RPCs. Bytes value or Protobuf message which caller sent. Dapr treats Any.value as bytes type if Any.type_url is unset.

• string content_type = 3

  The type of data content. This field is required if data delivers http request body Otherwise, this is optional.

• optional HTTPExtension http_extension = 4

  HTTP specific fields if request conveys http-compatible request. This field is required for http-compatible request. Otherwise, this field is optional.

InvokeResponse is the response message including data and its content type from app callback. This message is used in InvokeService of Dapr gRPC Service and OnInvoke of AppCallback gRPC service.

Used as response type in: runtime.v1.AppCallback.OnInvoke, runtime.v1.Dapr.InvokeService

• optional google.protobuf.Any data = 1

  Required in unary RPCs. The content body of InvokeService response.

• string content_type = 2

  Required. The type of data content.

StateItem represents state key, value, and additional options to save state.

Used in: runtime.v1.BindingEventResponse, runtime.v1.DeleteBulkStateRequest, runtime.v1.SaveStateRequest, runtime.v1.TransactionalStateOperation

• string key = 1

  Required. The state key

• bytes value = 2

  Required. The state data for key

• optional Etag etag = 3

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

• map<string, string> metadata = 4

  The metadata which will be passed to state store component.

• optional StateOptions options = 5

  Options for concurrency and consistency to save the state.

StateOptions configures concurrency and consistency for state operations

Used in: StateItem, runtime.v1.DeleteStateRequest

• 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: StateOptions, runtime.v1.GetStateRequest

• CONSISTENCY_UNSPECIFIED = 0

• CONSISTENCY_EVENTUAL = 1

• CONSISTENCY_STRONG = 2

Chunk of data sent in a streaming request or response. This is used in requests including InternalInvokeRequestStream.

Used in: runtime.v1.DecryptRequest, runtime.v1.DecryptResponse, runtime.v1.EncryptRequest, runtime.v1.EncryptResponse

• bytes data = 1

  Data sent in the chunk. The amount of data included in each chunk is up to the discretion of the sender, and can be empty. Additionally, the amount of data doesn't need to be fixed and subsequent messages can send more, or less, data. Receivers must not make assumptions about the number of bytes they'll receive in each chunk.

• uint64 seq = 2

  Sequence number. This is a counter that starts from 0 and increments by 1 on each chunk sent.