DigitalTwins Interface

Package:

com.microsoft.azure.sdk.iot.service.digitaltwin.generated

Maven Artifact:

com.microsoft.azure.sdk.iot:iot-service-client-preview:1.2.0

public interface DigitalTwins

An instance of this class provides access to all the operations defined in DigitalTwins.

Method Summary

Modifier and Type	Method and Description
abstract java.lang.Object	getDigitalTwin(String id) Gets a digital twin.
abstract rx.Observable<java.lang.Object>	getDigitalTwinAsync(String id) Gets a digital twin.
abstract com.microsoft.rest.ServiceFuture<java.lang.Object>	getDigitalTwinAsync(String id, ServiceCallback<Object> serviceCallback) Gets a digital twin.
abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<java.lang.Object,DigitalTwinGetDigitalTwinHeaders>>	getDigitalTwinWithServiceResponseAsync(String id) Gets a digital twin.
abstract java.lang.Object	invokeComponentCommand(String id, String componentPath, String commandName) Invoke a digital twin command.
abstract java.lang.Object	invokeComponentCommand(String id, String componentPath, String commandName, Object payload, Integer connectTimeoutInSeconds, Integer responseTimeoutInSeconds) Invoke a digital twin command.
abstract rx.Observable<java.lang.Object>	invokeComponentCommandAsync(String id, String componentPath, String commandName) Invoke a digital twin command.
abstract rx.Observable<java.lang.Object>	invokeComponentCommandAsync(String id, String componentPath, String commandName, Object payload, Integer connectTimeoutInSeconds, Integer responseTimeoutInSeconds) Invoke a digital twin command.
abstract com.microsoft.rest.ServiceFuture<java.lang.Object>	invokeComponentCommandAsync(String id, String componentPath, String commandName, Object payload, Integer connectTimeoutInSeconds, Integer responseTimeoutInSeconds, ServiceCallback<Object> serviceCallback) Invoke a digital twin command.
abstract com.microsoft.rest.ServiceFuture<java.lang.Object>	invokeComponentCommandAsync(String id, String componentPath, String commandName, ServiceCallback<Object> serviceCallback) Invoke a digital twin command.
abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<java.lang.Object,DigitalTwinInvokeComponentCommandHeaders>>	invokeComponentCommandWithServiceResponseAsync(String id, String componentPath, String commandName) Invoke a digital twin command.
abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<java.lang.Object,DigitalTwinInvokeComponentCommandHeaders>>	invokeComponentCommandWithServiceResponseAsync(String id, String componentPath, String commandName, Object payload, Integer connectTimeoutInSeconds, Integer responseTimeoutInSeconds) Invoke a digital twin command.
abstract java.lang.Object	invokeRootLevelCommand(String id, String commandName) Invoke a digital twin root level command.
abstract java.lang.Object	invokeRootLevelCommand(String id, String commandName, Object payload, Integer connectTimeoutInSeconds, Integer responseTimeoutInSeconds) Invoke a digital twin root level command.
abstract rx.Observable<java.lang.Object>	invokeRootLevelCommandAsync(String id, String commandName) Invoke a digital twin root level command.
abstract rx.Observable<java.lang.Object>	invokeRootLevelCommandAsync(String id, String commandName, Object payload, Integer connectTimeoutInSeconds, Integer responseTimeoutInSeconds) Invoke a digital twin root level command.
abstract com.microsoft.rest.ServiceFuture<java.lang.Object>	invokeRootLevelCommandAsync(String id, String commandName, Object payload, Integer connectTimeoutInSeconds, Integer responseTimeoutInSeconds, ServiceCallback<Object> serviceCallback) Invoke a digital twin root level command.
abstract com.microsoft.rest.ServiceFuture<java.lang.Object>	invokeRootLevelCommandAsync(String id, String commandName, ServiceCallback<Object> serviceCallback) Invoke a digital twin root level command.
abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<java.lang.Object,DigitalTwinInvokeRootLevelCommandHeaders>>	invokeRootLevelCommandWithServiceResponseAsync(String id, String commandName) Invoke a digital twin root level command.
abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<java.lang.Object,DigitalTwinInvokeRootLevelCommandHeaders>>	invokeRootLevelCommandWithServiceResponseAsync(String id, String commandName, Object payload, Integer connectTimeoutInSeconds, Integer responseTimeoutInSeconds) Invoke a digital twin root level command.
abstract void	updateDigitalTwin(String id, List<Object> digitalTwinPatch) Updates a digital twin.
abstract void	updateDigitalTwin(String id, List<Object> digitalTwinPatch, String ifMatch) Updates a digital twin.
abstract rx.Observable<java.lang.Void>	updateDigitalTwinAsync(String id, List<Object> digitalTwinPatch) Updates a digital twin.
abstract com.microsoft.rest.ServiceFuture<java.lang.Void>	updateDigitalTwinAsync(String id, List<Object> digitalTwinPatch, ServiceCallback<Void> serviceCallback) Updates a digital twin.
abstract rx.Observable<java.lang.Void>	updateDigitalTwinAsync(String id, List<Object> digitalTwinPatch, String ifMatch) Updates a digital twin.
abstract com.microsoft.rest.ServiceFuture<java.lang.Void>	updateDigitalTwinAsync(String id, List<Object> digitalTwinPatch, String ifMatch, ServiceCallback<Void> serviceCallback) Updates a digital twin.
abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<java.lang.Void,DigitalTwinUpdateDigitalTwinHeaders>>	updateDigitalTwinWithServiceResponseAsync(String id, List<Object> digitalTwinPatch) Updates a digital twin.
abstract rx.Observable<com.microsoft.rest.ServiceResponseWithHeaders<java.lang.Void,DigitalTwinUpdateDigitalTwinHeaders>>	updateDigitalTwinWithServiceResponseAsync(String id, List<Object> digitalTwinPatch, String ifMatch) Updates a digital twin.

