All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DaprClientGrpc, DaprClientHttp
```
public interface DaprClient
extends AutoCloseable
```
Generic Client Adapter to be used regardless of the GRPC or the HTTP Client implementation required.

See Also:

for information on how to make instance for this interface.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`reactor.core.publisher.Mono<Void>`	`deleteState(DeleteStateRequest request)`	Delete a state.
`reactor.core.publisher.Mono<Void>`	`deleteState(String storeName, String key)`	Delete a state.
`reactor.core.publisher.Mono<Void>`	`deleteState(String storeName, String key, String etag, StateOptions options)`	Delete a state.
`reactor.core.publisher.Mono<Void>`	`executeStateTransaction(ExecuteStateTransactionRequest request)`	Execute a transaction.
`reactor.core.publisher.Mono<Void>`	`executeStateTransaction(String storeName, List<TransactionalStateOperation<?>> operations)`	Execute a transaction.
`reactor.core.publisher.Mono<Map<String,Map<String,String>>>`	`getBulkSecret(GetBulkSecretRequest request)`	Fetches all secrets from the configured vault.
`reactor.core.publisher.Mono<Map<String,Map<String,String>>>`	`getBulkSecret(String storeName)`	Fetches all secrets from the configured vault.
`reactor.core.publisher.Mono<Map<String,Map<String,String>>>`	`getBulkSecret(String storeName, Map<String,String> metadata)`	Fetches all secrets from the configured vault.
`<T> reactor.core.publisher.Mono<List<State<T>>>`	`getBulkState(GetBulkStateRequest request, TypeRef<T> type)`	Retrieve bulk States based on their keys.
`<T> reactor.core.publisher.Mono<List<State<T>>>`	`getBulkState(String storeName, List<String> keys, TypeRef<T> type)`	Retrieve bulk States based on their keys.
`<T> reactor.core.publisher.Mono<List<State<T>>>`	`getBulkState(String storeName, List<String> keys, Class<T> clazz)`	Retrieve bulk States based on their keys.
`reactor.core.publisher.Mono<Map<String,ConfigurationItem>>`	`getConfiguration(GetConfigurationRequest request)`	Retrieve Map of configurations based on a provided configuration request object.
`reactor.core.publisher.Mono<ConfigurationItem>`	`getConfiguration(String storeName, String key)`	Retrieve a configuration based on a provided key.
`reactor.core.publisher.Mono<Map<String,ConfigurationItem>>`	`getConfiguration(String storeName, String... keys)`	Retrieve Map of configurations based on a provided variable number of keys.
`reactor.core.publisher.Mono<ConfigurationItem>`	`getConfiguration(String storeName, String key, Map<String,String> metadata)`	Retrieve a configuration based on a provided key.
`reactor.core.publisher.Mono<Map<String,ConfigurationItem>>`	`getConfiguration(String storeName, List<String> keys, Map<String,String> metadata)`	Retrieve Map of configurations based on a provided variable number of keys.
`reactor.core.publisher.Mono<Map<String,String>>`	`getSecret(GetSecretRequest request)`	Fetches a secret from the configured vault.
`reactor.core.publisher.Mono<Map<String,String>>`	`getSecret(String storeName, String secretName)`	Fetches a secret from the configured vault.
`reactor.core.publisher.Mono<Map<String,String>>`	`getSecret(String storeName, String secretName, Map<String,String> metadata)`	Fetches a secret from the configured vault.
`<T> reactor.core.publisher.Mono<State<T>>`	`getState(GetStateRequest request, TypeRef<T> type)`	Retrieve a State based on their key.
`<T> reactor.core.publisher.Mono<State<T>>`	`getState(String storeName, State<T> state, TypeRef<T> type)`	Retrieve a State based on their key.
`<T> reactor.core.publisher.Mono<State<T>>`	`getState(String storeName, State<T> state, Class<T> clazz)`	Retrieve a State based on their key.
`<T> reactor.core.publisher.Mono<State<T>>`	`getState(String storeName, String key, StateOptions options, TypeRef<T> type)`	Retrieve a State based on their key.
`<T> reactor.core.publisher.Mono<State<T>>`	`getState(String storeName, String key, StateOptions options, Class<T> clazz)`	Retrieve a State based on their key.
`<T> reactor.core.publisher.Mono<State<T>>`	`getState(String storeName, String key, TypeRef<T> type)`	Retrieve a State based on their key.
`<T> reactor.core.publisher.Mono<State<T>>`	`getState(String storeName, String key, Class<T> clazz)`	Retrieve a State based on their key.
`<T> reactor.core.publisher.Mono<T>`	`invokeBinding(InvokeBindingRequest request, TypeRef<T> type)`	Invokes a Binding operation.
`reactor.core.publisher.Mono<byte[]>`	`invokeBinding(String bindingName, String operation, byte[] data, Map<String,String> metadata)`	Invokes a Binding operation, skipping serialization.
`reactor.core.publisher.Mono<Void>`	`invokeBinding(String bindingName, String operation, Object data)`	Invokes a Binding operation.
`<T> reactor.core.publisher.Mono<T>`	`invokeBinding(String bindingName, String operation, Object data, TypeRef<T> type)`	Invokes a Binding operation.
`<T> reactor.core.publisher.Mono<T>`	`invokeBinding(String bindingName, String operation, Object data, Class<T> clazz)`	Invokes a Binding operation.
`<T> reactor.core.publisher.Mono<T>`	`invokeBinding(String bindingName, String operation, Object data, Map<String,String> metadata, TypeRef<T> type)`	Invokes a Binding operation.
`<T> reactor.core.publisher.Mono<T>`	`invokeBinding(String bindingName, String operation, Object data, Map<String,String> metadata, Class<T> clazz)`	Invokes a Binding operation.
`<T> reactor.core.publisher.Mono<T>`	`invokeMethod(InvokeMethodRequest invokeMethodRequest, TypeRef<T> type)`	Invoke a service method.
`reactor.core.publisher.Mono<byte[]>`	`invokeMethod(String appId, String methodName, byte[] request, HttpExtension httpExtension, Map<String,String> metadata)`	Invoke a service method, without using serialization.
`reactor.core.publisher.Mono<Void>`	`invokeMethod(String appId, String methodName, HttpExtension httpExtension, Map<String,String> metadata)`	Invoke a service method, using serialization.
`<T> reactor.core.publisher.Mono<T>`	`invokeMethod(String appId, String methodName, HttpExtension httpExtension, Map<String,String> metadata, TypeRef<T> type)`	Invoke a service method, using serialization.
`<T> reactor.core.publisher.Mono<T>`	`invokeMethod(String appId, String methodName, HttpExtension httpExtension, Map<String,String> metadata, Class<T> clazz)`	Invoke a service method, using serialization.
`reactor.core.publisher.Mono<Void>`	`invokeMethod(String appId, String methodName, Object request, HttpExtension httpExtension)`	Invoke a service method, using serialization.
`<T> reactor.core.publisher.Mono<T>`	`invokeMethod(String appId, String methodName, Object request, HttpExtension httpExtension, TypeRef<T> type)`	Invoke a service method, using serialization.
`<T> reactor.core.publisher.Mono<T>`	`invokeMethod(String appId, String methodName, Object request, HttpExtension httpExtension, Class<T> clazz)`	Invoke a service method, using serialization.
`reactor.core.publisher.Mono<Void>`	`invokeMethod(String appId, String methodName, Object request, HttpExtension httpExtension, Map<String,String> metadata)`	Invoke a service method, using serialization.
`<T> reactor.core.publisher.Mono<T>`	`invokeMethod(String appId, String methodName, Object data, HttpExtension httpExtension, Map<String,String> metadata, TypeRef<T> type)`	Invoke a service method, using serialization.
`<T> reactor.core.publisher.Mono<T>`	`invokeMethod(String appId, String methodName, Object request, HttpExtension httpExtension, Map<String,String> metadata, Class<T> clazz)`	Invoke a service method, using serialization.
`reactor.core.publisher.Mono<Void>`	`publishEvent(PublishEventRequest request)`	Publish an event.
`reactor.core.publisher.Mono<Void>`	`publishEvent(String pubsubName, String topicName, Object data)`	Publish an event.
`reactor.core.publisher.Mono<Void>`	`publishEvent(String pubsubName, String topicName, Object data, Map<String,String> metadata)`	Publish an event.
`reactor.core.publisher.Mono<Void>`	`saveBulkState(SaveStateRequest request)`	Save/Update a list of states.
`reactor.core.publisher.Mono<Void>`	`saveBulkState(String storeName, List<State<?>> states)`	Save/Update a list of states.
`reactor.core.publisher.Mono<Void>`	`saveState(String storeName, String key, Object value)`	Save/Update a state.
`reactor.core.publisher.Mono<Void>`	`saveState(String storeName, String key, String etag, Object value, StateOptions options)`	Save/Update a state.
`reactor.core.publisher.Mono<Void>`	`shutdown()`	Gracefully shutdown the dapr runtime.
`reactor.core.publisher.Flux<SubscribeConfigurationResponse>`	`subscribeConfiguration(SubscribeConfigurationRequest request)`	Subscribe to the keys for any change.
`reactor.core.publisher.Flux<SubscribeConfigurationResponse>`	`subscribeConfiguration(String storeName, String... keys)`	Subscribe to the keys for any change.
`reactor.core.publisher.Flux<SubscribeConfigurationResponse>`	`subscribeConfiguration(String storeName, List<String> keys, Map<String,String> metadata)`	Subscribe to the keys for any change.
`reactor.core.publisher.Mono<UnsubscribeConfigurationResponse>`	`unsubscribeConfiguration(UnsubscribeConfigurationRequest request)`	Unsubscribe from previously subscribed keys.
`reactor.core.publisher.Mono<UnsubscribeConfigurationResponse>`	`unsubscribeConfiguration(String id, String storeName)`	Unsubscribe from previously subscribed keys.
`reactor.core.publisher.Mono<Void>`	`waitForSidecar(int timeoutInMilliseconds)`	Waits for the sidecar, giving up after timeout.

