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

Class DigitalTwinInvokeCommandRequestOptions

java.lang.Object

com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinInvokeCommandRequestOptions

public final class DigitalTwinInvokeCommandRequestOptions
extends Object

General request options that are applicable, but optional, for invoke command APIs.

Constructor Summary

Constructors

Constructor and Description
DigitalTwinInvokeCommandRequestOptions()

Method Summary

Modifier and Type	Method and Description
Integer	getConnectTimeoutInSeconds() Sets the time (in seconds) that the service waits for the device to come online.
Integer	getResponseTimeoutInSeconds() Gets the time (in seconds) that the service waits for the method invocation to return a response.
void	setConnectTimeoutInSeconds(Integer connectTimeoutInSeconds) Sets the time (in seconds) that the service waits for the device to come online.
void	setResponseTimeoutInSeconds(Integer responseTimeoutInSeconds) Sets the time (in seconds) that the service waits for the method invocation to return a response.

Methods inherited from class java.lang.Object

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

Constructor Detail

DigitalTwinInvokeCommandRequestOptions

public DigitalTwinInvokeCommandRequestOptions()

Method Detail

getConnectTimeoutInSeconds

public Integer getConnectTimeoutInSeconds()

Sets the time (in seconds) that the service waits for the device to come online.

Returns:

The number of seconds before connect timeouts occur for this request.

setConnectTimeoutInSeconds

public void setConnectTimeoutInSeconds(Integer connectTimeoutInSeconds)

Sets the time (in seconds) that the service waits for the device to come online. The default is 0 seconds (which means the device must already be online) and the maximum is 300 seconds.

Parameters:

connectTimeoutInSeconds - The number of seconds before connect timeouts occur for this request.

getResponseTimeoutInSeconds

public Integer getResponseTimeoutInSeconds()

Gets the time (in seconds) that the service waits for the method invocation to return a response.

Returns:

The number of seconds before resposne timeouts occur for this request.

setResponseTimeoutInSeconds

public void setResponseTimeoutInSeconds(Integer responseTimeoutInSeconds)

Sets the time (in seconds) that the service waits for the method invocation to return a response. The default is 30 seconds, minimum is 5 seconds, and maximum is 300 seconds.

Parameters:

responseTimeoutInSeconds - The number of seconds before response timeouts occur for this request.