Method Details

getDigitalTwin

public abstract Object getDigitalTwin(String id)

Gets a digital twin.

Parameters:

id - Digital Twin ID.

Returns:

the Object object if successful.

getDigitalTwinAsync

public abstract Observable<Object> getDigitalTwinAsync(String id)

Gets a digital twin.

Parameters:

id - Digital Twin ID.

Returns:

the observable to the Object object

getDigitalTwinAsync

public abstract ServiceFuture<Object> getDigitalTwinAsync(String id, ServiceCallback<Object> serviceCallback)

Gets a digital twin.

Parameters:

id - Digital Twin ID.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

getDigitalTwinWithServiceResponseAsync

public abstract Observable<ServiceResponseWithHeaders<Object,DigitalTwinGetDigitalTwinHeaders>> getDigitalTwinWithServiceResponseAsync(String id)

Gets a digital twin.

Parameters:

id - Digital Twin ID.

Returns:

the observable to the Object object

invokeComponentCommand

public abstract Object invokeComponentCommand(String id, String componentPath, String commandName)

Invoke a digital twin command.

Parameters:

id - the String value

componentPath - the String value

commandName - the String value

Returns:

the Object object if successful.

invokeComponentCommand

public abstract Object invokeComponentCommand(String id, String componentPath, String commandName, Object payload, Integer connectTimeoutInSeconds, Integer responseTimeoutInSeconds)

Invoke a digital twin command.

Parameters:

id - the String value

componentPath - the String value

commandName - the String value

payload - the Object value

connectTimeoutInSeconds - Maximum interval of time, in seconds, that the digital twin command will wait for the answer.

responseTimeoutInSeconds - Maximum interval of time, in seconds, that the digital twin command will wait for the answer.

Returns:

the Object object if successful.

invokeComponentCommandAsync

public abstract Observable<Object> invokeComponentCommandAsync(String id, String componentPath, String commandName)

Invoke a digital twin command.

Parameters:

id - the String value

componentPath - the String value

commandName - the String value

Returns:

the observable to the Object object

invokeComponentCommandAsync

public abstract Observable<Object> invokeComponentCommandAsync(String id, String componentPath, String commandName, Object payload, Integer connectTimeoutInSeconds, Integer responseTimeoutInSeconds)

Invoke a digital twin command.

Parameters:

id - the String value

componentPath - the String value

commandName - the String value

payload - the Object value

connectTimeoutInSeconds - Maximum interval of time, in seconds, that the digital twin command will wait for the answer.

responseTimeoutInSeconds - Maximum interval of time, in seconds, that the digital twin command will wait for the answer.