Methods inherited from interface java.lang.AutoCloseable
close

Method Detail

waitForSidecar
```
reactor.core.publisher.Mono<Void> waitForSidecar(int timeoutInMilliseconds)
```
Waits for the sidecar, giving up after timeout.

Parameters:

timeoutInMilliseconds - Timeout in milliseconds to wait for sidecar.

Returns:

a Mono plan of type Void.

publishEvent

reactor.core.publisher.Mono<Void> publishEvent(String pubsubName,
                                               String topicName,
                                               Object data)

Publish an event.

Parameters:: pubsubName - the pubsub name we will publish the event to; topicName - the topicName where the event will be published.; data - the event's data to be published, use byte[] for skipping serialization.
Returns:: a Mono plan of type Void.

publishEvent

reactor.core.publisher.Mono<Void> publishEvent(String pubsubName,
                                               String topicName,
                                               Object data,
                                               Map<String,String> metadata)

Publish an event.

Parameters:: pubsubName - the pubsub name we will publish the event to; topicName - the topicName where the event will be published.; data - the event's data to be published, use byte[] for skipping serialization.; metadata - The metadata for the published event.
Returns:: a Mono plan of type Void.

publishEvent
```
reactor.core.publisher.Mono<Void> publishEvent(PublishEventRequest request)
```
Publish an event.

