DigitalTwinAsyncClient (Iot Hub Java Service SDK 2.1.6 API)

java.lang.Object
- com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinAsyncClient

```
public class DigitalTwinAsyncClient
extends Object
```
The Digital Twins Service Client contains asynchronous methods to retrieve and update digital twin information, and invoke commands on a digital twin device.

Constructor Summary

Constructors
Constructor and Description
`DigitalTwinAsyncClient(String connectionString)` Creates an implementation instance of `DigitalTwins` that is used to invoke the Digital Twin features
`DigitalTwinAsyncClient(String hostName, com.azure.core.credential.AzureSasCredential azureSasCredential)` Creates an implementation instance of `DigitalTwins` that is used to invoke the Digital Twin features
`DigitalTwinAsyncClient(String hostName, com.azure.core.credential.AzureSasCredential azureSasCredential, DigitalTwinClientOptions options)` Creates an implementation instance of `DigitalTwins` that is used to invoke the Digital Twin features
`DigitalTwinAsyncClient(String connectionString, DigitalTwinClientOptions options)` Creates an implementation instance of `DigitalTwins` that is used to invoke the Digital Twin features
`DigitalTwinAsyncClient(String hostName, com.azure.core.credential.TokenCredential credential)` Creates an implementation instance of `DigitalTwins` that is used to invoke the Digital Twin features
`DigitalTwinAsyncClient(String hostName, com.azure.core.credential.TokenCredential credential, DigitalTwinClientOptions options)` Creates an implementation instance of `DigitalTwins` that is used to invoke the Digital Twin features

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DigitalTwinAsyncClient`	`createFromConnectionString(String connectionString)` Creates an implementation instance of `DigitalTwins` that is used to invoke the Digital Twin features
`<T> rx.Observable<T>`	`getDigitalTwin(String digitalTwinId, Class<T> clazz)` Gets a digital twin.
`<T> rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<T,DigitalTwinGetHeaders>>`	`getDigitalTwinWithResponse(String digitalTwinId, Class<T> clazz)` Gets a digital twin.
`rx.Observable<DigitalTwinCommandResponse>`	`invokeCommand(String digitalTwinId, String commandName)` Invoke a command on a digital twin.
`rx.Observable<DigitalTwinCommandResponse>`	`invokeCommand(String digitalTwinId, String commandName, String payload)` Invoke a command on a digital twin.
`rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<DigitalTwinCommandResponse,DigitalTwinInvokeCommandHeaders>>`	`invokeCommandWithResponse(String digitalTwinId, String commandName, String payload, DigitalTwinInvokeCommandRequestOptions options)` Invoke a command on a digital twin.
`rx.Observable<DigitalTwinCommandResponse>`	`invokeComponentCommand(String digitalTwinId, String componentName, String commandName)` Invoke a command on a digital twin component.
`rx.Observable<DigitalTwinCommandResponse>`	`invokeComponentCommand(String digitalTwinId, String componentName, String commandName, String payload)` Invoke a command on a digital twin component.
`rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<DigitalTwinCommandResponse,DigitalTwinInvokeCommandHeaders>>`	`invokeComponentCommandWithResponse(String digitalTwinId, String componentName, String commandName, String payload, DigitalTwinInvokeCommandRequestOptions options)` Invoke a command on a digital twin component.
`rx.Observable<Void>`	`updateDigitalTwin(String digitalTwinId, List<Object> digitalTwinUpdateOperations)` Updates a digital twin.
`rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Void,DigitalTwinUpdateHeaders>>`	`updateDigitalTwinWithResponse(String digitalTwinId, List<Object> digitalTwinUpdateOperations)` Updates a digital twin.
`rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Void,DigitalTwinUpdateHeaders>>`	`updateDigitalTwinWithResponse(String digitalTwinId, List<Object> digitalTwinUpdateOperations, DigitalTwinUpdateRequestOptions options)` Updates a digital twin.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- DigitalTwinAsyncClient
```
public DigitalTwinAsyncClient(String connectionString)
```
  Creates an implementation instance of DigitalTwins that is used to invoke the Digital Twin features
  
  Parameters:
  
  connectionString - The IoTHub connection string
- DigitalTwinAsyncClient
```
public DigitalTwinAsyncClient(String connectionString,
                              DigitalTwinClientOptions options)