Returns:

the observable to the Object object

invokeComponentCommandAsync

public abstract ServiceFuture<Object> invokeComponentCommandAsync(String id, String componentPath, String commandName, Object payload, Integer connectTimeoutInSeconds, Integer responseTimeoutInSeconds, ServiceCallback<Object> serviceCallback)

Invoke a digital twin command.

Parameters:

id - the String value

componentPath - the String value

commandName - the String value

payload - the Object value

connectTimeoutInSeconds - Maximum interval of time, in seconds, that the digital twin command will wait for the answer.

responseTimeoutInSeconds - Maximum interval of time, in seconds, that the digital twin command will wait for the answer.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

invokeComponentCommandAsync

public abstract ServiceFuture<Object> invokeComponentCommandAsync(String id, String componentPath, String commandName, ServiceCallback<Object> serviceCallback)

Invoke a digital twin command.

Parameters:

id - the String value

componentPath - the String value

commandName - the String value

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

invokeComponentCommandWithServiceResponseAsync

public abstract Observable<ServiceResponseWithHeaders<Object,DigitalTwinInvokeComponentCommandHeaders>> invokeComponentCommandWithServiceResponseAsync(String id, String componentPath, String commandName)

Invoke a digital twin command.

Parameters:

id - the String value

componentPath - the String value

commandName - the String value

Returns:

the observable to the Object object

invokeComponentCommandWithServiceResponseAsync

public abstract Observable<ServiceResponseWithHeaders<Object,DigitalTwinInvokeComponentCommandHeaders>> invokeComponentCommandWithServiceResponseAsync(String id, String componentPath, String commandName, Object payload, Integer connectTimeoutInSeconds, Integer responseTimeoutInSeconds)

Invoke a digital twin command.

Parameters:

id - the String value

componentPath - the String value

commandName - the String value

payload - the Object value

connectTimeoutInSeconds - Maximum interval of time, in seconds, that the digital twin command will wait for the answer.

responseTimeoutInSeconds - Maximum interval of time, in seconds, that the digital twin command will wait for the answer.

Returns:

the observable to the Object object

invokeRootLevelCommand

public abstract Object invokeRootLevelCommand(String id, String commandName)

Invoke a digital twin root level command.

Parameters:

id - the String value

commandName - the String value

Returns:

the Object object if successful.

invokeRootLevelCommand

public abstract Object invokeRootLevelCommand(String id, String commandName, Object payload, Integer connectTimeoutInSeconds, Integer responseTimeoutInSeconds)

Invoke a digital twin root level command.

Parameters:

id - the String value

commandName - the String value

payload - the Object value

connectTimeoutInSeconds - Maximum interval of time, in seconds, that the digital twin command will wait for the answer.

responseTimeoutInSeconds - Maximum interval of time, in seconds, that the digital twin command will wait for the answer.

Returns:

the Object object if successful.

invokeRootLevelCommandAsync

public abstract Observable<Object> invokeRootLevelCommandAsync(String id, String commandName)

Invoke a digital twin root level command.

Parameters:

id - the String value

commandName - the String value

Returns:

the observable to the Object object

invokeRootLevelCommandAsync

public abstract Observable<Object> invokeRootLevelCommandAsync(String id, String commandName, Object payload, Integer connectTimeoutInSeconds, Integer responseTimeoutInSeconds)

Invoke a digital twin root level command.

Parameters:

id - the String value

commandName - the String value

payload - the Object value

connectTimeoutInSeconds - Maximum interval of time, in seconds, that the digital twin command will wait for the answer.

responseTimeoutInSeconds - Maximum interval of time, in seconds, that the digital twin command will wait for the answer.

Returns:

the observable to the Object object

invokeRootLevelCommandAsync

public abstract ServiceFuture<Object> invokeRootLevelCommandAsync(String id, String commandName, Object payload, Integer connectTimeoutInSeconds, Integer responseTimeoutInSeconds, ServiceCallback<Object> serviceCallback)

Invoke a digital twin root level command.

Parameters:

id - the String value

commandName - the String value

payload - the Object value

connectTimeoutInSeconds - Maximum interval of time, in seconds, that the digital twin command will wait for the answer.

responseTimeoutInSeconds - Maximum interval of time, in seconds, that the digital twin command will wait for the answer.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