Parameters:

request - the request for the publish event.

Returns:

a Mono plan of a Dapr's void response.

invokeMethod

<T> reactor.core.publisher.Mono<T> invokeMethod(String appId,
                                                String methodName,
                                                Object data,
                                                HttpExtension httpExtension,
                                                Map<String,String> metadata,
                                                TypeRef<T> type)

Invoke a service method, using serialization.

Type Parameters:: T - The Type of the return, use byte[] to skip serialization.
Parameters:: appId - The Application ID where the service is.; methodName - The actual Method to be call in the application.; data - The data to be sent to invoke the service, use byte[] to skip serialization.; httpExtension - Additional fields that are needed if the receiving app is listening on HTTP, HttpExtension.NONE otherwise.; metadata - Metadata (in GRPC) or headers (in HTTP) to be sent in data.; type - The Type needed as return for the call.
Returns:: A Mono Plan of type T.

invokeMethod

<T> reactor.core.publisher.Mono<T> invokeMethod(String appId,
                                                String methodName,
                                                Object request,
                                                HttpExtension httpExtension,
                                                Map<String,String> metadata,
                                                Class<T> clazz)

Invoke a service method, using serialization.

Type Parameters:: T - The Type of the return, use byte[] to skip serialization.
Parameters:: appId - The Application ID where the service is.; methodName - The actual Method to be call in the application.; request - The request to be sent to invoke the service, use byte[] to skip serialization.; httpExtension - Additional fields that are needed if the receiving app is listening on HTTP, HttpExtension.NONE otherwise.; metadata - Metadata (in GRPC) or headers (in HTTP) to be sent in request.; clazz - The type needed as return for the call.
Returns:: A Mono Plan of type T.