```
  Creates an implementation instance of DigitalTwins that is used to invoke the Digital Twin features
  
  Parameters:
  
  connectionString - The IoTHub connection string
  
  options - The optional settings for this client. May not be null.
- DigitalTwinAsyncClient
```
public DigitalTwinAsyncClient(String hostName,
                              com.azure.core.credential.TokenCredential credential)
```
  Creates an implementation instance of DigitalTwins that is used to invoke the Digital Twin features
  
  Parameters:
  
  hostName - The hostname of your IoT Hub instance (For instance, "your-iot-hub.azure-devices.net")
  
  credential - The custom TokenCredential that will provide authentication tokens to this library when they are needed.
- DigitalTwinAsyncClient
```
public DigitalTwinAsyncClient(String hostName,
                              com.azure.core.credential.TokenCredential credential,
                              DigitalTwinClientOptions options)
```
  Creates an implementation instance of DigitalTwins that is used to invoke the Digital Twin features
  
  Parameters:
  
  hostName - The hostname of your IoT Hub instance (For instance, "your-iot-hub.azure-devices.net")
  
  credential - The custom TokenCredential that will provide authentication tokens to this library when they are needed.
  
  options - The optional settings for this client. May not be null.
- DigitalTwinAsyncClient
```
public DigitalTwinAsyncClient(String hostName,
                              com.azure.core.credential.AzureSasCredential azureSasCredential)
```
  Creates an implementation instance of DigitalTwins that is used to invoke the Digital Twin features
  
  Parameters:
  
  hostName - The hostname of your IoT Hub instance (For instance, "your-iot-hub.azure-devices.net")
  
  azureSasCredential - The SAS token provider that will be used for authentication.
- DigitalTwinAsyncClient
```
public DigitalTwinAsyncClient(String hostName,
                              com.azure.core.credential.AzureSasCredential azureSasCredential,
                              DigitalTwinClientOptions options)
```
  Creates an implementation instance of DigitalTwins that is used to invoke the Digital Twin features
  
  Parameters:
  
  hostName - The hostname of your IoT Hub instance (For instance, "your-iot-hub.azure-devices.net")
  
  azureSasCredential - The SAS token provider that will be used for authentication.
  
  options - The optional settings for this client. May not be null.

Method Detail

createFromConnectionString
```
public static DigitalTwinAsyncClient createFromConnectionString(String connectionString)
```
Creates an implementation instance of DigitalTwins that is used to invoke the Digital Twin features

Parameters:

connectionString - The IoTHub connection string

Returns:

The instantiated DigitalTwinAsyncClient.

getDigitalTwin
```
public <T> rx.Observable<T> getDigitalTwin(String digitalTwinId,
                                           Class<T> clazz)
```
Gets a digital twin.

Type Parameters:

T - The generic type to deserialize the application/json into.

Parameters:

digitalTwinId - The Id of the digital twin.

clazz - The class to deserialize the application/json into.

Returns:

The application/json of the digital twin.

getDigitalTwinWithResponse

public <T> rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<T,DigitalTwinGetHeaders>> getDigitalTwinWithResponse(String digitalTwinId,
                                                                                                                            Class<T> clazz)

Gets a digital twin.

Type Parameters:: T - The generic type to deserialize the application/json into.
Parameters:: digitalTwinId - The Id of the digital twin.; clazz - The class to deserialize the application/json into.
Returns:: A ServiceResponseWithHeaders representing deserialized application/json of the digital twin with DigitalTwinGetHeaders.

updateDigitalTwin
```
public rx.Observable<Void> updateDigitalTwin(String digitalTwinId,
                                             List<Object> digitalTwinUpdateOperations)
