com.microsoft.azure.sdk.iot.device.edge

Class DirectMethodRequest

java.lang.Object

com.microsoft.azure.sdk.iot.device.edge.DirectMethodRequest

public class DirectMethodRequest
extends java.lang.Object

Json parser for a method request. Used to invoke methods on other devices/modules

Constructor Summary

Constructors

Constructor and Description
DirectMethodRequest(java.lang.String methodName, java.lang.Object payload) Constructor for a DirectMethodRequest.
DirectMethodRequest(java.lang.String methodName, java.lang.Object payload, java.lang.Integer responseTimeout, java.lang.Integer connectionTimeout) Constructor for a DirectMethodRequest.

Method Summary

Modifier and Type	Method and Description
java.lang.String	toJson() Return the json representation of this object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DirectMethodRequest

public DirectMethodRequest(java.lang.String methodName,
                           java.lang.Object payload)
                    throws java.lang.IllegalArgumentException

Constructor for a DirectMethodRequest. Uses default responseTimeout and connectionTimeout which is to never timeout

Parameters:

methodName - the method to be invoked

payload - the payload attached to that method. This parameter can be Null: the DirectMethodRequest object will not include the "payload" field Primitive type (e.g., String, Int)/Array/List/Map/custom type: will be serialized as value of the "payload" field using GSON.

Throws:

java.lang.IllegalArgumentException - if the provided methodName is null or empty

DirectMethodRequest

public DirectMethodRequest(java.lang.String methodName,
                           java.lang.Object payload,
                           java.lang.Integer responseTimeout,
                           java.lang.Integer connectionTimeout)
                    throws java.lang.IllegalArgumentException

Constructor for a DirectMethodRequest.

Parameters:

methodName - the method to be invoked

payload - the payload attached to that method. This parameter can be Null: the DirectMethodRequest object will not include the "payload" field Primitive type (e.g., String, Int)/Array/List/Map/custom type: will be serialized as value of the "payload" field using GSON.

responseTimeout - the timeout in seconds for the response to be received

connectionTimeout - the timeout in seconds for the connection to be established

Throws:

java.lang.IllegalArgumentException - if the provided methodName is null or empty

Method Detail

toJson

public java.lang.String toJson()

Return the json representation of this object

Returns:

the json representation of this object