invokeMethod
```
<T> reactor.core.publisher.Mono<T> invokeMethod(String appId,
                                                String methodName,
                                                Object request,
                                                HttpExtension httpExtension,
                                                TypeRef<T> type)
```
Invoke a service method, using serialization.

Type Parameters:

T - The Type of the return, use byte[] to skip serialization.

Parameters:

appId - The Application ID where the service is.

methodName - The actual Method to be call in the application.

request - The request to be sent to invoke the service, use byte[] to skip serialization.

httpExtension - Additional fields that are needed if the receiving app is listening on HTTP, HttpExtension.NONE otherwise.

type - The Type needed as return for the call.

Returns:

A Mono Plan of type T.

invokeMethod
```
<T> reactor.core.publisher.Mono<T> invokeMethod(String appId,
                                                String methodName,
                                                Object request,
                                                HttpExtension httpExtension,
                                                Class<T> clazz)
```
Invoke a service method, using serialization.

Type Parameters:

T - The Type of the return, use byte[] to skip serialization.

Parameters:

appId - The Application ID where the service is.

methodName - The actual Method to be call in the application.

request - The request to be sent to invoke the service, use byte[] to skip serialization.

httpExtension - Additional fields that are needed if the receiving app is listening on HTTP, HttpExtension.NONE otherwise.

clazz - The type needed as return for the call.

Returns:

A Mono Plan of type T.

invokeMethod

<T> reactor.core.publisher.Mono<T> invokeMethod(String appId,
                                                String methodName,
                                                HttpExtension httpExtension,
                                                Map<String,String> metadata,
                                                TypeRef<T> type)

Invoke a service method, using serialization.

Type Parameters:: T - The Type of the return, use byte[] to skip serialization.
Parameters:: appId - The Application ID where the service is.; methodName - The actual Method to be call in the application.; httpExtension - Additional fields that are needed if the receiving app is listening on HTTP, HttpExtension.NONE otherwise.; metadata - Metadata (in GRPC) or headers (in HTTP) to be sent in request.; type - The Type needed as return for the call.
Returns:: A Mono Plan of type T.

invokeMethod

<T> reactor.core.publisher.Mono<T> invokeMethod(String appId,
                                                String methodName,
                                                HttpExtension httpExtension,
                                                Map<String,String> metadata,
                                                Class<T> clazz)

Invoke a service method, using serialization.

Type Parameters:: T - The Type of the return, use byte[] to skip serialization.
Parameters:: appId - The Application ID where the service is.; methodName - The actual Method to be call in the application.; httpExtension - Additional fields that are needed if the receiving app is listening on HTTP, HttpExtension.NONE otherwise.; metadata - Metadata (in GRPC) or headers (in HTTP) to be sent in request.; clazz - The type needed as return for the call.
Returns:: A Mono Plan of type T.

invokeMethod

reactor.core.publisher.Mono<Void> invokeMethod(String appId,
                                               String methodName,
                                               Object request,
                                               HttpExtension httpExtension,
                                               Map<String,String> metadata)

Invoke a service method, using serialization.

Parameters:: appId - The Application ID where the service is.; methodName - The actual Method to be call in the application.; request - The request to be sent to invoke the service, use byte[] to skip serialization.; httpExtension - Additional fields that are needed if the receiving app is listening on HTTP, HttpExtension.NONE otherwise.; metadata - Metadata (in GRPC) or headers (in HTTP) to be sent in request.
Returns:: A Mono Plan of type Void.

invokeMethod
```
reactor.core.publisher.Mono<Void> invokeMethod(String appId,
                                               String methodName,
                                               Object request,
                                               HttpExtension httpExtension)
```
Invoke a service method, using serialization.

Parameters:

appId - The Application ID where the service is.

methodName - The actual Method to be call in the application.

request - The request to be sent to invoke the service, use byte[] to skip serialization.

httpExtension - Additional fields that are needed if the receiving app is listening on HTTP, HttpExtension.NONE otherwise.

Returns:

A Mono Plan of type Void.

invokeMethod

reactor.core.publisher.Mono<Void> invokeMethod(String appId,
                                               String methodName,
                                               HttpExtension httpExtension,
                                               Map<String,String> metadata)

Invoke a service method, using serialization.

Parameters:: appId - The Application ID where the service is.; methodName - The actual Method to be call in the application.; httpExtension - Additional fields that are needed if the receiving app is listening on HTTP, HttpExtension.NONE otherwise.; metadata - Metadata (in GRPC) or headers (in HTTP) to be sent in request.
Returns:: A Mono Plan of type Void.

