81 строка
5.8 KiB
YAML
81 строка
5.8 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.sdk.iot.device.edge.MethodRequest"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.edge.MethodRequest"
|
|
name: "MethodRequest"
|
|
nameWithType: "MethodRequest"
|
|
summary: "Json parser for a method request."
|
|
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 **MethodRequest**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.sdk.iot.device.edge.MethodRequest.MethodRequest(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.edge.MethodRequest.MethodRequest(String methodName, String payload)"
|
|
name: "MethodRequest(String methodName, String payload)"
|
|
nameWithType: "MethodRequest.MethodRequest(String methodName, String payload)"
|
|
summary: "Constructor for a Method<wbr>Request."
|
|
parameters:
|
|
- description: "The method to be invoked"
|
|
name: "methodName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the payload attached to that method"
|
|
name: "payload"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MethodRequest(String methodName, String payload)"
|
|
exceptions:
|
|
- description: "if the provided methodName is null or empty"
|
|
type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Constructor for a MethodRequest. Uses default responseTimeout and connectionTimeout which is to never timeout"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.edge.MethodRequest.MethodRequest(java.lang.String,java.lang.String,java.lang.Integer,java.lang.Integer)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.edge.MethodRequest.MethodRequest(String methodName, String payload, Integer responseTimeout, Integer connectionTimeout)"
|
|
name: "MethodRequest(String methodName, String payload, Integer responseTimeout, Integer connectionTimeout)"
|
|
nameWithType: "MethodRequest.MethodRequest(String methodName, String payload, Integer responseTimeout, Integer connectionTimeout)"
|
|
summary: "Constructor for a Method<wbr>Request."
|
|
parameters:
|
|
- description: "The method to be invoked"
|
|
name: "methodName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the payload attached to that method"
|
|
name: "payload"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the timeout in seconds for the response to be received"
|
|
name: "responseTimeout"
|
|
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the timeout in seconds for the connection to be established"
|
|
name: "connectionTimeout"
|
|
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MethodRequest(String methodName, String payload, Integer responseTimeout, Integer connectionTimeout)"
|
|
exceptions:
|
|
- description: "if the provided methodName is null or empty"
|
|
type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Constructor for a MethodRequest."
|
|
methods:
|
|
- uid: "com.microsoft.azure.sdk.iot.device.edge.MethodRequest.toJson()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.edge.MethodRequest.toJson()"
|
|
name: "toJson()"
|
|
nameWithType: "MethodRequest.toJson()"
|
|
summary: "Return the json representation of this object"
|
|
syntax: "public String toJson()"
|
|
desc: "Return the json representation of this object"
|
|
returns:
|
|
description: "the json representation of this object"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Json parser for a method request. Used to invoke methods on other devices/modules"
|
|
metadata: {}
|
|
package: "com.microsoft.azure.sdk.iot.device.edge"
|
|
artifact: com.microsoft.azure.sdk.iot:iot-device-client:1.30.1
|