369 строки
40 KiB
YAML
369 строки
40 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient"
|
|
name: "DigitalTwinClient"
|
|
nameWithType: "DigitalTwinClient"
|
|
summary: "The Digital Twins Service Client contains methods to retrieve and update digital twin information, and invoke commands on a digital twin device."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public class **DigitalTwinClient**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.DigitalTwinClient(java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.DigitalTwinClient(String connectionString)"
|
|
name: "DigitalTwinClient(String connectionString)"
|
|
nameWithType: "DigitalTwinClient.DigitalTwinClient(String connectionString)"
|
|
summary: "Creates an implementation instance of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwins\"></xref> that is used to invoke the Digital Twin features"
|
|
parameters:
|
|
- description: "The IoT Hub connection string"
|
|
name: "connectionString"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DigitalTwinClient(String connectionString)"
|
|
desc: "Creates an implementation instance of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwins\"></xref> that is used to invoke the Digital Twin features"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.DigitalTwinClient(java.lang.String,com.azure.core.credential.AzureSasCredential)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.DigitalTwinClient(String hostName, AzureSasCredential azureSasCredential)"
|
|
name: "DigitalTwinClient(String hostName, AzureSasCredential azureSasCredential)"
|
|
nameWithType: "DigitalTwinClient.DigitalTwinClient(String hostName, AzureSasCredential azureSasCredential)"
|
|
summary: "Creates an implementation instance of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwins\"></xref> that is used to invoke the Digital Twin features"
|
|
parameters:
|
|
- description: "The hostname of your IoT Hub instance (For instance, \"your-iot-hub.azure-devices.net\")"
|
|
name: "hostName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The SAS token provider that will be used for authentication."
|
|
name: "azureSasCredential"
|
|
type: "<xref href=\"com.azure.core.credential.AzureSasCredential?alt=com.azure.core.credential.AzureSasCredential&text=AzureSasCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DigitalTwinClient(String hostName, AzureSasCredential azureSasCredential)"
|
|
desc: "Creates an implementation instance of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwins\"></xref> that is used to invoke the Digital Twin features"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.DigitalTwinClient(java.lang.String,com.azure.core.credential.AzureSasCredential,com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClientOptions)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.DigitalTwinClient(String hostName, AzureSasCredential azureSasCredential, DigitalTwinClientOptions options)"
|
|
name: "DigitalTwinClient(String hostName, AzureSasCredential azureSasCredential, DigitalTwinClientOptions options)"
|
|
nameWithType: "DigitalTwinClient.DigitalTwinClient(String hostName, AzureSasCredential azureSasCredential, DigitalTwinClientOptions options)"
|
|
summary: "Creates an implementation instance of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwins\"></xref> that is used to invoke the Digital Twin features"
|
|
parameters:
|
|
- description: "The hostname of your IoT Hub instance (For instance, \"your-iot-hub.azure-devices.net\")"
|
|
name: "hostName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The SAS token provider that will be used for authentication."
|
|
name: "azureSasCredential"
|
|
type: "<xref href=\"com.azure.core.credential.AzureSasCredential?alt=com.azure.core.credential.AzureSasCredential&text=AzureSasCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The optional settings for this client. May not be null."
|
|
name: "options"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClientOptions?alt=com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClientOptions&text=DigitalTwinClientOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DigitalTwinClient(String hostName, AzureSasCredential azureSasCredential, DigitalTwinClientOptions options)"
|
|
desc: "Creates an implementation instance of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwins\"></xref> that is used to invoke the Digital Twin features"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.DigitalTwinClient(java.lang.String,com.azure.core.credential.TokenCredential)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.DigitalTwinClient(String hostName, TokenCredential credential)"
|
|
name: "DigitalTwinClient(String hostName, TokenCredential credential)"
|
|
nameWithType: "DigitalTwinClient.DigitalTwinClient(String hostName, TokenCredential credential)"
|
|
summary: "Creates an implementation instance of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwins\"></xref> that is used to invoke the Digital Twin features"
|
|
parameters:
|
|
- description: "The hostname of your IoT Hub instance (For instance, \"your-iot-hub.azure-devices.net\")"
|
|
name: "hostName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The custom <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> that will provide authentication tokens to\n this library when they are needed."
|
|
name: "credential"
|
|
type: "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DigitalTwinClient(String hostName, TokenCredential credential)"
|
|
desc: "Creates an implementation instance of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwins\"></xref> that is used to invoke the Digital Twin features"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.DigitalTwinClient(java.lang.String,com.azure.core.credential.TokenCredential,com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClientOptions)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.DigitalTwinClient(String hostName, TokenCredential credential, DigitalTwinClientOptions options)"
|
|
name: "DigitalTwinClient(String hostName, TokenCredential credential, DigitalTwinClientOptions options)"
|
|
nameWithType: "DigitalTwinClient.DigitalTwinClient(String hostName, TokenCredential credential, DigitalTwinClientOptions options)"
|
|
summary: "Creates an implementation instance of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwins\"></xref> that is used to invoke the Digital Twin features"
|
|
parameters:
|
|
- description: "The hostname of your IoT Hub instance (For instance, \"your-iot-hub.azure-devices.net\")"
|
|
name: "hostName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The custom <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> that will provide authentication tokens to\n this library when they are needed."
|
|
name: "credential"
|
|
type: "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The optional settings for this client. May not be null."
|
|
name: "options"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClientOptions?alt=com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClientOptions&text=DigitalTwinClientOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DigitalTwinClient(String hostName, TokenCredential credential, DigitalTwinClientOptions options)"
|
|
desc: "Creates an implementation instance of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwins\"></xref> that is used to invoke the Digital Twin features"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.DigitalTwinClient(java.lang.String,com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClientOptions)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.DigitalTwinClient(String connectionString, DigitalTwinClientOptions options)"
|
|
name: "DigitalTwinClient(String connectionString, DigitalTwinClientOptions options)"
|
|
nameWithType: "DigitalTwinClient.DigitalTwinClient(String connectionString, DigitalTwinClientOptions options)"
|
|
summary: "Creates an implementation instance of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwins\"></xref> that is used to invoke the Digital Twin features"
|
|
parameters:
|
|
- description: "The IoT Hub connection string"
|
|
name: "connectionString"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The optional settings for this client. May not be null."
|
|
name: "options"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClientOptions?alt=com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClientOptions&text=DigitalTwinClientOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DigitalTwinClient(String connectionString, DigitalTwinClientOptions options)"
|
|
desc: "Creates an implementation instance of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwins\"></xref> that is used to invoke the Digital Twin features"
|
|
methods:
|
|
- uid: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.<T>getDigitalTwin(java.lang.String,java.lang.Class<T>)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.getDigitalTwin(String digitalTwinId, Class<T> clazz)"
|
|
name: "getDigitalTwin(String digitalTwinId, Class<T> clazz)"
|
|
nameWithType: "DigitalTwinClient.getDigitalTwin(String digitalTwinId, Class<T> clazz)"
|
|
summary: "Gets a digital twin."
|
|
parameters:
|
|
- description: "The Id of the digital twin."
|
|
name: "digitalTwinId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The class to deserialize the application/json into."
|
|
name: "clazz"
|
|
type: "<xref href=\"java.lang.Class?alt=java.lang.Class&text=Class\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public T <T>getDigitalTwin(String digitalTwinId, Class<T> clazz)"
|
|
desc: "Gets a digital twin."
|
|
returns:
|
|
description: "The application/json of the digital twin."
|
|
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.<T>getDigitalTwinWithResponse(java.lang.String,java.lang.Class<T>)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.getDigitalTwinWithResponse(String digitalTwinId, Class<T> clazz)"
|
|
name: "getDigitalTwinWithResponse(String digitalTwinId, Class<T> clazz)"
|
|
nameWithType: "DigitalTwinClient.getDigitalTwinWithResponse(String digitalTwinId, Class<T> clazz)"
|
|
summary: "Gets a digital twin."
|
|
parameters:
|
|
- description: "The Id of the digital twin."
|
|
name: "digitalTwinId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The class to deserialize the application/json into."
|
|
name: "clazz"
|
|
type: "<xref href=\"java.lang.Class?alt=java.lang.Class&text=Class\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public ServiceResponseWithHeaders<T,DigitalTwinGetHeaders> <T>getDigitalTwinWithResponse(String digitalTwinId, Class<T> clazz)"
|
|
desc: "Gets a digital twin."
|
|
returns:
|
|
description: "A <xref uid=\"com.microsoft.rest.ServiceResponseWithHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceResponseWithHeaders\"></xref> representing deserialized application/json of the digital twin with <xref uid=\"com.microsoft.azure.sdk.iot.service.digitaltwin.customized.DigitalTwinGetHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinGetHeaders\"></xref>."
|
|
type: "<xref href=\"com.microsoft.rest.ServiceResponseWithHeaders?alt=com.microsoft.rest.ServiceResponseWithHeaders&text=ServiceResponseWithHeaders\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.microsoft.azure.sdk.iot.service.digitaltwin.customized.DigitalTwinGetHeaders?alt=com.microsoft.azure.sdk.iot.service.digitaltwin.customized.DigitalTwinGetHeaders&text=DigitalTwinGetHeaders\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.createFromConnectionString(java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.createFromConnectionString(String connectionString)"
|
|
name: "createFromConnectionString(String connectionString)"
|
|
nameWithType: "DigitalTwinClient.createFromConnectionString(String connectionString)"
|
|
summary: "Creates an implementation instance of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwins\"></xref> that is used to invoke the Digital Twin features"
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The IoT Hub connection string"
|
|
name: "connectionString"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static DigitalTwinClient createFromConnectionString(String connectionString)"
|
|
desc: "Creates an implementation instance of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwins\"></xref> that is used to invoke the Digital Twin features"
|
|
returns:
|
|
description: "The instantiated DigitalTwinClient."
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient?alt=com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient&text=DigitalTwinClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.invokeCommand(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.invokeCommand(String digitalTwinId, String commandName)"
|
|
name: "invokeCommand(String digitalTwinId, String commandName)"
|
|
nameWithType: "DigitalTwinClient.invokeCommand(String digitalTwinId, String commandName)"
|
|
summary: "Invoke a command on a digital twin."
|
|
parameters:
|
|
- description: "The Id of the digital twin."
|
|
name: "digitalTwinId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The command to be invoked."
|
|
name: "commandName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DigitalTwinCommandResponse invokeCommand(String digitalTwinId, String commandName)"
|
|
exceptions:
|
|
- description: "can be thrown if the provided payload cannot be deserialized into a valid Json object."
|
|
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Invoke a command on a digital twin."
|
|
returns:
|
|
description: "A <xref uid=\"com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinCommandResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinCommandResponse\"></xref> which contains the application/json command invocation response."
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinCommandResponse?alt=com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinCommandResponse&text=DigitalTwinCommandResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.invokeCommand(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.invokeCommand(String digitalTwinId, String commandName, String payload)"
|
|
name: "invokeCommand(String digitalTwinId, String commandName, String payload)"
|
|
nameWithType: "DigitalTwinClient.invokeCommand(String digitalTwinId, String commandName, String payload)"
|
|
summary: "Invoke a command on a digital twin."
|
|
parameters:
|
|
- description: "The Id of the digital twin."
|
|
name: "digitalTwinId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The command to be invoked."
|
|
name: "commandName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The command payload."
|
|
name: "payload"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DigitalTwinCommandResponse invokeCommand(String digitalTwinId, String commandName, String payload)"
|
|
exceptions:
|
|
- description: "can be thrown if the provided payload cannot be deserialized into a valid Json object."
|
|
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Invoke a command on a digital twin."
|
|
returns:
|
|
description: "A <xref uid=\"com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinCommandResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinCommandResponse\"></xref> which contains the application/json command invocation response."
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinCommandResponse?alt=com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinCommandResponse&text=DigitalTwinCommandResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.invokeCommandWithResponse(java.lang.String,java.lang.String,java.lang.String,com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinInvokeCommandRequestOptions)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.invokeCommandWithResponse(String digitalTwinId, String commandName, String payload, DigitalTwinInvokeCommandRequestOptions options)"
|
|
name: "invokeCommandWithResponse(String digitalTwinId, String commandName, String payload, DigitalTwinInvokeCommandRequestOptions options)"
|
|
nameWithType: "DigitalTwinClient.invokeCommandWithResponse(String digitalTwinId, String commandName, String payload, DigitalTwinInvokeCommandRequestOptions options)"
|
|
summary: "Invoke a command on a digital twin."
|
|
parameters:
|
|
- description: "The Id of the digital twin."
|
|
name: "digitalTwinId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The command to be invoked."
|
|
name: "commandName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The command payload."
|
|
name: "payload"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The optional settings for this request."
|
|
name: "options"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinInvokeCommandRequestOptions?alt=com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinInvokeCommandRequestOptions&text=DigitalTwinInvokeCommandRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ServiceResponseWithHeaders<DigitalTwinCommandResponse,DigitalTwinInvokeCommandHeaders> invokeCommandWithResponse(String digitalTwinId, String commandName, String payload, DigitalTwinInvokeCommandRequestOptions options)"
|
|
exceptions:
|
|
- description: "can be thrown if the provided payload cannot be deserialized into a valid Json object."
|
|
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Invoke a command on a digital twin."
|
|
returns:
|
|
description: "A <xref uid=\"com.microsoft.rest.ServiceResponseWithHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceResponseWithHeaders\"></xref> with <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinInvokeRootLevelCommandHeaders\"></xref> and <xref uid=\"com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinCommandResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinCommandResponse\"></xref> which contains the application/json command invocation response."
|
|
type: "<xref href=\"com.microsoft.rest.ServiceResponseWithHeaders?alt=com.microsoft.rest.ServiceResponseWithHeaders&text=ServiceResponseWithHeaders\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinCommandResponse?alt=com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinCommandResponse&text=DigitalTwinCommandResponse\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinInvokeCommandHeaders?alt=com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinInvokeCommandHeaders&text=DigitalTwinInvokeCommandHeaders\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.invokeComponentCommand(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.invokeComponentCommand(String digitalTwinId, String componentName, String commandName)"
|
|
name: "invokeComponentCommand(String digitalTwinId, String componentName, String commandName)"
|
|
nameWithType: "DigitalTwinClient.invokeComponentCommand(String digitalTwinId, String componentName, String commandName)"
|
|
summary: "Invoke a command on a digital twin component."
|
|
parameters:
|
|
- description: "The Id of the digital twin."
|
|
name: "digitalTwinId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The component name under which the command is defined."
|
|
name: "componentName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The command to be invoked."
|
|
name: "commandName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DigitalTwinCommandResponse invokeComponentCommand(String digitalTwinId, String componentName, String commandName)"
|
|
exceptions:
|
|
- description: "can be thrown if the provided payload cannot be deserialized into a valid Json object."
|
|
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Invoke a command on a digital twin component."
|
|
returns:
|
|
description: "A <xref uid=\"com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinCommandResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinCommandResponse\"></xref> which contains the application/json command invocation response."
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinCommandResponse?alt=com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinCommandResponse&text=DigitalTwinCommandResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.invokeComponentCommand(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.invokeComponentCommand(String digitalTwinId, String componentName, String commandName, String payload)"
|
|
name: "invokeComponentCommand(String digitalTwinId, String componentName, String commandName, String payload)"
|
|
nameWithType: "DigitalTwinClient.invokeComponentCommand(String digitalTwinId, String componentName, String commandName, String payload)"
|
|
summary: "Invoke a command on a digital twin component."
|
|
parameters:
|
|
- description: "The Id of the digital twin."
|
|
name: "digitalTwinId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The component name under which the command is defined."
|
|
name: "componentName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The command to be invoked."
|
|
name: "commandName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The command payload."
|
|
name: "payload"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DigitalTwinCommandResponse invokeComponentCommand(String digitalTwinId, String componentName, String commandName, String payload)"
|
|
exceptions:
|
|
- description: "can be thrown if the provided payload cannot be deserialized into a valid Json object."
|
|
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Invoke a command on a digital twin component."
|
|
returns:
|
|
description: "A <xref uid=\"com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinCommandResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinCommandResponse\"></xref> which contains the application/json command invocation response."
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinCommandResponse?alt=com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinCommandResponse&text=DigitalTwinCommandResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.invokeComponentCommandWithResponse(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinInvokeCommandRequestOptions)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.invokeComponentCommandWithResponse(String digitalTwinId, String componentName, String commandName, String payload, DigitalTwinInvokeCommandRequestOptions options)"
|
|
name: "invokeComponentCommandWithResponse(String digitalTwinId, String componentName, String commandName, String payload, DigitalTwinInvokeCommandRequestOptions options)"
|
|
nameWithType: "DigitalTwinClient.invokeComponentCommandWithResponse(String digitalTwinId, String componentName, String commandName, String payload, DigitalTwinInvokeCommandRequestOptions options)"
|
|
summary: "Invoke a command on a digital twin component."
|
|
parameters:
|
|
- description: "The Id of the digital twin."
|
|
name: "digitalTwinId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The component name under which the command is defined."
|
|
name: "componentName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The command to be invoked."
|
|
name: "commandName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The command payload."
|
|
name: "payload"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The optional settings for this request."
|
|
name: "options"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinInvokeCommandRequestOptions?alt=com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinInvokeCommandRequestOptions&text=DigitalTwinInvokeCommandRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ServiceResponseWithHeaders<DigitalTwinCommandResponse,DigitalTwinInvokeCommandHeaders> invokeComponentCommandWithResponse(String digitalTwinId, String componentName, String commandName, String payload, DigitalTwinInvokeCommandRequestOptions options)"
|
|
exceptions:
|
|
- description: "can be thrown if the provided payload cannot be deserialized into a valid Json object."
|
|
type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Invoke a command on a digital twin component."
|
|
returns:
|
|
description: "A <xref uid=\"com.microsoft.rest.ServiceResponseWithHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceResponseWithHeaders\"></xref> with <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinInvokeRootLevelCommandHeaders\"></xref> and <xref uid=\"com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinCommandResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinCommandResponse\"></xref> which contains the application/json command invocation response."
|
|
type: "<xref href=\"com.microsoft.rest.ServiceResponseWithHeaders?alt=com.microsoft.rest.ServiceResponseWithHeaders&text=ServiceResponseWithHeaders\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinCommandResponse?alt=com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinCommandResponse&text=DigitalTwinCommandResponse\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinInvokeCommandHeaders?alt=com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinInvokeCommandHeaders&text=DigitalTwinInvokeCommandHeaders\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.updateDigitalTwin(java.lang.String,java.util.List<java.lang.Object>)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.updateDigitalTwin(String digitalTwinId, List<Object> digitalTwinUpdateOperations)"
|
|
name: "updateDigitalTwin(String digitalTwinId, List<Object> digitalTwinUpdateOperations)"
|
|
nameWithType: "DigitalTwinClient.updateDigitalTwin(String digitalTwinId, List<Object> digitalTwinUpdateOperations)"
|
|
summary: "Updates a digital twin."
|
|
parameters:
|
|
- description: "The Id of the digital twin."
|
|
name: "digitalTwinId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The JSON patch to apply to the specified digital twin. This argument can be created using <xref uid=\"com.microsoft.azure.sdk.iot.service.digitaltwin.UpdateOperationUtility\" data-throw-if-not-resolved=\"false\" data-raw-source=\"UpdateOperationUtility\"></xref>."
|
|
name: "digitalTwinUpdateOperations"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public Void updateDigitalTwin(String digitalTwinId, List<Object> digitalTwinUpdateOperations)"
|
|
desc: "Updates a digital twin."
|
|
returns:
|
|
description: "void."
|
|
type: "<xref href=\"java.lang.Void?alt=java.lang.Void&text=Void\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.updateDigitalTwinWithResponse(java.lang.String,java.util.List<java.lang.Object>)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.updateDigitalTwinWithResponse(String digitalTwinId, List<Object> digitalTwinUpdateOperations)"
|
|
name: "updateDigitalTwinWithResponse(String digitalTwinId, List<Object> digitalTwinUpdateOperations)"
|
|
nameWithType: "DigitalTwinClient.updateDigitalTwinWithResponse(String digitalTwinId, List<Object> digitalTwinUpdateOperations)"
|
|
summary: "Updates a digital twin."
|
|
parameters:
|
|
- description: "The Id of the digital twin."
|
|
name: "digitalTwinId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The JSON patch to apply to the specified digital twin. This argument can be created using <xref uid=\"com.microsoft.azure.sdk.iot.service.digitaltwin.UpdateOperationUtility\" data-throw-if-not-resolved=\"false\" data-raw-source=\"UpdateOperationUtility\"></xref>."
|
|
name: "digitalTwinUpdateOperations"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public ServiceResponseWithHeaders<Void,DigitalTwinUpdateHeaders> updateDigitalTwinWithResponse(String digitalTwinId, List<Object> digitalTwinUpdateOperations)"
|
|
desc: "Updates a digital twin."
|
|
returns:
|
|
description: "A <xref uid=\"com.microsoft.rest.ServiceResponseWithHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceResponseWithHeaders\"></xref> with <xref uid=\"com.microsoft.azure.sdk.iot.service.digitaltwin.customized.DigitalTwinUpdateHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinUpdateHeaders\"></xref>."
|
|
type: "<xref href=\"com.microsoft.rest.ServiceResponseWithHeaders?alt=com.microsoft.rest.ServiceResponseWithHeaders&text=ServiceResponseWithHeaders\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.Void?alt=java.lang.Void&text=Void\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.microsoft.azure.sdk.iot.service.digitaltwin.customized.DigitalTwinUpdateHeaders?alt=com.microsoft.azure.sdk.iot.service.digitaltwin.customized.DigitalTwinUpdateHeaders&text=DigitalTwinUpdateHeaders\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.updateDigitalTwinWithResponse(java.lang.String,java.util.List<java.lang.Object>,com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinUpdateRequestOptions)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.digitaltwin.DigitalTwinClient.updateDigitalTwinWithResponse(String digitalTwinId, List<Object> digitalTwinUpdateOperations, DigitalTwinUpdateRequestOptions options)"
|
|
name: "updateDigitalTwinWithResponse(String digitalTwinId, List<Object> digitalTwinUpdateOperations, DigitalTwinUpdateRequestOptions options)"
|
|
nameWithType: "DigitalTwinClient.updateDigitalTwinWithResponse(String digitalTwinId, List<Object> digitalTwinUpdateOperations, DigitalTwinUpdateRequestOptions options)"
|
|
summary: "Updates a digital twin."
|
|
parameters:
|
|
- description: "The Id of the digital twin."
|
|
name: "digitalTwinId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The JSON patch to apply to the specified digital twin. This argument can be created using <xref uid=\"com.microsoft.azure.sdk.iot.service.digitaltwin.UpdateOperationUtility\" data-throw-if-not-resolved=\"false\" data-raw-source=\"UpdateOperationUtility\"></xref>."
|
|
name: "digitalTwinUpdateOperations"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "The optional settings for this request."
|
|
name: "options"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinUpdateRequestOptions?alt=com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinUpdateRequestOptions&text=DigitalTwinUpdateRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ServiceResponseWithHeaders<Void,DigitalTwinUpdateHeaders> updateDigitalTwinWithResponse(String digitalTwinId, List<Object> digitalTwinUpdateOperations, DigitalTwinUpdateRequestOptions options)"
|
|
desc: "Updates a digital twin."
|
|
returns:
|
|
description: "A <xref uid=\"com.microsoft.rest.ServiceResponseWithHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceResponseWithHeaders\"></xref> with <xref uid=\"com.microsoft.azure.sdk.iot.service.digitaltwin.customized.DigitalTwinUpdateHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DigitalTwinUpdateHeaders\"></xref>."
|
|
type: "<xref href=\"com.microsoft.rest.ServiceResponseWithHeaders?alt=com.microsoft.rest.ServiceResponseWithHeaders&text=ServiceResponseWithHeaders\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.Void?alt=java.lang.Void&text=Void\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.microsoft.azure.sdk.iot.service.digitaltwin.customized.DigitalTwinUpdateHeaders?alt=com.microsoft.azure.sdk.iot.service.digitaltwin.customized.DigitalTwinUpdateHeaders&text=DigitalTwinUpdateHeaders\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "class"
|
|
desc: "The Digital Twins Service Client contains methods to retrieve and update digital twin information, and invoke commands on a digital twin device."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.sdk.iot.service.digitaltwin"
|
|
artifact: com.microsoft.azure.sdk.iot:iot-service-client:1.30.0
|