invokeMethod

reactor.core.publisher.Mono<byte[]> invokeMethod(String appId,
                                                 String methodName,
                                                 byte[] request,
                                                 HttpExtension httpExtension,
                                                 Map<String,String> metadata)

Invoke a service method, without using serialization.

Parameters:: appId - The Application ID where the service is.; methodName - The actual Method to be call in the application.; request - The request to be sent to invoke the service, use byte[] to skip serialization.; httpExtension - Additional fields that are needed if the receiving app is listening on HTTP, HttpExtension.NONE otherwise.; metadata - Metadata (in GRPC) or headers (in HTTP) to be sent in request.
Returns:: A Mono Plan of type byte[].

invokeMethod
```
<T> reactor.core.publisher.Mono<T> invokeMethod(InvokeMethodRequest invokeMethodRequest,
                                                TypeRef<T> type)
```
Invoke a service method.

Type Parameters:

T - The Type of the return, use byte[] to skip serialization.

Parameters:

invokeMethodRequest - Request object.

type - The Type needed as return for the call.

Returns:

A Mono Plan of type T.

invokeBinding

reactor.core.publisher.Mono<Void> invokeBinding(String bindingName,
                                                String operation,
                                                Object data)

Invokes a Binding operation.

Parameters:: bindingName - The bindingName of the biding to call.; operation - The operation to be performed by the binding request processor.; data - The data to be processed, use byte[] to skip serialization.
Returns:: an empty Mono.

invokeBinding

reactor.core.publisher.Mono<byte[]> invokeBinding(String bindingName,
                                                  String operation,
                                                  byte[] data,
                                                  Map<String,String> metadata)

Invokes a Binding operation, skipping serialization.

Parameters:: bindingName - The name of the biding to call.; operation - The operation to be performed by the binding request processor.; data - The data to be processed, skipping serialization.; metadata - The metadata map.
Returns:: a Mono plan of type byte[].

invokeBinding

<T> reactor.core.publisher.Mono<T> invokeBinding(String bindingName,
                                                 String operation,
                                                 Object data,
                                                 TypeRef<T> type)

Invokes a Binding operation.

Type Parameters:: T - The type of the return
Parameters:: bindingName - The name of the biding to call.; operation - The operation to be performed by the binding request processor.; data - The data to be processed, use byte[] to skip serialization.; type - The type being returned.
Returns:: a Mono plan of type T.

invokeBinding

<T> reactor.core.publisher.Mono<T> invokeBinding(String bindingName,
                                                 String operation,
                                                 Object data,
                                                 Class<T> clazz)

Invokes a Binding operation.

Type Parameters:: T - The type of the return
Parameters:: bindingName - The name of the biding to call.; operation - The operation to be performed by the binding request processor.; data - The data to be processed, use byte[] to skip serialization.; clazz - The type being returned.
Returns:: a Mono plan of type T.

invokeBinding

<T> reactor.core.publisher.Mono<T> invokeBinding(String bindingName,
                                                 String operation,
                                                 Object data,
                                                 Map<String,String> metadata,
                                                 TypeRef<T> type)

Invokes a Binding operation.

Type Parameters:: T - The type of the return
Parameters:: bindingName - The name of the biding to call.; operation - The operation to be performed by the binding request processor.; data - The data to be processed, use byte[] to skip serialization.; metadata - The metadata map.; type - The type being returned.
Returns:: a Mono plan of type T.

invokeBinding

<T> reactor.core.publisher.Mono<T> invokeBinding(String bindingName,
                                                 String operation,
                                                 Object data,
                                                 Map<String,String> metadata,
                                                 Class<T> clazz)

Invokes a Binding operation.

Type Parameters:: T - The type of the return
Parameters:: bindingName - The name of the biding to call.; operation - The operation to be performed by the binding request processor.; data - The data to be processed, use byte[] to skip serialization.; metadata - The metadata map.; clazz - The type being returned.
Returns:: a Mono plan of type T.

invokeBinding

<T> reactor.core.publisher.Mono<T> invokeBinding(InvokeBindingRequest request,
                                                 TypeRef<T> type)

Invokes a Binding operation.

Type Parameters:: T - The type of the return
Parameters:: request - The binding invocation request.; type - The type being returned.
Returns:: a Mono plan of type T.