invokeRootLevelCommandAsync

public abstract ServiceFuture<Object> invokeRootLevelCommandAsync(String id, String commandName, ServiceCallback<Object> serviceCallback)

Invoke a digital twin root level command.

Parameters:

id - the String value

commandName - the String value

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

invokeRootLevelCommandWithServiceResponseAsync

public abstract Observable<ServiceResponseWithHeaders<Object,DigitalTwinInvokeRootLevelCommandHeaders>> invokeRootLevelCommandWithServiceResponseAsync(String id, String commandName)

Invoke a digital twin root level command.

Parameters:

id - the String value

commandName - the String value

Returns:

the observable to the Object object

invokeRootLevelCommandWithServiceResponseAsync

public abstract Observable<ServiceResponseWithHeaders<Object,DigitalTwinInvokeRootLevelCommandHeaders>> invokeRootLevelCommandWithServiceResponseAsync(String id, String commandName, Object payload, Integer connectTimeoutInSeconds, Integer responseTimeoutInSeconds)

Invoke a digital twin root level command.

Parameters:

id - the String value

commandName - the String value

payload - the Object value

connectTimeoutInSeconds - Maximum interval of time, in seconds, that the digital twin command will wait for the answer.

responseTimeoutInSeconds - Maximum interval of time, in seconds, that the digital twin command will wait for the answer.

Returns:

the observable to the Object object

updateDigitalTwin

public abstract void updateDigitalTwin(String id, List<Object> digitalTwinPatch)

Updates a digital twin.

Parameters:

id - Digital Twin ID.

digitalTwinPatch - json-patch contents to update.

updateDigitalTwin

public abstract void updateDigitalTwin(String id, List<Object> digitalTwinPatch, String ifMatch)

Updates a digital twin.

Parameters:

id - Digital Twin ID.

digitalTwinPatch - json-patch contents to update.

ifMatch - the String value

updateDigitalTwinAsync

public abstract Observable<Void> updateDigitalTwinAsync(String id, List<Object> digitalTwinPatch)

Updates a digital twin.

Parameters:

id - Digital Twin ID.

digitalTwinPatch - json-patch contents to update.

Returns:

the ServiceResponseWithHeaders object if successful.

updateDigitalTwinAsync

public abstract ServiceFuture<Void> updateDigitalTwinAsync(String id, List<Object> digitalTwinPatch, ServiceCallback<Void> serviceCallback)

Updates a digital twin.

Parameters:

id - Digital Twin ID.

digitalTwinPatch - json-patch contents to update.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

updateDigitalTwinAsync

public abstract Observable<Void> updateDigitalTwinAsync(String id, List<Object> digitalTwinPatch, String ifMatch)

Updates a digital twin.

Parameters:

id - Digital Twin ID.

digitalTwinPatch - json-patch contents to update.

ifMatch - the String value

Returns:

the ServiceResponseWithHeaders object if successful.

updateDigitalTwinAsync

public abstract ServiceFuture<Void> updateDigitalTwinAsync(String id, List<Object> digitalTwinPatch, String ifMatch, ServiceCallback<Void> serviceCallback)

Updates a digital twin.

Parameters:

id - Digital Twin ID.

digitalTwinPatch - json-patch contents to update.

ifMatch - the String value

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

updateDigitalTwinWithServiceResponseAsync

public abstract Observable<ServiceResponseWithHeaders<Void,DigitalTwinUpdateDigitalTwinHeaders>> updateDigitalTwinWithServiceResponseAsync(String id, List<Object> digitalTwinPatch)

Updates a digital twin.

Parameters:

id - Digital Twin ID.

digitalTwinPatch - json-patch contents to update.

Returns:

the ServiceResponseWithHeaders object if successful.

updateDigitalTwinWithServiceResponseAsync

public abstract Observable<ServiceResponseWithHeaders<Void,DigitalTwinUpdateDigitalTwinHeaders>> updateDigitalTwinWithServiceResponseAsync(String id, List<Object> digitalTwinPatch, String ifMatch)

Updates a digital twin.

Parameters:

id - Digital Twin ID.

digitalTwinPatch - json-patch contents to update.

ifMatch - the String value

Returns:

the ServiceResponseWithHeaders object if successful.