```
Updates a digital twin.

Parameters:

digitalTwinId - The Id of the digital twin.

digitalTwinUpdateOperations - The JSON patch to apply to the specified digital twin. This argument can be created using UpdateOperationUtility.

Returns:

void.

updateDigitalTwinWithResponse

public rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Void,DigitalTwinUpdateHeaders>> updateDigitalTwinWithResponse(String digitalTwinId,
                                                                                                                                 List<Object> digitalTwinUpdateOperations)

Updates a digital twin.

Parameters:: digitalTwinId - The Id of the digital twin.; digitalTwinUpdateOperations - The JSON patch to apply to the specified digital twin. This argument can be created using UpdateOperationUtility.
Returns:: A ServiceResponseWithHeaders with DigitalTwinUpdateHeaders.

updateDigitalTwinWithResponse

public rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<Void,DigitalTwinUpdateHeaders>> updateDigitalTwinWithResponse(String digitalTwinId,
                                                                                                                                 List<Object> digitalTwinUpdateOperations,
                                                                                                                                 DigitalTwinUpdateRequestOptions options)

Updates a digital twin.

Parameters:: digitalTwinId - The Id of the digital twin.; digitalTwinUpdateOperations - The JSON patch to apply to the specified digital twin. This argument can be created using UpdateOperationUtility.; options - The optional settings for this request.
Returns:: A ServiceResponseWithHeaders with DigitalTwinUpdateHeaders.

invokeCommand

public rx.Observable<DigitalTwinCommandResponse> invokeCommand(String digitalTwinId,
                                                               String commandName)

Invoke a command on a digital twin.

Parameters:: digitalTwinId - The Id of the digital twin.; commandName - The command to be invoked.
Returns:: A DigitalTwinCommandResponse which contains the application/json command invocation response.

invokeCommand

public rx.Observable<DigitalTwinCommandResponse> invokeCommand(String digitalTwinId,
                                                               String commandName,
                                                               String payload)

Invoke a command on a digital twin.

Parameters:: digitalTwinId - The Id of the digital twin.; commandName - The command to be invoked.; payload - The command payload.
Returns:: A DigitalTwinCommandResponse which contains the application/json command invocation response.

invokeCommandWithResponse

public rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<DigitalTwinCommandResponse,DigitalTwinInvokeCommandHeaders>> invokeCommandWithResponse(String digitalTwinId,
                                                                                                                                                          String commandName,
                                                                                                                                                          String payload,
                                                                                                                                                          DigitalTwinInvokeCommandRequestOptions options)

Invoke a command on a digital twin.

Parameters:: digitalTwinId - The Id of the digital twin.; commandName - The command to be invoked.; payload - The command payload.; options - The optional settings for this request.
Returns:: A ServiceResponseWithHeaders with DigitalTwinInvokeRootLevelCommandHeaders and DigitalTwinCommandResponse which contains the application/json command invocation response.

invokeComponentCommand

public rx.Observable<DigitalTwinCommandResponse> invokeComponentCommand(String digitalTwinId,
                                                                        String componentName,
                                                                        String commandName)

Invoke a command on a digital twin component.

Parameters:: digitalTwinId - The Id of the digital twin.; componentName - The component name under which the command is defined.; commandName - The command to be invoked.
Returns:: A DigitalTwinCommandResponse which contains the application/json command invocation response.

invokeComponentCommand

public rx.Observable<DigitalTwinCommandResponse> invokeComponentCommand(String digitalTwinId,
                                                                        String componentName,
                                                                        String commandName,
                                                                        String payload)

Invoke a command on a digital twin component.

Parameters:: digitalTwinId - The Id of the digital twin.; componentName - The component name under which the command is defined.; commandName - The command to be invoked.; payload - The command payload.
Returns:: A DigitalTwinCommandResponse which contains the application/json command invocation response.

invokeComponentCommandWithResponse

public rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<DigitalTwinCommandResponse,DigitalTwinInvokeCommandHeaders>> invokeComponentCommandWithResponse(String digitalTwinId,
                                                                                                                                                                   String componentName,
                                                                                                                                                                   String commandName,
                                                                                                                                                                   String payload,
                                                                                                                                                                   DigitalTwinInvokeCommandRequestOptions options)

Invoke a command on a digital twin component.

Parameters:: digitalTwinId - The Id of the digital twin.; componentName - The component name under which the command is defined.; commandName - The command to be invoked.; payload - The command payload.; options - The optional settings for this request.
Returns:: A ServiceResponseWithHeaders with DigitalTwinInvokeRootLevelCommandHeaders and DigitalTwinCommandResponse which contains the application/json command invocation response.

Class DigitalTwinAsyncClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DigitalTwinAsyncClient

DigitalTwinAsyncClient

DigitalTwinAsyncClient

DigitalTwinAsyncClient

DigitalTwinAsyncClient

DigitalTwinAsyncClient

Method Detail

createFromConnectionString

getDigitalTwin

getDigitalTwinWithResponse

updateDigitalTwin

updateDigitalTwinWithResponse

updateDigitalTwinWithResponse

invokeCommand

invokeCommand

invokeCommandWithResponse

invokeComponentCommand

invokeComponentCommand

invokeComponentCommandWithResponse