com.microsoft.azure.sdk.iot.device.net

Class IotHubCompleteUri

java.lang.Object

com.microsoft.azure.sdk.iot.device.net.IotHubCompleteUri

public final class IotHubCompleteUri
extends Object

A URI for a device to instruct an IoT Hub to mark a message as being completed.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPLETE_PATH_FORMAT The path to be appended to an IoT Hub URI.
protected IotHubUri	uri The underlying IoT Hub URI.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IotHubCompleteUri()
	IotHubCompleteUri(String iotHubHostname, String deviceId, String eTag) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getHostname() Returns the string representation of the IoT Hub hostname.
String	getPath() Returns the string representation of the IoT Hub path.
String	toString() Returns the string representation of the IoT Hub complete message URI.

Methods inherited from class java.lang.Object

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

Field Detail

COMPLETE_PATH_FORMAT

public static final String COMPLETE_PATH_FORMAT

The path to be appended to an IoT Hub URI. The %s will be replaced by the message etag.

See Also:

Constant Field Values

uri

protected final IotHubUri uri

The underlying IoT Hub URI.

Constructor Detail

IotHubCompleteUri

public IotHubCompleteUri(String iotHubHostname,
                         String deviceId,
                         String eTag)

Constructor. Returns a URI for a device to instruct an IoT Hub to mark a message as being completed. The URI does not include a protocol.

Parameters:

iotHubHostname - the IoT Hub name.

deviceId - the device ID.

eTag - the message e-tag.

IotHubCompleteUri

protected IotHubCompleteUri()

Method Detail

toString

public String toString()

Returns the string representation of the IoT Hub complete message URI.

Overrides:

toString in class Object

Returns:

the string representation of the IoT Hub complete message URI.

getHostname

public String getHostname()

Returns the string representation of the IoT Hub hostname.

Returns:

the string representation of the IoT Hub hostname.

getPath

public String getPath()

Returns the string representation of the IoT Hub path.

Returns:

the string representation of the IoT Hub path.